accounts

The accounts API first appeared in Thunderbird 66 (see bug 1488176).

Permissions

accountsRead

See your mail accounts and their folders

Note

The permission accountsRead is required to use accounts.

Functions

list()

Returns all mail accounts.

Return type (Promise)

array of MailAccount

Required permissions

  • accountsRead

get(accountId)

Returns details of the requested account, or null if it doesn’t exist.

Parameters

accountId

(string)

Return type (Promise)

Required permissions

  • accountsRead

getDefault()

– [Added in TB 85, backported to TB 78.7.0]

Returns the default account, or null if it is not defined.

Required permissions

  • accountsRead

setDefaultIdentity(accountId, identityId)

– [Added in TB 76]

Sets the default identity for an account.

Parameters

accountId

(string)

identityId

(string)

Required permissions

  • accountsRead

getDefaultIdentity(accountId)

– [Added in TB 85, backported to TB 78.7.0]

Returns the default identity for an account, or null if it is not defined.

Parameters

accountId

(string)

Required permissions

  • accountsRead

Types

MailAccount

object

folders

(array of MailFolder)

The folders for this account.

id

(string)

A unique identifier for this account.

identities

(array of MailIdentity)

– [Added in TB 76]

The identities associated with this account. The default identity is listed first, others in no particular order.

name

(string)

The human-friendly name of this account.

type

(string)

What sort of account this is, e.g. imap, nntp, or pop3.

MailIdentity

– [Added in TB 76]

object

accountId

(string)

The id of the MailAccount this identity belongs to.

composeHtml

(boolean)

– [Added in TB 85, backported to TB 78.7.0]

Wether the identity uses HTML as the default compose format.

email

(string)

The user’s email address as used when messages are sent from this identity.

id

(string)

A unique identifier for this identity.

label

(string)

A user-defined label for this identity.

name

(string)

The user’s name as used when messages are sent from this identity.

organization

(string)

The organization associated with this identity.

replyTo

(string)

The reply-to email address associated with this identity.