tfPop3UserDisconnect

Table of Contents >> Optional Protocols >> POP3

#include <trsocket.h>

int tfPop3UserDisconnect

(ttPop3ClientHandle pop3Handle);

Function Description

This function is called when the user wants to disconnect a previously connected connection with the POP3 server. The 'pop3Handle' handle buffer will remain allocated, but the cache for message length list and username/password buffer will be freed, and the socket will be closed. The user does not need to call tfPop3UserExecute() after tfPop3UserDisconnect().

Parameters

• pop3Handle

  The POP3 session handle.

Returns

• TM_ENOERROR

  Success

• TM_SOCKET_ERROR

  Failure

Note:

TM_SOCKET_ERROR means that this socket call has failed and the errorCode has been set on the socket itself. To retrieve the socket error the user must call tfGetSocketError(socketDescriptor).

Possible socket errors

• TM_EINVAL

  The 'pop3Handle' is invalid.

Table of Contents >> Optional Protocols >> POP3