Retrieves the mail message with the specified unique identifier (UID).

Namespace: S22.Imap
Assembly: S22.Imap (in S22.Imap.dll) Version: 3.6.0.0 (3.6.0.0)

Syntax

C#
MailMessage GetMessage(
	uint uid,
	bool seen = true,
	string mailbox = null
)

Parameters

uid
Type: System..::..UInt32
The unique identifier of the mail message to retrieve.
seen (Optional)
Type: System..::..Boolean
Set this to true to set the \Seen flag for this message on the server.
mailbox (Optional)
Type: System..::..String
The mailbox the message will be retrieved from. If this parameter is omitted, the value of the DefaultMailbox property is used to determine the mailbox to operate on.

Return Value

An initialized instance of the MailMessage class representing the fetched mail message.

Remarks

A unique identifier (UID) is a 32-bit value assigned to each message which uniquely identifies the message within the respective mailbox. No two messages in a mailbox share the same UID.

Examples

CopyC#
ImapClient Client = new ImapClient("imap.gmail.com", 993, "My_UsernamMe",
    "My_Password", true, AuthMethod.Login);

// Find all messages in the mailbox that were sent from "John.Doe@gmail.com".
IEnumerable<uint> uids = Client.Search( SearchCondition.From("John.Doe@gmail.com") );

// Fetch the first message and print it's subject and body.
if(uids.Count() > 0) {
    MailMessage msg = Client.GetMessage(uids.First());

    Console.WriteLine("Subject: " + msg.Subject);
    Console.WriteLine("Body: " + msg.Body);
}

Client.Dispose();

Exceptions

ExceptionCondition
S22.Imap..::..BadServerResponseExceptionThe mail message could not be fetched. The message property of the exception contains the error message returned by the server.
System..::..ObjectDisposedExceptionThe ImapClient object has been disposed.
System.IO..::..IOExceptionThere was a failure writing to or reading from the network.
S22.Imap..::..NotAuthenticatedExceptionThe method was called in non-authenticated state, i.e. before logging in.

See Also