Page Comparison

...

Gets a specific

...

message from the POP3 server.

...

Files

...

...

pop3-c.h/pop3-c.c

...

Prototype
...
1049928 CPU_INT32U msg_nbr, CPU_CHAR *dest_buf, CPU_INT32U buf_size, CPU_BOOLEAN del_msg, NET_ERR *perr);
 HTML Table
class
Code_Listing
 Table Row (tr)
 Table Cell (td)
rowspan
5
 Anchor
1049928
 Code Block
void  POP3c_MsgRetrieve (NET_SOCK_ID
 sock,
 Anchor
1049929
1049929
 Anchor
1049930
1049930
 Anchor
1049931
1049931
 Anchor
1049932
1049932
 Anchor
1049933
1049933
 Table Row (tr)
 Table Row (tr)
 Table Row (tr)
 Table Row (tr)
...
   sock,
                         CPU_INT32U    msg_nbr,
                         CPU_CHAR     *dest_buf,
                         CPU_INT32U    buf_size,
                         CPU_BOOLEAN   del_msg,
                         NET_ERR      *perr);
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:
...
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 Sample Application.