PowerTCP Mail for .NET
Get(Stream) Method
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > ImapMessage Class > Get Method : Get(Stream) Method




message
The Stream to use to contain the message data.
Gets the entire message into a user-defined stream.

Syntax

Visual Basic (Declaration) 
Public Overloads Function Get( _
   ByVal message As Stream _
) As ImapMessage
Visual Basic (Usage)Copy Code
Dim instance As ImapMessage
Dim message As Stream
Dim value As ImapMessage
 
value = instance.Get(message)
C# 
public ImapMessage Get( 
   Stream message
)
Managed Extensions for C++ 
public: ImapMessage* Get( 
   Stream* message
) 
C++/CLI 
public:
ImapMessage^ Get( 
   Stream^ message
) 

Parameters

message
The Stream to use to contain the message data.

Return Value

An ImapMessage object representing the retrieved message.

Exceptions

ExceptionDescription
Dart.PowerTCP.Mail.ProtocolExceptionBad IMAP protocol response received from server.
System.Net.Sockets.SocketExceptionThe requested address is not valid in its context.

Remarks

The ImapMessage.Get method gets the full message, including flags, internal date, and UID. The Stream parameter is used as the internal Stream representation of the message. If the parameter is null, a new MessageStream object will be created and used as the internal Stream.

The stream passed in is accessible as ImapMessage.Stream.

For bulk operations, use Mailbox.Get which gets all messages in a mailbox.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

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