Simple Mail Transfer Vuser Functions (SMTP) > Alphabetical List of Functions > smtp_abort_mail_ex

smtp_abort_mail_ex

Example: smtp_abort_mail_ex Simple Mail Transfer Vuser Functions (SMTP)

Cancels a mail transaction for a session.

int smtp_abort_mail_ex( SMTP *ppsmtp );
ppsmtp A session identifier.

smtp_abort_mail_ex cancels the current mail transaction for a specific session. Any stored sender, recipients, and mail data is discarded. All buffers and state tables cleared.

This function is for use with multiple sessions. For global sessions, use the smtp_abort_mail function, which leaves out the session identifier.

Return Values

If this function succeeds, it returns LR_PASS. Otherwise, it returns LR_FAIL.

Parameterization

Standard parameterization is not available for this function.