WebExtension Documentation for Thunderbird 91

Manifest V2
91

API Reference

  • accounts API
    • Permissions
    • Functions
      • list([includeFolders])
      • get(accountId, [includeFolders])
      • getDefault([includeFolders])
      • setDefaultIdentity(accountId, identityId)
      • getDefaultIdentity(accountId)
    • Types
      • MailAccount
  • addressBooks API
    • Permissions
    • Functions
      • openUI()
      • closeUI()
      • list([complete])
      • get(id, [complete])
      • create(properties)
      • update(id, properties)
      • delete(id)
    • Events
      • onCreated
      • onUpdated
      • onDeleted
    • Types
      • AddressBookNode
      • NodeType
  • addressBooks.provider API
    • Permissions
    • Events
      • onSearchRequest
  • browserAction API
    • 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
    • Types
      • ColorArray
      • ImageDataDictionary
      • ImageDataType
      • OnClickData
    • External Types
      • IconPath
      • ThemeIcons
  • cloudFile API
    • Manifest file properties
    • Functions
      • getAccount(accountId)
      • getAllAccounts()
      • updateAccount(accountId, updateProperties)
    • Events
      • onFileUpload
      • onFileUploadAbort
      • onFileDeleted
      • onAccountAdded
      • onAccountDeleted
    • Types
      • CloudFile
      • CloudFileAccount
      • CloudFileTemplateInfo
  • commands
    • Manifest file properties
    • Functions
      • update(detail)
      • reset(name)
      • getAll()
    • Events
      • onCommand(command)
    • Types
      • Command
      • CommandsShortcut
      • KeyName
  • compose API
    • 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)
      • sendMessage(tabId, [options])
      • getComposeState(tabId)
    • Events
      • onBeforeSend
      • onAttachmentAdded
      • onAttachmentRemoved
      • onIdentityChanged
      • onComposeStateChanged
    • Types
      • ComposeAttachment
      • ComposeDetails
      • ComposeRecipient
      • ComposeRecipientList
      • ComposeState
  • composeAction API
    • 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
    • Types
      • ColorArray
      • ImageDataDictionary
      • ImageDataType
      • OnClickData
    • External Types
      • IconPath
      • ThemeIcons
  • composeScripts API
    • Functions
      • register(composeScriptOptions)
    • Types
      • RegisteredComposeScript
      • RegisteredComposeScriptOptions
    • External Types
      • ExtensionFileOrCode
  • contacts API
    • Permissions
    • Functions
      • list(parentId)
      • quickSearch([parentId], queryInfo)
      • get(id)
      • create(parentId, [id], properties)
      • update(id, properties)
      • delete(id)
    • Events
      • onCreated
      • onUpdated
      • onDeleted
    • Types
      • ContactNode
      • ContactProperties
      • PropertyChange
      • QueryInfo
  • folders API
    • Permissions
    • Functions
      • create(parent, childName)
      • rename(folder, newName)
      • move(sourceFolder, destination)
      • copy(sourceFolder, destination)
      • delete(folder)
      • getFolderInfo(folder)
      • getParentFolders(folder, [includeSubFolders])
      • getSubFolders(folderOrAccount, [includeSubFolders])
    • Events
      • onCreated
      • onRenamed
      • onMoved
      • onCopied
      • onDeleted
      • onFolderInfoChanged
    • Types
      • MailFolder
      • MailFolderInfo
  • identities API
    • Permissions
    • Functions
      • list([accountId])
      • get(identityId)
      • create(accountId, details)
      • delete(identityId)
      • update(identityId, details)
      • getDefault(accountId)
      • setDefault(accountId, identityId)
    • Events
      • onCreated
      • onDeleted
      • onUpdated
    • Types
      • MailIdentity
  • mailingLists API
    • Permissions
    • Functions
      • list(parentId)
      • get(id)
      • create(parentId, properties)
      • update(id, properties)
      • delete(id)
      • addMember(id, contactId)
      • listMembers(id)
      • removeMember(id, contactId)
    • Events
      • onCreated
      • onUpdated
      • onDeleted
      • onMemberAdded
      • onMemberRemoved
    • Types
      • MailingListNode
  • mailTabs API
    • Functions
      • query(queryInfo)
      • get(tabId)
      • getCurrent()
      • update([tabId], updateProperties)
      • getSelectedMessages([tabId])
      • setQuickFilter([tabId], properties)
    • Events
      • onDisplayedFolderChanged
      • onSelectedMessagesChanged
    • Types
      • MailTab
      • QuickFilterTextDetail
  • menus API
    • Permissions
    • Functions
      • getTargetElement(targetElementId)
      • create(createProperties, [callback])
      • update(id, updateProperties)
      • remove(menuItemId)
      • removeAll()
      • overrideContext(contextOptions)
      • refresh()
    • Events
      • onClicked
      • onShown
      • onHidden
    • Types
      • ContextType
      • ItemType
      • OnClickData
      • OnShowData
    • External Types
      • IconPath
    • Properties
      • ACTION_MENU_TOP_LEVEL_LIMIT
  • messageDisplay API
    • Functions
      • getDisplayedMessage(tabId)
      • getDisplayedMessages(tabId)
    • Events
      • onMessageDisplayed
      • onMessagesDisplayed
  • messageDisplayAction API
    • 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
    • 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
      • list(folder)
      • continueList(messageListId)
      • get(messageId)
      • getFull(messageId)
      • getRaw(messageId)
      • listAttachments(messageId)
      • getAttachmentFile(messageId, partName)
      • query(queryInfo)
      • update(messageId, newProperties)
      • move(messageIds, destination)
      • copy(messageIds, destination)
      • delete(messageIds, [skipTrash])
      • archive(messageIds)
      • listTags()
    • Events
      • onUpdated
      • onMoved
      • onCopied
      • onDeleted
      • onNewMailReceived
    • Types
      • Attachment
      • MessageChangeProperties
      • MessageHeader
      • MessageList
      • MessagePart
      • MessageTag
      • TagsDetail
  • theme API
    • Manifest file properties
    • Permissions
    • Functions
      • getCurrent([windowId])
      • update([windowId], details)
      • reset([windowId])
    • Events
      • onUpdated
    • Types
      • ImageDataOrExtensionURL
      • ThemeColor
      • ThemeExperiment
      • ThemeType
      • ThemeUpdateInfo
    • External Types
      • ExtensionURL
  • tabs API
    • 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
      • onUpdated
      • onMoved
      • onActivated
      • onDetached
      • onAttached
      • onRemoved
    • Types
      • Tab
      • TabStatus
      • UpdateFilter
      • UpdatePropertyName
      • WindowType
    • Properties
      • TAB_ID_NONE
  • windows API
    • Functions
      • get(windowId, [getInfo])
      • getCurrent([getInfo])
      • getLastFocused([getInfo])
      • getAll([getInfo])
      • create([createData])
      • update(windowId, updateInfo)
      • remove(windowId)
      • openDefaultBrowser(url)
    • Events
      • onCreated
      • onRemoved
      • onFocusChanged
    • 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

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
WebExtension Documentation for Thunderbird 91

Manifest V2
  • Search

© Copyright . Revision e6000014.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: 91
Versions
latest
stable
115
102
91
beta-mv3
beta-mv2
128-esr-mv3
128-esr-mv2
Downloads
On Read the Docs
Project Home
Builds