Mailboxes¶

Manage email mailboxes.

Mailbox¶

Name¶

User-visible name for the mailbox (e.g. "Inbox"). Must be unique among siblings sharing the same parent.

Text. Name in the API: name.

Parent Mailbox¶

Identifier of the parent mailbox, or null if this is a top-level mailbox.

One of your Mailboxes, chosen from a list. Name in the API: parentId.

Special Use¶

Special-use role identifying the mailbox's purpose (inbox, sent, trash, etc.). A role may only be assigned to one mailbox per account.

One of: Inbox (inbox), Trash (trash), Junk (junk), Drafts (drafts), Archive (archive), Sent (sent), Shared Folders (shared), Important (important), Memos (memos), Scheduled (scheduled), Snoozed (snoozed). Name in the API: role.

Sort Order¶

Display order among siblings (lower values first). Mailboxes with equal order sort alphabetically by name.

A number. Default: 0. Name in the API: sortOrder.

Subscribed¶

Whether the user has subscribed to see this mailbox in their client.

On or off. Default: On. Name in the API: isSubscribed.

Counters¶

Total Emails¶

Total number of emails in this mailbox.

A number. Read only. Name in the API: totalEmails.

Unread Emails¶

Number of emails in this mailbox without the $seen or $draft keyword.

A number. Read only. Name in the API: unreadEmails.

Total Threads¶

Number of threads with at least one email in this mailbox.

A number. Read only. Name in the API: totalThreads.

Unread Threads¶

Number of threads in this mailbox that contain unread emails.

A number. Read only. Name in the API: unreadThreads.

Shared With¶

Share this mailbox with other accounts, and specify the access rights they have on it.

A set of entries, each a key and its value. Name in the API: shareWith.

My Rights¶

Access rights the current user has on this mailbox.

Settings of their own: see Mailbox rights. Read only. Name in the API: myRights.