GetStatus Method
Previous  Top  Next


GetStatus
method obtains status of a message that was queued for sending using SendAsync method.

Syntax

[Visual Basic]


Function
 GetStatus(numMessageNumber As LongAs AddEmailLib.MailStatus

Example:

Dim
 messageStatus As AddEmailLib.MailStatus
messageStatus = objSmtpMail.GetStatus(numMessageNumber)

[VBScript]


Function
 GetStatus(numMessageNumber)

Example:

Dim
 messageStatus
messageStatus = objSmtpMail.GetStatus(numMessageNumber)

[C#]


AddEmailLib.MailStatus GetStatus(int
 numMessageNumber);

Example:

AddEmailLib.MailStatus messageStatus = objSmtpMail.GetStatus(numMessageNumber);

[C++]


HRESULT GetStatus(LONG numMessageNumber, MailStatus* pmessageStatus);

Example:

AddEmailLib::MailStatus messageStatus = spSmtpMail->GetStatus(numMessageNumber);


Parameters

numMessageNumber [in]
Message number returned from the SendAsync method.

Return value

Returns status of the e-mail message. Message status values are defined in MailStatus enumeration.

Remarks

SendAsync method places a message into a message queue and returns message number which identifies the message. Use GetStatus method to obtain information about a status of the message.