...
Gets a specific essage from the POP3 server.
...
Files
...
...
pop3-c.h/pop3-c.c...
Prototype
...
| class | Code_Listing |
|---|
...
| rowspan | 5 |
|---|
...
Arguments
...
...
sock Socket ID returned by POP3c_Connect().
...
msg_nbr Index of message of interest.
...
dest_buf Pointer to allocated buffer used to copy the message.
...
buf_size Size of dest_buf.
...
...
del_msg Indicate if the message should be deleted from the server.
...
perr Pointer to a variable that will hold the return error code from this function:
...
POP3c_ERR_NONE...
POP3c_ERR_DEST_BUF_TOO_SMALL...
...
POP3c_ERR_NEG_RESP...
...
POP3c_ERR_RX_FAILED...
Returned Values
...
...
None.
...
Required Configuration
...
...
None.
...
Notes / Warnings
...
The msg_nbr argument starts at the value ‘1’. Message ‘0’ does not exist.
...
The client software is responsible for providing a large enough buffer in order to contain the whole message. Failure to do so might lead to runtime problems. If the buffer passed is too small for a given message, only the first buf_size - 1 bytes will be copied, followed by a ‘\
...
0’. See POP3c_RespServerMulti() for more information.
...
...
Example Usage
...
See section 3-3 “µC/POP3c Example Code”
...
.