OnStatusChange Event

<< Click to Display Table of Contents >>

Navigation:  Reference > SmtpMail >

OnStatusChange Event

 

OnStatusChange event is fired on every status change for the message that was queued for sending using SendAsync method.

 

Syntax

 

[Visual Basic]


Sub OnStatusChange(numMessageNumber As Long, numNewStatus As Long)

 

[C#]


void OnStatusChange(int numMessageNumber, int numNewStatus);

 

[C++]


void __cdecl OnStatusChange(LONG numMessageNumber, LONG numNewStatus );

 

 

Parameters

 

numMessageNumber [in]

Message number returned from the SendAsync method.

 

numNewStatus [in]

New status of the message, one of the values from the MailStatus enumeration.

 

Return value

 

None.

 

Remarks

 

SendAsync method places a message into a message queue and returns message number which identifies the message. OnStatusChange event is used to notify application about changes to the message status. Initially message status is MailStatusQueued. When AddEmail starts sending the message its status changes to MailStatusSending. When the message is sent successfully status changes to MailStatusSent. Status becomes MailStatusFailed if AddEmail was unable to send the message. If the message was canceled using Cancel or CancelAll method its status becomes MailStatusCanceled.