SMTPc_SetMbox()

Populates a SMTPc_MBOX structure with associated name and address.

Files

smtp-c.h/smtp-c.c

Prototype

void  SMTPc_SetMbox (SMTPc_MBOX  *p_mbox,
                     CPU_CHAR    *p_name,
                     CPU_CHAR    *p_addr,
                     SMTPc_ERR   *p_err);

Arguments

p_mbox

SMTPc_MBOX structure to be populated.

p_name

Name of the mailbox owner.

p_addr

Address associated with the mailbox.

p_err

Pointer to variable that will hold the return error code

Returned Values

none.

Required Configuration

Module Configuration.

Notes / Warnings

The name of the mailbox owner is not mandatory. Passing NULL will result in an empty string being copied in the structure.
SMTPc_MBOX can be used to define whether the sender (FROM) or the recipients (TO,CC and BCC).

Example Usage

none.