PowerTCP Mail for .NET
Mailbox Event
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > Imap Class : Mailbox Event




Raised when information about a mailbox is received while performing a listing.

Syntax

Visual Basic (Declaration) 
<CategoryAttribute("Progress")>
Public Event Mailbox As MailboxEventHandler
Visual Basic (Usage)Copy Code
Dim instance As Imap
Dim handler As MailboxEventHandler
 
AddHandler instance.Mailbox, handler
C# 
[CategoryAttribute("Progress")]
public event MailboxEventHandler Mailbox
Managed Extensions for C++ 
[CategoryAttribute("Progress")]
public: __event MailboxEventHandler* Mailbox
C++/CLI 
[CategoryAttribute("Progress")]
public:
event MailboxEventHandler^ Mailbox

Event Data

The event handler receives an argument of type MailboxEventArgs containing data related to this event. The following MailboxEventArgs properties provide information specific to this event.

PropertyDescription
Exception (Inherited from Dart.PowerTCP.Mail.EndEventArgs) Gets any exception which occurred during the asynchronous operation.
Mailbox Gets the Mailbox object representing the IMAP mailbox for which the event was raised.
Mailboxes Gets an array of Mailbox objects representing all mailboxes effected by the operation.
State (Inherited from Dart.PowerTCP.Mail.EndEventArgs) Gets the object that was included as part of the associated method call.

Remarks

The Imap.List method requests a listing from the server (this also occurs immediately after using Imap.Login if Imap.AutoList is true). This method causes the server to return a listing. Whenever mailbox information is retrieved while getting the listing, the Imap.Mailbox event is raised. A MailboxEventArgs object which encapsulates the mailbox is passed into the event handler.

For more information on using PowerTCP events, see the topic Using Events In PowerTCP.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

Documentation Version 3.2
© 2010 Dart Communications. All Rights Reserved.