Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Overloads Function BeginGet( _ ByVal state As Object _ ) As IAsyncResult | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As ImapMessage Dim state As Object Dim value As IAsyncResult value = instance.BeginGet(state) | |
| C# | |
|---|---|
public IAsyncResult BeginGet( object state ) | |
| Managed Extensions for C++ | |
|---|---|
public: IAsyncResult* BeginGet( Object* state ) | |
| C++/CLI | |
|---|---|
public: IAsyncResult^ BeginGet( Object^ state ) | |
Parameters
- state
- User state information.
Return Value
An IAsyncResult that represents the asynchronous operation, which could still be pending.Exceptions
| Exception | Description |
|---|---|
| System.InvalidOperationException | BeginXXX method used without providing an EndXXX event handler. |
| Dart.PowerTCP.Mail.ProtocolException | Bad IMAP protocol response received from server. |
| System.Net.Sockets.SocketException | The requested address is not valid in its context. |
Remarks
The ImapMessage.BeginGet method begins to asynchronously get the full message, including flags, internal date, and UID. Upon completion, the Imap.EndGet event is raised. The message itself is represented by a MessageStream object and accessible as ImapMessage.Message.
For bulk operations, use Mailbox.BeginGet which gets all messages in a mailbox.
Requirements
Target Platforms: Microsoft .NET Framework 2.0