SocketTools .NET Edition

ImapClient.ExamineMailbox Method 

Selects the specified mailbox for read-only access.

[Visual Basic]
Public Function ExamineMailbox( _
   ByVal mailboxName As String _
) As Boolean
[C#]
public bool ExamineMailbox(
   string mailboxName
);

Parameters

mailboxName
A string that specifies the name of the mailbox to be examined.

Return Value

This method returns a boolean value. If the method succeeds, the return value is true. If the method fails, the return value is false. To get extended error information, check the value of the LastError property.

Remarks

The ExamineMailbox method is used to select a mailbox in read-only mode. Messages can be read, but they cannot be modified or deleted from the mailbox and new messages will not lose their status as new messages if they are accessed.

If the client has a different mailbox currently selected, that mailbox will be closed and any messages marked for deletion will be expunged. To prevent deleted messages from being removed from the previous mailbox, use the UnselectMailbox method prior to examining the new mailbox.

The special case-insensitive mailbox name INBOX is used for new messages. Other mailbox names may or may not be case-sensitive depending on the IMAP server's operating system and implementation.

To access a mailbox in read-write mode, use the SelectMailbox method.

See Also

ImapClient Class | SocketTools Namespace