PowerTCP Mail for .NET
BeginGet(Object) Method
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > Mailbox Class > BeginGet Method : BeginGet(Object) Method




state
User state information.
Begins to asynchronously retrieve all of the messages contained in the mailbox.

Syntax

Visual Basic (Declaration) 
Public Overloads Function BeginGet( _
   ByVal state As Object _
) As IAsyncResult
Visual Basic (Usage)Copy Code
Dim instance As Mailbox
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

ExceptionDescription
Dart.PowerTCP.Mail.ProtocolExceptionBad IMAP protocol response received from server.
System.Net.Sockets.SocketExceptionThe requested address is not valid in its context.
System.InvalidOperationExceptionBeginXXX method used without providing an EndXXX event handler.
System.ArgumentOutOfRangeExceptionindex was out of range
System.IndexOutOfRangeExceptionindex was outside bounds of array
Dart.PowerTCP.Mail.InvalidParameterTypeExceptionCollection contains instances of wrong type of object

Remarks

The Mailbox.BeginGet method retrieves in full the messages contained in this mailbox and uses the data to populate the Mailbox.Messages collection and its contents. Upon completion of this operation the Imap.EndGetMessage event is raised

This method uses the IMAP FETCH command to retrieve message content. The command uses the UIDs of the messages (ImapMessage.Uid) to retrieve content.

This method is useful for bulk operations. If you would like to retrieve only a single message, use the ImapMessage.BeginGet method of the ImapMessage object.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

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