POP3c_MboxStat()

Get the number of messages in the mailbox, as well as its total size.

Files

pop3-c.h/pop3-c.c

Prototype

void  POP3c_MboxStat (NET_SOCK_ID   sock,
                      CPU_INT32U   *msg_qty,
                      CPU_INT32U   *mbox_size,
                      NET_ERR      *perr);

Arguments

sock

Socket ID returned by POP3c_Connect().

msg_qty

Number of messages on the server for this account.

mbox_size

Size of this mailbox (in bytes).

perr

Pointer to a variable that will hold the return error code from this function:

Returned Values

None.

Required Configuration

None.

Notes / Warnings

• If successful, the response for this command is in the format: “+OK nn mm” where “nn” correspond to the number of messages and “mm” is the total size of the maildrop in octets.
• The values returned via the pointers (number of messages and mailbox size) does not include message set for deletion, as stated in RFC #1939, Section ‘The TRANSACTION State : STAT Command’, “Note that messages marked as deleted are note counted in either total”.

Example Usage

See Sample Application.