tfPop3UserExecute

Table of Contents >> Optional Protocols >> POP3

#include <trsocket.h>

int tfPop3UserExecute	(
	ttPop3ClientHandle pop3Handle,
	int messageNumber,
	char * buffer,
	int bufferLen,
	int * errorCodePtr
	);

Function Description

This function executes the POP3 client main loop. This call is valid only if the POP3 session is operating in non-blocking mode.

Parameters

• pop3Handle

  The POP3 session handle.

Returns

• TM_ENOERROR

  Success.

• TM_EINVAL

  The 'pop3Handle' is invalid.

• TM_EPERM

  Blocking is currently on; this function should only be called when blocking is disabled.

• TM_ENOTCONN

  The POP3 session is not currently connected.

• TM_ETIMEDOUT

  The POP3 session has timed out and the POP3 client has been disconnected.

• TM_ESHUTDOWN

  There was a socket error and the POP3 client has been disconnected.

• TM_EACCESS

  A previous call to tfPop3GetMessage() is currently in progress. The user should continue calling tfPop3GetMessage() until it returns TM_ENOERROR.

• TM_EINPROGRESS

  The POP3 client is still executing.

• TM_POP3_ERROR_TIMEOUT

  A time-out has been received.

• TM_POP3_ERROR_USERNAME

  An ERR reply was received for the username request.

• TM_POP3_ERROR_PASSWORD

  An ERR reply was received for the password request.

• TM_POP3_ERROR_CONNECT

  There was an error during tfPop3UserConnect().

• TM_POP3_ERROR_RECV

  There was an error when receiving data on the POP3 client socket.

• TM_POP3_ERROR_STAT

  An ERR reply was received for the STAT request.

• TM_POP3_ERROR_LIST

  An ERR reply was received for the LIST request.

Table of Contents >> Optional Protocols >> POP3