WebPopShutdown Function

Action

Shuts down the connection to the POP3 server. First use WebPopQuit to commit the changes on the server.

Include file

WebAPI.bdh

Syntax

WebPopShutdown( inout hPop  : number, 
                in    nMode : number optional ): boolean;

Return value

true if the response was successfully received and the server confirmed with "+OK"
false otherwise

Parameter	Description
hPop	Handle to a Web connection that was created by WebPopConnect
nMode	Determines the shutdown mode (optional). Any of the following options is possible: WEB_SHUTDOWN_GRACEFUL. Initiates a graceful shutdown: first closes and then resets the connection WEB_SHUTDOWN_IMMEDIATE. Initiates a standard connection close (default) WEB_SHUTDOWN_RESET. Resets the connection

Parameter

Description

hPop

Handle to a Web connection that was created by WebPopConnect

nMode

Determines the shutdown mode (optional). Any of the following options is possible:

WEB_SHUTDOWN_GRACEFUL. Initiates a graceful shutdown: first closes and then resets the connection
WEB_SHUTDOWN_IMMEDIATE. Initiates a standard connection close (default)
WEB_SHUTDOWN_RESET. Resets the connection

Example

dcltrans 
  transaction TWebPop3 
  var
   hPop: number; 
  begin
    WebPopConnect(hPop, "standardhost", WEB_PORT_POP3); 
    WebPopShutdown(hPop); 
  end TWebPop3;

Sample scripts

WebMulti01.bdf, WebSecure01.bdf

SilkEssential sample

eMail.sep