WebExtension Documentation for Thunderbird 115
Manifest V2
115
API reference
accounts API
Permissions
Functions
get(accountId, [includeFolders])
getDefault([includeFolders])
getDefaultIdentity(accountId)
list([includeFolders])
setDefaultIdentity(accountId, identityId)
Events
onCreated
onDeleted
onUpdated
Types
MailAccount
Examples
Extracting IMAP accounts
addressBooks API
Permissions
Functions
closeUI()
create(properties)
delete(id)
get(id, [complete])
list([complete])
openUI()
update(id, properties)
Events
onCreated
onDeleted
onUpdated
Types
AddressBookNode
NodeType
addressBooks.provider API
Permissions
Events
onSearchRequest
browserAction API
Manifest file properties
Functions
disable([tabId])
enable([tabId])
getBadgeBackgroundColor(details)
getBadgeText(details)
getLabel(details)
getPopup(details)
getTitle(details)
isEnabled(details)
openPopup([options])
setBadgeBackgroundColor(details)
setBadgeText(details)
setIcon(details)
setLabel(details)
setPopup(details)
setTitle(details)
Events
onClicked
Types
ColorArray
ImageDataDictionary
ImageDataType
OnClickData
External Types
IconPath
ThemeIcons
cloudFile API
Manifest file properties
Functions
getAccount(accountId)
getAllAccounts()
updateAccount(accountId, updateProperties)
Events
onAccountAdded
onAccountDeleted
onFileDeleted
onFileRename
onFileUpload
onFileUploadAbort
Types
CloudFile
CloudFileAccount
CloudFileTemplateInfo
RelatedCloudFile
commands API
Manifest file properties
Functions
getAll()
reset(name)
update(detail)
Events
onChanged
onCommand
Types
Command
CommandsShortcut
KeyName
compose API
Permissions
Functions
addAttachment(tabId, attachment)
beginForward(messageId, [forwardType], [details])
beginNew([messageId], [details])
beginReply(messageId, [replyType], [details])
getActiveDictionaries(tabId)
getAttachmentFile(id)
getComposeDetails(tabId)
getComposeState(tabId)
listAttachments(tabId)
removeAttachment(tabId, attachmentId)
saveMessage(tabId, [options])
sendMessage(tabId, [options])
setActiveDictionaries(tabId, activeDictionaries)
setComposeDetails(tabId, details)
updateAttachment(tabId, attachmentId, attachment)
Events
onActiveDictionariesChanged
onAfterSave
onAfterSend
onAttachmentAdded
onAttachmentRemoved
onBeforeSend
onComposeStateChanged
onIdentityChanged
Types
ComposeAttachment
ComposeDetails
ComposeDictionaries
ComposeRecipient
ComposeRecipientList
ComposeState
CustomHeader
FileAttachment
composeAction API
Manifest file properties
Functions
disable([tabId])
enable([tabId])
getBadgeBackgroundColor(details)
getBadgeText(details)
getLabel(details)
getPopup(details)
getTitle(details)
isEnabled(details)
openPopup([options])
setBadgeBackgroundColor(details)
setBadgeText(details)
setIcon(details)
setLabel(details)
setPopup(details)
setTitle(details)
Events
onClicked
Types
ColorArray
ImageDataDictionary
ImageDataType
OnClickData
External Types
IconPath
ThemeIcons
composeScripts API
Permissions
Functions
register(composeScriptOptions)
Types
RegisteredComposeScript
RegisteredComposeScriptOptions
External Types
ExtensionFileOrCode
contacts API
Permissions
Functions
create(parentId, [id], properties)
delete(id)
get(id)
getPhoto(id)
list(parentId)
quickSearch([parentId], queryInfo)
setPhoto(id, file)
update(id, properties)
Events
onCreated
onDeleted
onUpdated
Types
ContactNode
ContactProperties
PropertyChange
QueryInfo
folders API
Permissions
Functions
copy(sourceFolder, destination)
create(parent, childName)
delete(folder)
getFolderInfo(folder)
getParentFolders(folder, [includeSubFolders])
getSubFolders(folderOrAccount, [includeSubFolders])
move(sourceFolder, destination)
rename(folder, newName)
Events
onCopied
onCreated
onDeleted
onFolderInfoChanged
onMoved
onRenamed
Types
MailFolder
MailFolderInfo
identities API
Permissions
Functions
create(accountId, details)
delete(identityId)
get(identityId)
getDefault(accountId)
list([accountId])
setDefault(accountId, identityId)
update(identityId, details)
Events
onCreated
onDeleted
onUpdated
Types
MailIdentity
mailingLists API
Permissions
Functions
addMember(id, contactId)
create(parentId, properties)
delete(id)
get(id)
list(parentId)
listMembers(id)
removeMember(id, contactId)
update(id, properties)
Events
onCreated
onDeleted
onMemberAdded
onMemberRemoved
onUpdated
Types
MailingListNode
mailTabs API
Functions
get(tabId)
getCurrent()
getSelectedMessages([tabId])
query([queryInfo])
setQuickFilter([tabId], properties)
setSelectedMessages([tabId], messageIds)
update([tabId], updateProperties)
Events
onDisplayedFolderChanged
onSelectedMessagesChanged
Types
MailTab
QuickFilterTextDetail
menus API
Permissions
Functions
create(createProperties, [callback])
getTargetElement(targetElementId)
overrideContext(contextOptions)
refresh()
remove(menuItemId)
removeAll()
update(id, updateProperties)
Events
onClicked
onHidden
onShown
Types
ContextType
ItemType
MenuIconDictionary
MenuIconPath
OnClickData
OnShowData
Properties
ACTION_MENU_TOP_LEVEL_LIMIT
messageDisplay API
Functions
getDisplayedMessage(tabId)
getDisplayedMessages(tabId)
open(openProperties)
Events
onMessageDisplayed
onMessagesDisplayed
messageDisplayAction API
Manifest file properties
Functions
disable([tabId])
enable([tabId])
getBadgeBackgroundColor(details)
getBadgeText(details)
getLabel(details)
getPopup(details)
getTitle(details)
isEnabled(details)
openPopup([options])
setBadgeBackgroundColor(details)
setBadgeText(details)
setIcon(details)
setLabel(details)
setPopup(details)
setTitle(details)
Events
onClicked
Types
ColorArray
ImageDataDictionary
ImageDataType
OnClickData
External Types
IconPath
ThemeIcons
messageDisplayScripts API
Permissions
Functions
register(messageDisplayScriptOptions)
Types
RegisteredMessageDisplayScript
RegisteredMessageDisplayScriptOptions
External Types
ExtensionFileOrCode
messages API
Permissions
Functions
archive(messageIds)
copy(messageIds, destination)
delete(messageIds, [skipTrash])
get(messageId)
getFull(messageId)
getRaw(messageId, [options])
import(file, destination, [properties])
list(folder)
move(messageIds, destination)
query([queryInfo])
update(messageId, newProperties)
continueList(messageListId)
getAttachmentFile(messageId, partName)
listAttachments(messageId)
openAttachment(messageId, partName, tabId)
createTag(key, tag, color)
deleteTag(key)
listTags()
updateTag(key, updateProperties)
Events
onCopied
onDeleted
onMoved
onNewMailReceived
onUpdated
Types
MessageAttachment
MessageHeader
MessageId
MessageList
MessagePart
MessageProperties
MessageTag
TagsDetail
sessions API
Functions
getTabValue(tabId, key)
removeTabValue(tabId, key)
setTabValue(tabId, key, value)
spaces API
Functions
create(name, defaultUrl, [buttonProperties])
get(spaceId)
open(spaceId, [windowId])
query([queryInfo])
remove(spaceId)
update(spaceId, [defaultUrl], [buttonProperties])
Types
ColorArray
Space
SpaceButtonProperties
External Types
IconPath
ThemeIcons
spacesToolbar API
Functions
addButton(id, properties)
clickButton(id, [windowId])
removeButton(id)
updateButton(id, properties)
Types
ButtonProperties
ColorArray
External Types
IconPath
ThemeIcons
theme API
Manifest file properties
Permissions
Functions
getCurrent([windowId])
reset([windowId])
update([windowId], details)
Events
onUpdated
Types
ImageDataOrExtensionURL
ThemeColor
ThemeExperiment
ThemeType
ThemeUpdateInfo
External Types
ExtensionURL
tabs API
Permissions
Functions
connect(tabId, [connectInfo])
create(createProperties)
duplicate(tabId)
executeScript([tabId], details)
get(tabId)
getCurrent()
insertCSS([tabId], details)
move(tabIds, moveProperties)
query([queryInfo])
reload([tabId], [reloadProperties])
remove(tabIds)
removeCSS([tabId], details)
sendMessage(tabId, message, [options])
update([tabId], updateProperties)
Events
onActivated
onAttached
onCreated
onDetached
onMoved
onRemoved
onUpdated
Types
Tab
TabStatus
UpdateFilter
UpdatePropertyName
WindowType
Properties
TAB_ID_NONE
windows API
Functions
create([createData])
get(windowId, [getInfo])
getAll([getInfo])
getCurrent([getInfo])
getLastFocused([getInfo])
openDefaultBrowser(url)
remove(windowId)
update(windowId, updateInfo)
Events
onCreated
onFocusChanged
onRemoved
Types
CreateType
GetInfo
Window
WindowState
WindowType
Properties
WINDOW_ID_CURRENT
WINDOW_ID_NONE
Examples
Extracting IMAP accounts
Working with WebExtension events
Events with additional parameters
Working with message lists
Working with vCard contacts
Updating legacy properties
Updating the vCard property
Experiment APIs
Introduction to Experiment APIs
Extension manifest
Schema
Implementing functions
Implementing events
The Experiment API generator
Using folder and message types
Using tabs and windows
Getting your API added to Thunderbird
Changelog
Changes up to Thunderbird 78 ESR
Thunderbird 74 Beta
legacy API
accounts API & folders API
compose API
messages API
Thunderbird 75 Beta
action APIs
compose API
messages API
Thunderbird 76 Beta
accounts API
compose API
mailTabs/messageDisplay
messages API
experiment APIs
Thunderbird 77 Beta
compose API
tabs API
composeScripts API
Thunderbird 78.0 ESR
compose API
identity API
Thunderbird 78.4.0 ESR
compose API
messageDisplay API
messageDisplayScripts API
tabs API
Thunderbird 78.5.0 ESR
compose API
tabs API
Thunderbird 78.6.0 ESR
menus API
windows API
Thunderbird 78.6.1 ESR
browserAction API
composeAction API
messageDisplayAction API
Thunderbird 78.7.0 ESR
accounts API
compose API
Thunderbird 78.7.1 ESR
theme API
Changes up to Thunderbird 91 ESR
Thunderbird 81 Beta
messageDisplay API
Thunderbird 82 Beta
compose API
tabs API
messageDisplayScripts API
Thunderbird 83 Beta
compose API
contacts API
menus API
Thunderbird 84 Beta
compose API
menus API
tabs API
windows API
browserAction API
composeAction API
messageDisplayAction API
Thunderbird 85 Beta
addressBooks API & contacts API
accounts API
compose API
messages API
Thunderbird 86 Beta
theme API
Thunderbird 87 Beta
commands API
Thunderbird 88 Beta
compose API
contacts API
menus API
messages API
Thunderbird 89 Beta
mailTabs API
menus API
Thunderbird 90 Beta
cloudFile API
compose API
messages API
Thunderbird 91.0 ESR
accounts API
addressbooks API
cloudFile API
compose API
contacts API
folders API
identities API
mailingLists API
mailTabs API
messages API
tabs API
Thunderbird 91.0.2 ESR
browserAction API
Thunderbird 91.4.1 ESR
cloudFile API
messages API
Changes up to Thunderbird 102 ESR
Thunderbird 95 Beta
compose API
Thunderbird 96 Beta
cloudFile API
messages API
Thunderbird 97 Beta
cloudFile API
Thunderbird 98 Beta
accounts API
cloudFile API
compose API
Thunderbird 100 Beta
compose API
spacesToolbar API
Thunderbird 101 Beta
cloudfile API
messageDisplay API
Thunderbird 102.0 ESR
compose API
folders API
messages API
messageDisplay API
Thunderbird 102.3.0 ESR
compose API
Changes up to Thunderbird 115 ESR
Thunderbird 106 Beta
browserAction API
commands API
compose API
contacts API
mailTabs API
messages API
messageDisplay API
Thunderbird 107 Beta
contacts API
Thunderbird 111 Beta
messageDisplay API
protocol_handler API
windows API
Thunderbird 113 Beta
action APIs
compose API
protocol_handler API
Thunderbird 115.0 ESR
browserAction API
addressBooks API
commands API
compose API
messages API
messageDisplay API
sessions API
spaces API
spacesToolbar API
tabs API
Thunderbird 115.3.2 ESR
messages API
WebExtension Documentation for Thunderbird 115
Manifest V2
Index
Index
Read the Docs
v: 115
Versions
latest
stable
115
102
91
beta-mv3
beta-mv2
128-esr-mv3
128-esr-mv2
Downloads
On Read the Docs
Project Home
Builds