Get(ImapMessage[],ImapMessageInfo) Method

Visual Basic (Declaration)
Visual Basic (Usage)
C#
Managed Extensions for C++
C++/CLI

Public Overloads Function Get( _
   ByVal messages() As ImapMessage, _
   ByVal sections As ImapMessageInfo _
) As ImapMessage()

Dim instance As Mailbox
Dim messages() As ImapMessage
Dim sections As ImapMessageInfo
Dim value() As ImapMessage
 
value = instance.Get(messages, sections)

public ImapMessage[] Get( 
   ImapMessage[] messages,
   ImapMessageInfo sections
)

public: ImapMessage*[]* Get( 
   ImapMessage*[]* messages,
   ImapMessageInfo sections
)

public:
array<ImapMessage^>^ Get( 
   array<ImapMessage^>^ messages,
   ImapMessageInfo sections
)

Parameters

messages: Subset of messages found in this MailBox.
sections: Message sections to update.

Return Value

Array of ImapMessage objects retrieved.

Exception	Description
ProtocolException	Bad IMAP protocol response received from server.

Retrieves a section of the specified messages. This method uses the IMAP FETCH command and UUIDs to retrieve message content. This method is useful for bulk operations. Use Get to retrieve a single message.

This example demonstrates retrieving the headers for all messages in the current mailbox.

C#

/// <summary>
/// Retrieves the headers for all messages in the current mailbox.
/// </summary>
/// <param name="myImap">A connected and authenticated Imap instance, that has a mailbox selected.</param>
public void GetMessageHeaders(Imap myImap)
{
    //Get headers for all messages in the box
    myImap.SelectedMailbox.Get(myImap.SelectedMailbox.ToArray(), ImapMessageInfo.Header);
}

Visual Basic

''' <summary>
''' Retrieves the headers for all messages in the current mailbox.
''' </summary>
''' <param name="myImap">A connected and authenticated Imap instance, that has a mailbox selected.</param>
Public Sub GetMessageHeaders(ByVal myImap As Imap)
    'Get headers for all messages in the box
    myImap.SelectedMailbox.Get(myImap.SelectedMailbox.ToArray(), ImapMessageInfo.Header)
End Sub

Reference

Mailbox Class
Mailbox Members
Overload List