This structure contains information about a selected mailbox.

typedef struct _IMAPMAILBOX
{ 
    UINT    nMessages;
    UINT    nRecentMessages;
    UINT    nUnseenMessageId;
    DWORD   dwMailboxUID;
    DWORD   dwNextMessageUID;
    DWORD   dwFlags;
    DWORD   dwPermanentFlags;
    DWORD   dwAccessMode;
    DWORD   dwReserved1;
    DWORD   dwReserved2;
} IMAPMAILBOX, *LPIMAPMAILBOX;

Members

nMessages

A value specifies the total number of messages in the mailbox.

nRecentMessages

A value which specifies the number of new messages that have recently arrived in the mailbox.

nUnseenMessageId

A value which specifies the message ID of the first unseen message in the mailbox.

dwMailboxUID

A value which specifies a unique identifier for this mailbox which corresponds to the UIDVALIDITY value returned by the IMAP server. The actual value is determined by the server and should be considered opaque. The protocol specification requires that a mailbox's UID must not change unless the mailbox contents are modified or existing messages in the mailbox have been assigned new UIDs.

dwNextMessageUID

A value which specifies the predicted unique identifier that will be assigned to a new message in the mailbox. This corresponds to the UIDNEXT value returned by the IMAP server. The protocol specification requires that as long as the mailbox UID is unchanged, messages that are added to the mailbox will be assigned a UID greater than or equal to the next UID value.

dwFlags

A value which specifies one or more mailbox flags. One or more of the following values may be specified:

Value	Description
IMAP_FLAG_NOINFERIORS	The mailbox does not contain any child mailboxes. In the IMAP protocol, these are referred to as inferior hierarchical mailbox names.
IMAP_FLAG_NOSELECT	The mailbox cannot be selected or examined. This flag is typically used by servers to indicate that the mailbox name refers to a directory on the server, not a mailbox file.
IMAP_FLAG_MARKED	The mailbox is marked as being of interest to a client. If this flag is used, it typically means that the mailbox contains messages. An application should not depend on this flag being present for any given mailbox. Some IMAP servers do not support marked or unmarked flags for mailboxes.
IMAP_FLAG_UNMARKED	The mailbox is marked as not being of interest to a client. If this flag is used, it typically means that the mailbox does not contain any messages. An application should not depend on this flag being present for any given mailbox. Some IMAP servers do not support marked or unmarked flags for mailboxes.

dwPermanentFlags

A value which specifies the message flags that a client can change permanently. If this value is zero, then no permanent flags are defined for the mailbox and the client may assume that all message flags may be set permanently. Otherwise, one or more of the following values may be specified:

Value	Description
IMAP_FLAG_ANSWERED	The message has been answered.
IMAP_FLAG_DRAFT	The message has not been completed and is marked as a draft copy.
IMAP_FLAG_URGENT	The message has been flagged for urgent or special attention.
IMAP_FLAG_SEEN	The message has been read.

dwAccessMode

A value which specifies the access mode for the mailbox. It may be one of the following values:

Value	Description
IMAP_ACCESS_READONLY	The mailbox has been selected in read-only mode. Messages may not be created in the mailbox, nor can message flags be modified.
IMAP_ACCESS_READWRITE	The mailbox has been selected in read-write mode. Messages may be modified by the client, and messages marked for deletion can be expunged.

dwReserved1

A reserved value that is undefined.

dwReserved2

A reserved value that is undefined.

Requirements

Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools11.h
Import Library: csmapv11.lib

Copyright © 2025 Catalyst Development Corporation. All rights reserved.