WebExtension Documentation for Thunderbird 128

Manifest V3
stable

API reference

  • accounts API
    • Permissions
    • Functions
      • get(accountId, [includeSubFolders])
      • getDefault([includeSubFolders])
      • list([includeSubFolders])
    • Events
      • onCreated
      • onDeleted
      • onUpdated
    • Types
      • MailAccount
      • MailAccountId
      • MailAccountType
    • 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
  • addressBooks.contacts API
    • Permissions
    • Functions
      • create(parentId, vCard)
      • delete(id)
      • get(id)
      • getPhoto(id)
      • list(parentId)
      • query(queryInfo)
      • setPhoto(id, file)
      • update(id, vCard)
    • Events
      • onCreated
      • onDeleted
      • onUpdated
    • Types
      • ContactNode
      • ContactProperties
      • PropertyChange
      • QueryInfo
  • addressBooks.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
  • alarms API
    • Functions
      • clear([name])
      • clearAll()
      • create([name], alarmInfo)
      • get([name])
      • getAll()
    • Events
      • onAlarm
    • Types
      • Alarm
  • action API
    • Manifest file properties
    • Functions
      • disable([tabId])
      • enable([tabId])
      • getBadgeBackgroundColor(details)
      • getBadgeText(details)
      • getBadgeTextColor(details)
      • getLabel(details)
      • getPopup(details)
      • getTitle(details)
      • isEnabled(details)
      • openPopup([options])
      • setBadgeBackgroundColor(details)
      • setBadgeText(details)
      • setBadgeTextColor(details)
      • setIcon(details)
      • setLabel(details)
      • setPopup(details)
      • setTitle(details)
    • Events
      • onClicked
    • Types
      • ColorArray
      • ImageDataDictionary
      • ImageDataType
      • OnClickData
    • External Types
      • IconPath
      • ThemeIcons
  • browserSettings API
    • Permissions
    • Types
      • ColorManagementMode
      • ContextMenuMouseEvent
      • ImageAnimationBehavior
    • Properties
      • allowPopupsForUserEvents
      • cacheEnabled
      • contextMenuShowEvent
      • ftpProtocolEnabled
      • imageAnimationBehavior
      • overrideContentColorScheme
      • overrideDocumentColors
      • useDocumentFonts
      • webNotificationsDisabled
      • zoomFullPage
  • browserSettings.colorManagement API
    • Permissions
    • Properties
      • mode
      • useNativeSRGB
      • useWebRenderCompositor
  • browsingData API
    • Permissions
    • Functions
      • remove(options, dataToRemove)
      • removeAppcache(options)
      • removeCache(options)
      • removeCookies(options)
      • removeDownloads(options)
      • removeFileSystems(options)
      • removeFormData(options)
      • removeHistory(options)
      • removeIndexedDB(options)
      • removeLocalStorage(options)
      • removePasswords(options)
      • removePluginData(options)
      • removeWebSQL(options)
      • settings()
    • Types
      • DataTypeSet
      • RemovalOptions
  • clipboard API
    • Functions
      • setImageData(imageData, imageType)
  • 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
      • EncryptionPropertiesOpenPGP
      • EncryptionPropertiesSMIME
      • FileAttachment
  • composeAction API
    • Manifest file properties
    • Functions
      • disable([tabId])
      • enable([tabId])
      • getBadgeBackgroundColor(details)
      • getBadgeText(details)
      • getBadgeTextColor(details)
      • getLabel(details)
      • getPopup(details)
      • getTitle(details)
      • isEnabled(details)
      • openPopup([options])
      • setBadgeBackgroundColor(details)
      • setBadgeText(details)
      • setBadgeTextColor(details)
      • setIcon(details)
      • setLabel(details)
      • setPopup(details)
      • setTitle(details)
    • Events
      • onClicked
    • Types
      • ColorArray
      • ImageDataDictionary
      • ImageDataType
      • OnClickData
    • External Types
      • IconPath
      • ThemeIcons
  • contextualIdentities API
    • Permissions
    • Functions
      • create(details)
      • get(cookieStoreId)
      • move(cookieStoreIds, position)
      • query(details)
      • remove(cookieStoreId)
      • update(cookieStoreId, details)
    • Events
      • onCreated
      • onRemoved
      • onUpdated
    • Types
      • ContextualIdentity
  • cookies API
    • Permissions
    • Functions
      • get(details)
      • getAll(details)
      • getAllCookieStores()
      • remove(details)
      • set(details)
    • Events
      • onChanged
    • Types
      • Cookie
      • CookieStore
      • OnChangedCause
      • PartitionKey
      • SameSiteStatus
  • declarativeNetRequest API
    • Manifest file properties
    • Permissions
    • Functions
      • getAvailableStaticRuleCount()
      • getDisabledRuleIds(options)
      • getDynamicRules([filter])
      • getEnabledRulesets()
      • getSessionRules([filter])
      • isRegexSupported(regexOptions)
      • testMatchOutcome(request, [options])
      • updateDynamicRules(options)
      • updateEnabledRulesets(updateRulesetOptions)
      • updateSessionRules(options)
      • updateStaticRules(options)
    • Types
      • GetRulesFilter
      • MatchedRule
      • ResourceType
      • Rule
      • URLTransform
      • UnsupportedRegexReason
    • Properties
      • DYNAMIC_RULESET_ID
      • GUARANTEED_MINIMUM_STATIC_RULES
      • MAX_NUMBER_OF_DISABLED_STATIC_RULES
      • MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES
      • MAX_NUMBER_OF_DYNAMIC_RULES
      • MAX_NUMBER_OF_ENABLED_STATIC_RULESETS
      • MAX_NUMBER_OF_REGEX_RULES
      • MAX_NUMBER_OF_SESSION_RULES
      • MAX_NUMBER_OF_STATIC_RULESETS
      • SESSION_RULESET_ID
  • dns API
    • Permissions
    • Functions
      • resolve(hostname, [flags])
    • Types
      • DNSRecord
      • ResolveFlags
  • downloads API
    • Permissions
    • Functions
      • cancel(downloadId)
      • download(options)
      • drag(downloadId)
      • erase(query)
      • getFileIcon(downloadId, [options])
      • open(downloadId)
      • pause(downloadId)
      • removeFile(downloadId)
      • resume(downloadId)
      • search(query)
      • show(downloadId)
      • showDefaultFolder()
    • Events
      • onChanged
      • onCreated
      • onErased
    • Types
      • BooleanDelta
      • DangerType
      • DoubleDelta
      • DownloadItem
      • DownloadQuery
      • DownloadTime
      • FilenameConflictAction
      • InterruptReason
      • State
      • StringDelta
  • extension API
    • Functions
      • getBackgroundPage()
      • getViews([fetchProperties])
      • isAllowedFileSchemeAccess()
      • isAllowedIncognitoAccess()
    • Events
    • Types
      • ViewType
    • Properties
      • inIncognitoContext
      • lastError
  • folders API
    • Permissions
    • Functions
      • copy(sourceFolderId, destinationFolderId)
      • create(folderId, childName)
      • delete(folderId)
      • get(folderId, [includeSubFolders])
      • getFolderCapabilities(folderId)
      • getFolderInfo(folderId)
      • getParentFolders(folderId, [includeSubFolders])
      • getSubFolders(folderId, [includeSubFolders])
      • getTagFolder(key)
      • getUnifiedFolder(type, [includeSubFolders])
      • markAsRead(folderId)
      • move(sourceFolderId, destinationFolderId)
      • query([queryInfo])
      • rename(folderId, newName)
      • update(folderId, updateProperties)
    • Events
      • onCopied
      • onCreated
      • onDeleted
      • onFolderInfoChanged
      • onMoved
      • onRenamed
      • onUpdated
    • Types
      • MailFolder
      • MailFolderCapabilities
      • MailFolderId
      • MailFolderInfo
      • MailFolderQuota
      • MailFolderSpecialUse
      • QueryRange
      • RegularExpression
    • Properties
      • DEFAULT_MOST_RECENT_LIMIT
  • i18n API
    • Manifest file properties
    • Functions
      • detectLanguage(text)
      • getAcceptLanguages()
      • getMessage(messageName, [substitutions])
      • getUILanguage()
    • Events
    • Types
      • LanguageCode
  • 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
      • EncryptionCapabilities
      • MailIdentity
  • identity API
    • Permissions
    • Functions
      • getAccounts()
      • getAuthToken([details])
      • getProfileUserInfo()
      • getRedirectURL([path])
      • launchWebAuthFlow(details)
      • removeCachedAuthToken(details)
    • Events
      • onSignInChanged
    • Types
      • AccountInfo
  • idle API
    • Functions
      • queryState(detectionIntervalInSeconds)
      • setDetectionInterval(intervalInSeconds)
    • Events
      • onStateChanged
    • Types
      • IdleState
  • mailTabs API
    • Functions
      • create([createProperties])
      • get(tabId)
      • getListedMessages([tabId])
      • getSelectedFolders([tabId])
      • getSelectedMessages([tabId])
      • query([queryInfo])
      • setQuickFilter([tabId], properties)
      • setSelectedMessages([tabId], messageIds)
      • update([tabId], updateProperties)
    • Events
      • onDisplayedFolderChanged
      • onSelectedMessagesChanged
    • Types
      • FolderMode
      • MailTab
      • MailTabProperties
      • QuickFilterTextDetail
  • management API
    • Permissions
    • Functions
      • get(id)
      • getAll()
      • getSelf()
      • install(options)
      • setEnabled(id, enabled)
      • uninstallSelf([options])
    • Events
      • onDisabled
      • onEnabled
      • onInstalled
      • onUninstalled
    • Types
      • ExtensionDisabledReason
      • ExtensionInfo
      • ExtensionInstallType
      • ExtensionType
      • IconInfo
  • 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
      • MenuActionCommand
      • MenuIconDictionary
      • MenuIconPath
      • OnClickData
      • OnShowData
    • Properties
      • ACTION_MENU_TOP_LEVEL_LIMIT
  • messageDisplay API
    • Functions
      • getDisplayedMessages([tabId])
      • open(openProperties)
    • Events
      • onMessagesDisplayed
  • messageDisplayAction API
    • Manifest file properties
    • Functions
      • disable([tabId])
      • enable([tabId])
      • getBadgeBackgroundColor(details)
      • getBadgeText(details)
      • getBadgeTextColor(details)
      • getLabel(details)
      • getPopup(details)
      • getTitle(details)
      • isEnabled(details)
      • openPopup([options])
      • setBadgeBackgroundColor(details)
      • setBadgeText(details)
      • setBadgeTextColor(details)
      • setIcon(details)
      • setLabel(details)
      • setPopup(details)
      • setTitle(details)
    • Events
      • onClicked
    • Types
      • ColorArray
      • ImageDataDictionary
      • ImageDataType
      • OnClickData
    • External Types
      • IconPath
      • ThemeIcons
  • messages API
    • Permissions
    • Functions
      • archive(messageIds)
      • copy(messageIds, folderId)
      • delete(messageIds, [skipTrash])
      • get(messageId)
      • getFull(messageId, [options])
      • getRaw(messageId, [options])
      • import(file, folderId, [properties])
      • list(folderId)
      • move(messageIds, folderId)
      • query([queryInfo])
      • update(messageId, newProperties)
      • abortList(messageListId)
      • continueList(messageListId)
      • deleteAttachments(messageId, partNames)
      • getAttachmentFile(messageId, partName)
      • listAttachments(messageId)
      • listInlineTextParts(messageId)
      • openAttachment(messageId, partName, tabId)
    • Events
      • onCopied
      • onDeleted
      • onMoved
      • onNewMailReceived
      • onUpdated
    • Types
      • InlineTextPart
      • MailBoxHeaderString
      • MessageAttachment
      • MessageHeader
      • MessageId
      • MessageList
      • MessagePart
      • MessageProperties
      • QueryRange
  • messages.tags API
    • Permissions
    • Functions
      • create(key, tag, color)
      • delete(key)
      • list()
      • update(key, updateProperties)
    • Types
      • MessageTag
      • TagsDetail
  • notifications API
    • Functions
      • clear(notificationId)
      • create([notificationId], options)
      • getAll()
      • getPermissionLevel()
    • Events
      • onClicked
      • onClosed
      • onPermissionLevelChanged
      • onShowSettings
      • onShown
    • Types
      • CreateNotificationOptions
      • NotificationItem
      • PermissionLevel
      • TemplateType
      • UpdateNotificationOptions
  • permissions API
    • Functions
      • contains(permissions)
      • getAll()
      • remove(permissions)
      • request(permissions)
    • Events
      • onAdded
      • onRemoved
    • Types
      • AnyPermissions
      • Permissions
  • pkcs11 API
    • Permissions
    • Functions
      • getModuleSlots(name)
      • installModule(name, [flags])
      • isModuleInstalled(name)
      • uninstallModule(name)
  • privacy API
    • Permissions
  • privacy.network API
    • Permissions
    • Types
      • HTTPSOnlyModeOption
      • IPHandlingPolicy
      • tlsVersionRestrictionConfig
    • Properties
      • globalPrivacyControl
      • httpsOnlyMode
      • networkPredictionEnabled
      • peerConnectionEnabled
      • tlsVersionRestriction
      • webRTCIPHandlingPolicy
  • privacy.services API
    • Permissions
    • Properties
      • passwordSavingEnabled
  • privacy.websites API
    • Permissions
    • Types
      • CookieConfig
      • TrackingProtectionModeOption
    • Properties
      • cookieConfig
      • firstPartyIsolate
      • hyperlinkAuditingEnabled
      • protectedContentEnabled
      • referrersEnabled
      • resistFingerprinting
      • thirdPartyCookiesAllowed
      • trackingProtectionMode
  • runtime API
    • Permissions
    • Functions
      • connect([extensionId], [connectInfo])
      • connectNative(application)
      • getBackgroundPage()
      • getBrowserInfo()
      • getContexts(filter)
      • getFrameId(target)
      • getManifest()
      • getPlatformInfo()
      • getURL(path)
      • openOptionsPage()
      • reload()
      • restart()
      • sendMessage([extensionId], message, [options])
      • sendNativeMessage(application, message)
    • Events
      • onConnect
      • onConnectExternal
      • onInstalled
      • onMessage
      • onMessageExternal
      • onPerformanceWarning
      • onStartup
      • onSuspend
      • onSuspendCanceled
      • onUpdateAvailable
    • Types
      • BrowserInfo
      • ContextFilter
      • ContextType
      • ExtensionContext
      • MessageSender
      • OnInstalledReason
      • OnPerformanceWarningCategory
      • OnPerformanceWarningSeverity
      • OnRestartRequiredReason
      • PlatformArch
      • PlatformInfo
      • PlatformOs
      • Port
      • RequestUpdateCheckStatus
    • Properties
      • id
      • lastError
  • scripting API
    • Permissions
    • Functions
      • executeScript(injection)
      • getRegisteredContentScripts([filter])
      • insertCSS(injection)
      • registerContentScripts(scripts)
      • removeCSS(injection)
      • unregisterContentScripts([filter])
      • updateContentScripts(scripts)
    • Types
      • CSSInjection
      • ContentScriptFilter
      • ExecutionWorld
      • InjectionResult
      • InjectionTarget
      • RegisteredContentScript
      • ScriptInjection
    • External Types
      • ExtensionURL
  • scripting.compose API
    • Permissions
    • Functions
      • getRegisteredScripts([filter])
      • registerScripts(scripts)
      • unregisterScripts([filter])
    • Types
      • ComposeScriptDetails
      • ComposeScriptFilter
    • External Types
      • ExtensionURL
  • scripting.messageDisplay API
    • Permissions
    • Functions
      • getRegisteredScripts([filter])
      • registerScripts(scripts)
      • unregisterScripts([filter])
    • Types
      • MessageDisplayScriptDetails
      • MessageDisplayScriptFilter
    • External Types
      • ExtensionURL
  • 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
      • ButtonProperties
      • ColorArray
      • Space
      • SpaceButtonProperties
    • External Types
      • IconPath
      • ThemeIcons
  • storage API
    • Events
      • onChanged
    • Types
      • StorageArea
      • StorageAreaSync
      • StorageChange
    • Properties
      • local
      • managed
      • session
      • sync
  • tabs API
    • Permissions
    • Functions
      • connect(tabId, [connectInfo])
      • create(createProperties)
      • duplicate(tabId)
      • get(tabId)
      • getCurrent()
      • move(tabIds, moveProperties)
      • query([queryInfo])
      • reload([tabId], [reloadProperties])
      • remove(tabIds)
      • sendMessage(tabId, message, [options])
      • update([tabId], updateProperties)
    • Events
      • onActivated
      • onAttached
      • onCreated
      • onDetached
      • onMoved
      • onRemoved
      • onUpdated
    • Types
      • Tab
      • TabStatus
      • TabType
      • UpdateFilter
      • UpdatePropertyName
      • WindowType
    • Properties
      • TAB_ID_NONE
  • 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
  • messengerUtilities API
    • Functions
      • convertToPlainText(body, [options])
      • formatFileSize(sizeInBytes)
      • parseMailboxString(mailboxString, [preserveGroups])
    • Types
      • ParsedMailbox
  • webNavigation API
    • Permissions
    • Functions
      • getAllFrames(details)
      • getFrame(details)
    • Events
      • onBeforeNavigate
      • onCommitted
      • onCompleted
      • onCreatedNavigationTarget
      • onDOMContentLoaded
      • onErrorOccurred
      • onHistoryStateUpdated
      • onReferenceFragmentUpdated
      • onTabReplaced
    • Types
      • EventUrlFilters
      • TransitionQualifier
      • TransitionType
  • webRequest API
    • Permissions
    • Functions
      • filterResponseData(requestId)
      • getSecurityInfo(requestId, [options])
      • handlerBehaviorChanged()
    • Events
      • onAuthRequired
      • onBeforeRedirect
      • onBeforeRequest
      • onBeforeSendHeaders
      • onCompleted
      • onErrorOccurred
      • onHeadersReceived
      • onResponseStarted
      • onSendHeaders
    • Types
      • BlockingResponse
      • CertificateInfo
      • CertificateTransparencyStatus
      • HttpHeaders
      • OnAuthRequiredOptions
      • OnBeforeRedirectOptions
      • OnBeforeRequestOptions
      • OnBeforeSendHeadersOptions
      • OnCompletedOptions
      • OnHeadersReceivedOptions
      • OnResponseStartedOptions
      • OnSendHeadersOptions
      • RequestFilter
      • ResourceType
      • SecurityInfo
      • TransportWeaknessReasons
      • UploadData
      • UrlClassification
      • UrlClassificationFlags
      • UrlClassificationParty
    • Properties
      • MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES
  • 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 queries
  • 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 in Manifest Version 3
    • accounts API
    • contacts API
    • mailingLists API
    • browserAction API
    • commands API
    • compose API
    • composeScripts API
    • folders API
    • mailTabs API
    • menus API
    • messageDisplay API
    • messageDisplayScripts API
    • messages API
    • spaces API
    • spacesToolbar API
    • tabs API
WebExtension Documentation for Thunderbird 128

Manifest V3
  • Search

© Copyright . Revision 48ddfa24.

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