Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Function GetOutline() As ImapMessage | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As ImapMessage Dim value As ImapMessage value = instance.GetOutline() | |
| C# | |
|---|---|
public ImapMessage GetOutline() | |
| Managed Extensions for C++ | |
|---|---|
public: ImapMessage* GetOutline(); | |
| C++/CLI | |
|---|---|
public: ImapMessage^ GetOutline(); | |
Return Value
An ImapMessage object representing the message.Exceptions
| Exception | Description |
|---|---|
| Dart.PowerTCP.Mail.ProtocolException | Bad IMAP protocol response received from server. |
| System.Net.Sockets.SocketException | The requested address is not valid in its context. |
Remarks
The ImapMessage.GetOutline method gets the overall outline of the message (ImapMessageSections.BodyStructure), and fills in an outline Message object, with parts containing no data. Different part objects are created based on the type and disposition of the definition returned by this command. In order to retrieve a single portion of this Message which has been created with empty parts, use the ImapMessage.GetPart or ImapMessage.BeginGetPart method, passing in as the part an object from the MessageStream.Parts collection.
Requirements
Target Platforms: Microsoft .NET Framework 2.0