PowerTCP Mail for .NET
Get(ICollection,ImapMessageSections) Method
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > Mailbox Class > Get Method : Get(ICollection,ImapMessageSections) Method




messages
A collection of ImapMessage objects specifying the messages to get.
sections
An ImapMessageSections value specifying the portion of the message to get.
Retrieves a specified portion of the messages contained in the collection messages.

Syntax

Visual Basic (Declaration) 
Public Overloads Function Get( _
   ByVal messages As ICollection, _
   ByVal sections As ImapMessageSections _
) As ImapMessage()
Visual Basic (Usage)Copy Code
Dim instance As Mailbox
Dim messages As ICollection
Dim sections As ImapMessageSections
Dim value() As ImapMessage
 
value = instance.Get(messages, sections)
Managed Extensions for C++ 
public: ImapMessage*[]* Get( 
   ICollection* messages,
   ImapMessageSections sections
) 

Parameters

messages
A collection of ImapMessage objects specifying the messages to get.
sections
An ImapMessageSections value specifying the portion of the message to get.

Return Value

An array of ImapMessage objects, representing all messages retrieved.

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.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.Get method retrieves some portion of all of the messages contained in messages and uses the data to populate that collection and its contents. All of the ImapMessage objects contained in messages must be located in the mailbox. This method uses the IMAP FETCH command to retrieve message content. The command uses the UIDs of the messages in the collection to retrieve content.

This method is useful for bulk operations. If you would like to retrieve only a single message, use the ImapMessage.Get 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.