Reference > SmtpMail > Cancel Method

Cancel method cancels sending of a message that was queued for sending using SendAsync method.

Syntax

[Visual Basic]

Sub Cancel(numMessageNumber As Long)

Example:

objSmtpMail.Cancel numMessageNumber

[VBScript]

Sub Cancel(numMessageNumber)

Example:

objSmtpMail.Cancel numMessageNumber

[C#]

void Cancel(int numMessageNumber);

Example:

objSmtpMail.Cancel(numMessageNumber);

[C++]

HRESULT Cancel(LONG numMessageNumber);

Example:

spSmtpMail->Cancel(numMessageNumber);

Parameters

numMessageNumber [in]

Message number returned from the SendAsync method.

Return value

None.

Remarks

SendAsync method places a message into a message queue and returns message number which identifies the message. Use Cancel method to cancel sending of the message. Only messages that have status MailStatusQueued or MailStatusSending can be canceled. If the message is currently transferred and its status is MailStatusSending, Cancel method doesn't cause the transfer to stop immediately. Message is marked for cancellation and will be canceled some time later. The message is actually canceled when its status changes to MailStatusCanceled.