Thunderbird WebExtension APIs
78
API Documentation
accounts
Permissions
Functions
list()
get(accountId)
getDefault()
setDefaultIdentity(accountId, identityId)
getDefaultIdentity(accountId)
Types
MailAccount
MailIdentity
addressBooks
Permissions
Functions
openUI()
closeUI()
list([complete])
get(id, [complete])
create(properties)
update(id, properties)
delete(id)
Events
onCreated(node)
onUpdated(node)
onDeleted(id)
Types
AddressBookNode
NodeType
browserAction
Manifest file properties
Functions
setTitle(details)
getTitle(details)
setLabel(details)
getLabel(details)
setIcon(details)
setPopup(details)
getPopup(details)
setBadgeText(details)
getBadgeText(details)
setBadgeBackgroundColor(details)
getBadgeBackgroundColor(details)
enable([tabId])
disable([tabId])
isEnabled(details)
openPopup()
Events
onClicked(tab, [info])
Types
ColorArray
Details
ImageDataType
OnClickData
External Types
ThemeIcons
cloudFile
Manifest file properties
Functions
getAccount(accountId)
getAllAccounts()
updateAccount(accountId, updateProperties)
Events
onFileUpload(account, fileInfo)
onFileUploadAbort(account, fileId)
onFileDeleted(account, fileId)
onAccountAdded(account)
onAccountDeleted(accountId)
Types
CloudFile
CloudFileAccount
commands
Manifest file properties
Functions
update(detail)
reset(name)
getAll()
Events
onCommand(command)
Types
Command
CommandsShortcut
KeyName
compose
Permissions
Functions
beginNew([messageId], [details])
beginReply(messageId, [replyType], [details])
beginForward(messageId, [forwardType], [details])
getComposeDetails(tabId)
setComposeDetails(tabId, details)
listAttachments(tabId)
addAttachment(tabId, data)
updateAttachment(tabId, attachmentId, data)
removeAttachment(tabId, attachmentId)
Events
onBeforeSend(tab, details)
onAttachmentAdded(tab, attachment)
onAttachmentRemoved(tab, attachmentId)
onIdentityChanged(tab, identityId)
Types
ComposeAttachment
ComposeDetails
ComposeRecipient
ComposeRecipientList
composeAction
Manifest file properties
Functions
setTitle(details)
getTitle(details)
setLabel(details)
getLabel(details)
setIcon(details)
setPopup(details)
getPopup(details)
setBadgeText(details)
getBadgeText(details)
setBadgeBackgroundColor(details)
getBadgeBackgroundColor(details)
enable([tabId])
disable([tabId])
isEnabled(details)
openPopup()
Events
onClicked(tab, [info])
Types
ColorArray
Details
ImageDataType
OnClickData
External Types
ThemeIcons
composeScripts
Functions
register(composeScriptOptions)
Types
RegisteredComposeScript
RegisteredComposeScriptOptions
External Types
ExtensionFileOrCode
contacts
Permissions
Functions
list(parentId)
quickSearch([parentId], searchString)
get(id)
create(parentId, [id], properties)
update(id, properties)
delete(id)
Events
onCreated(node, id)
onUpdated(node)
onDeleted(parentId, id)
Types
ContactNode
ContactProperties
folders
Permissions
Functions
create(parentFolder, childName)
rename(folder, newName)
delete(folder)
Types
MailFolder
mailingLists
Permissions
Functions
list(parentId)
get(id)
create(parentId, properties)
update(id, properties)
delete(id)
addMember(id, contactId)
listMembers(id)
removeMember(id, contactId)
Events
onCreated(node)
onUpdated(node)
onDeleted(parentId, id)
onMemberAdded(node)
onMemberRemoved(parentId, id)
Types
MailingListNode
mailTabs
Functions
query(queryInfo)
update([tabId], updateProperties)
getSelectedMessages([tabId])
setQuickFilter([tabId], properties)
Events
onDisplayedFolderChanged(tab, displayedFolder)
onSelectedMessagesChanged(tab, selectedMessages)
Types
MailTab
QuickFilterTextDetail
menus
Permissions
Functions
create(createProperties, [callback])
update(id, updateProperties)
remove(menuItemId)
removeAll()
overrideContext(contextOptions)
refresh()
Events
onClicked(info, [tab])
onShown(info, tab)
onHidden()
Types
ContextType
ItemType
OnClickData
Properties
ACTION_MENU_TOP_LEVEL_LIMIT
messageDisplay
Functions
getDisplayedMessage(tabId)
getDisplayedMessages(tabId)
Events
onMessageDisplayed(tab, message)
onMessagesDisplayed(tab, messages)
messageDisplayAction
Manifest file properties
Functions
setTitle(details)
getTitle(details)
setLabel(details)
getLabel(details)
setIcon(details)
setPopup(details)
getPopup(details)
setBadgeText(details)
getBadgeText(details)
setBadgeBackgroundColor(details)
getBadgeBackgroundColor(details)
enable([tabId])
disable([tabId])
isEnabled(details)
openPopup()
Events
onClicked(tab, [info])
Types
ColorArray
Details
ImageDataType
OnClickData
External Types
ThemeIcons
messageDisplayScripts
Permissions
Functions
register(messageDisplayScriptOptions)
Types
RegisteredMessageDisplayScript
RegisteredMessageDisplayScriptOptions
External Types
ExtensionFileOrCode
messages
Permissions
Functions
list(folder)
continueList(messageListId)
get(messageId)
getFull(messageId)
getRaw(messageId)
query(queryInfo)
update(messageId, newProperties)
move(messageIds, destination)
copy(messageIds, destination)
delete(messageIds, [skipTrash])
archive(messageIds)
listTags()
Events
onNewMailReceived(folder, messages)
Types
MessageHeader
MessageList
MessagePart
MessageTag
TagsDetail
theme
Manifest file properties
Permissions
Functions
getCurrent([windowId])
update([windowId], details)
reset([windowId])
Events
onUpdated(updateInfo)
Types
ImageDataOrExtensionURL
ThemeColor
ThemeExperiment
ThemeType
ThemeUpdateInfo
tabs
Permissions
Functions
get(tabId)
getCurrent()
connect(tabId, [connectInfo])
sendMessage(tabId, message, [options])
create(createProperties)
duplicate(tabId)
query(queryInfo)
update([tabId], updateProperties)
move(tabIds, moveProperties)
reload([tabId], [reloadProperties])
remove(tabIds)
executeScript([tabId], details)
insertCSS([tabId], details)
removeCSS([tabId], details)
Events
onCreated(tab)
onUpdated(tabId, changeInfo, tab)
onMoved(tabId, moveInfo)
onActivated(activeInfo)
onDetached(tabId, detachInfo)
onAttached(tabId, attachInfo)
onRemoved(tabId, removeInfo)
Types
Tab
TabStatus
UpdateFilter
UpdatePropertyName
WindowType
Properties
TAB_ID_NONE
windows
Functions
get(windowId, [getInfo])
getCurrent([getInfo])
getLastFocused([getInfo])
getAll([getInfo])
create([createData])
update(windowId, updateInfo)
remove(windowId)
openDefaultBrowser(url)
Events
onCreated(window)
onRemoved(windowId)
onFocusChanged(windowId)
Types
CreateType
GetInfo
Window
WindowState
WindowType
Properties
WINDOW_ID_CURRENT
WINDOW_ID_NONE
How To Guides
Working with WebExtension Events
Working with Message Lists
WebExtension Experiments
Adding an experiment to your extension
Extension manifest
Schema
Implementing functions
Implementing events
Using folder and message types
Using tabs and windows
Experiment API Generator
Getting your API added to Thunderbird
Changes to APIs
Changes in Thunderbird 74
legacy
accounts/folders
compose
messages
Changes in Thunderbird 75
browserAction/composeAction/messageDisplayAction
compose
messages
Changes in Thunderbird 76
accounts
compose
mailTabs/messageDisplay
messages
experiments
Changes in Thunderbird 77
compose
tabs
composeScripts/tabs
Changes in Thunderbird 78
compose
identity
Changes in Thunderbird 78.4.0
compose
tabs
messageDisplay
messageDisplayScripts/tabs
Changes in Thunderbird 78.5.0
compose
menus
tabs
Changes in Thunderbird 78.6.0
browserAction
composeAction
menus
messageDisplayAction
windows
Changes in Thunderbird 78.7.0
accounts
compose
Changes in Thunderbird 78.7.1
theme
Changes in Thunderbird 78.10.2
accounts
messages
Thunderbird WebExtension APIs
»
Index
Edit on GitHub
Index
Read the Docs
v: 78
Versions
latest
78
68
Downloads
On Read the Docs
Project Home
Builds