tfPop3GetMessage
Table of Contents >> Optional Protocols >> POP3
| #include <trsocket.h> |
| int tfPop3GetMessage | ( |
| ttPop3ClientHandle pop3Handle, | |
| int messageNumber, | |
| char * buffer, | |
| int bufferLen, | |
| int * errorCodePtr | |
| ); |
Function Description
This function is used to retrieve a message.
Parameters
- pop3Handle
- The POP3 session handle.
- messageNumber
- The message number of the message to retrieve.
- buffer
- The buffer to store the message in.
- bufferLen
- The length of the buffer to store the message in.
- errorCodePtr
- A pointer to store the error code to.
Returns
- TM_ENOERROR
- Success; there is no more data to receive.
- >0
- The number of bytes received; there is more data to receive.
- TM_EINVAL
- One of the parameters is invalid.
- <0
- If 'errorCodePtr' is set to TM_ENOERROR, no data has been received yet. If 'errorCodePtr' is not set to TM_ENOERROR, this call failed.