Syntax
| Visual Basic (Declaration) | |
|---|---|
<CategoryAttribute("Completion")> Public Event EndGetMessage As ImapMessageEventHandler | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As Imap Dim handler As ImapMessageEventHandler AddHandler instance.EndGetMessage, handler | |
| C# | |
|---|---|
[CategoryAttribute("Completion")] public event ImapMessageEventHandler EndGetMessage | |
| Managed Extensions for C++ | |
|---|---|
[CategoryAttribute("Completion")] public: __event ImapMessageEventHandler* EndGetMessage | |
| C++/CLI | |
|---|---|
[CategoryAttribute("Completion")] public: event ImapMessageEventHandler^ EndGetMessage | |
Event Data
The event handler receives an argument of type ImapMessageEventArgs containing data related to this event. The following ImapMessageEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| Exception (Inherited from Dart.PowerTCP.Mail.EndEventArgs) | Gets any exception which occurred during the asynchronous operation. |
| Message | Gets an ImapMessage object representing the message for which the event was raised. |
| Messages | Gets an array of ImapMessage objects representing all messages effected by the asynchronous method. |
| State (Inherited from Dart.PowerTCP.Mail.EndEventArgs) | Gets the object that was included as part of the associated method call. |
Remarks
This event is raised when any asynchronous operation which retrieves messages completes (ex. use of the Mailbox.BeginGet or ImapMessage.BeginGet methods). An ImapMessageEventArgs object is passed into the event handler, encapsulating the ImapMessage objects affected by this operation. If an exception occurred during the asynchronous operation, it would also be returned in the ImapMessageEventArgs object in the ImapMessageEventArgs.Exception property. If an exception is present, it will be thrown if you access any member of the ImapMessageEventArgs object.
Since this event can be raised by either Mailbox.BeginGet or ImapMessage.BeginGet, you may want to check the sender to determine which caused the event to be raised.
This event MUST be implemented if you are using any method which prompts the asynchronous retrieval of messages. See the topic Using EndXXX Events for more information.
For more information on using PowerTCP events, see the topic Using Events In PowerTCP.
Requirements
Target Platforms: Microsoft .NET Framework 2.0