PowerTCP Mail for .NET
BeginRefresh Method
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > MailboxCollection Class : BeginRefresh Method




state
User state information.
Begins to asynchronously refresh the list of mailboxes represented by this collection.

Syntax

Visual Basic (Declaration) 
Public Function BeginRefresh( _
   ByVal state As Object _
) As IAsyncResult
Visual Basic (Usage)Copy Code
Dim instance As MailboxCollection
Dim state As Object
Dim value As IAsyncResult
 
value = instance.BeginRefresh(state)
C# 
public IAsyncResult BeginRefresh( 
   object state
)
Managed Extensions for C++ 
public: IAsyncResult* BeginRefresh( 
   Object* state
) 
C++/CLI 
public:
IAsyncResult^ BeginRefresh( 
   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.

Remarks

The MailboxCollection.BeginRefresh method begins to asynchronously refresh the list of mailboxes represented by this collection. This could be either the list of top-level mailboxes or a set of child mailboxes. Upon completion, the Imap.EndMailboxRefresh event will be raised.

If the contents of the MailboxCollection are modified by using the methods of the MailboxCollection the collection will be automatically refreshed. MailboxCollection.BeginRefresh would typically only be used to refresh the collection if two users are using the same mail account simultaneously.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

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