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

smtp_abort_mail

Example: smtp_abort_mail Simple Mail Transfer Vuser Functions (SMTP)

Cancels a mail transaction.

int smtp_abort_mail();

smtp_abort_mail cancels the current mail transaction. Any stored sender, recipients, and mail data is discarded. All buffers and state tables cleared.

This function is for use with global sessions. For multiple sessions, use the smtp_abort_mail_ex function, which allows you to specify a 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.