tfPop3NewSession
Table of Contents >> Optional Protocols >> POP3
#include <trsocket.h> |
ttPop3ClientHandle tfPop3NewSession | ( |
ttPop3CBFuncPtr pop3UserCBFuncPtr, | |
int timeout, | |
int maxLoginLength, | |
int blockingMode, | |
ttUser8Bit options | |
); |
Function Description
This function opens a new POP3 session and returns the handle to the user, or NULL if an error occurs.
Parameters
- pop3UserCBFuncPtr
- A pointer to the user callback function. This may be NULL.
- timeout
- The amount of time (in seconds) for the POP3 client to wait for a reply.
- maxLoginLength
- The maximum length of the username and password combined. This value includes the null terminator.
- blockingMode
- One of the following:
- TM_BLOCKING_ON: for blocking mode.
- TM_BLOCKING_OFF: for non-blocking mode.
- options
- TM_POP3_OPTION_USEAPOP if using APOP.
Returns
- (ttPop3ClientHandle)0
- Failure.
- (Other)
- Success.