Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Function BeginExamine( _ ByVal mailboxName As String, _ ByVal state As Object _ ) As IAsyncResult | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As Imap Dim mailboxName As String Dim state As Object Dim value As IAsyncResult value = instance.BeginExamine(mailboxName, state) | |
| C# | |
|---|---|
public IAsyncResult BeginExamine( string mailboxName, object state ) | |
| Managed Extensions for C++ | |
|---|---|
public: IAsyncResult* BeginExamine( string* mailboxName, Object* state ) | |
| C++/CLI | |
|---|---|
public: IAsyncResult^ BeginExamine( String^ mailboxName, Object^ state ) | |
Parameters
- mailboxName
- The name of the mailbox to open.
- state
- User state information.
Return Value
An IAsyncResult that represents the asynchronous operation, which could still be pending.Exceptions
| Exception | Description |
|---|---|
| Dart.PowerTCP.Mail.ProtocolException | Bad IMAP protocol response received from server. |
| System.Net.Sockets.SocketException | The requested address is not valid in its context. |
| System.InvalidOperationException | BeginXXX method used without providing an EndXXX event handler. |
Remarks
The Imap.BeginExamine method selects a mailbox by issuing the EXAMINE command to the server, setting the current mailbox to the mailbox specified by mailboxName. Upon completion of this operation, the Imap.EndExamine event is raised. If successful, the Imap.CurrentMailbox is set to an instance of a Mailbox object. This method opens the mailbox for reading only (Mailbox.Readonly = true).
Requirements
Target Platforms: Microsoft .NET Framework 2.0