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

Types

MailAccount

object
folders
(array of MailFolder)
The folders for this account.
id
(string)
A unique identifier for this account.
name
(string)
The human-friendly name of this account.
type
(string)
What sort of account this is, e.g. imap, nntp, or pop3.