Changelog for Thunderbird 102.0

The following WebExtension API changes were introduced in Thunderbird 102.0.

accounts

api accounts
  • event onCreated — Fired when a new account has been created.

  • event onDeleted — Fired when an account has been removed.

  • event onUpdated — Fired when a property of an account has been modified. Folders and identities of accounts are not monitored by this event, use the dedicated folder and identity events instead. A changed defaultIdentity is reported only after a different identity has been assigned as default identity, but not after a property of the default identity has been changed.

browserSettings

  • setting overrideContentColorScheme — This setting controls whether a light or dark color scheme overrides the page’s preferred color scheme.

cloudFile

api cloudFile
  • event onFileRename — Fired when a previously uploaded file should be renamed.

  • event onFileUpload.relatedFileInfo — Information about an already uploaded file, which is related to this upload.

  • type CloudFileTemplateInfo.download_expiry_date — If set, the cloud file entry for this upload will include a hint, that the link will only be available for a limited time.

  • type CloudFileTemplateInfo.download_limit — If set, the cloud file entry for this upload will include a hint, that the file has a download limit.

  • type CloudFileTemplateInfo.download_password_protected — If set to true, the cloud file entry for this upload will include a hint, that the download link is password protected.

  • type RelatedCloudFile — Information about an already uploaded cloud file, which is related to a new upload. For example if the content of a cloud attachment is updated, if a repeatedly used cloud attachment is renamed (and therefore should be re-uploaded to not invalidate existing links) or if the provider has its manifest property reuse_uploads set to false.

  • property cloud_file.reuse_uploads — If a previously uploaded cloud file attachment is reused at a later time in a different message, Thunderbird may use the already known url and templateInfo values without triggering the registered cloudFile.onFileUpload listener again. Setting this option to false will always trigger the registered listener, providing the already known values through the relatedFileInfo parameter of the cloudFile.onFileUpload event, to let the provider decide how to handle these cases.

compose

api compose
  • function getActiveDictionaries — Returns a compose.ComposeDictionaries object, listing all installed dictionaries, including the information whether they are currently enabled or not.

  • function getAttachmentFile — Gets the content of a compose.ComposeAttachment as a File object.

  • function saveMessage — Saves the message currently being composed as a draft or as a template. If the save mode is not specified, the message will be saved as a draft. The returned Promise fulfills once the message has been successfully saved.

  • function setActiveDictionaries — Updates the active dictionaries. Throws if the activeDictionaries array contains unknown or invalid language identifiers.

  • event onActiveDictionariesChanged — Fired when one or more dictionaries have been activated or deactivated.

  • type ComposeDetails.additionalFccFolder — An additional fcc folder which can be selected while composing the message, an empty string if not used. Has no effect when the message is saved as a draft or template; the additional copy is only created when the message is actually sent or queued for sending. The permission accountsRead is required to use this property.

  • type ComposeDetails.attachVCard — Whether or not the vCard of the used identity will be attached to the message during send.

  • type ComposeDetails.customHeaders — Array of custom headers. Headers will be returned in Http-Header-Case (a.k.a. Train-Case). Set an empty array to clear all custom headers.

  • type ComposeDetails.deliveryFormat — Defines the MIME format of the sent message (ignored on plain text messages). Defaults to auto, which will send html messages as plain text, if they do not include any formatting, and as both otherwise (a multipart/mixed message).

  • type ComposeDetails.deliveryStatusNotification — Let the sender know when the recipient’s server received the message. Not supported by all servers.

  • type ComposeDetails.overrideDefaultFcc — Indicates whether the default fcc setting (defined by the used identity) is being overridden for this message. Setting false will clear the override. Setting true will throw an ExtensionError, if overrideDefaultFccFolder is not set as well. The permission accountsRead is required to use this property.

  • type ComposeDetails.overrideDefaultFccFolder — This value overrides the default fcc setting (defined by the used identity) for this message only. Either a folders.MailFolder specifying the folder for the copy of the sent message, or an empty string to not save a copy at all. The permission accountsRead is required to use this property.

  • type ComposeDetails.priority — The priority of the message.

  • type ComposeDetails.returnReceipt — Add the Disposition-Notification-To header to the message to requests the recipients email client to send a reply once the message has been received. Recipient server may strip the header and the recipient might ignore the request.

  • type ComposeDictionaries — A dictionary object with entries for all installed dictionaries, having a language identifier as key (for example en-US) and a boolean expression as value, indicating whether that dictionary is enabled for spellchecking or not.

  • type CustomHeader — A custom header definition.

  • type FileAttachment — Object used to add, update or rename an attachment in a message being composed.

cookies

api cookies
  • type Cookie.partitionKey — The cookie’s storage partition, if any. null if not partitioned.

downloads

api downloads

messageDisplay

  • function open — Opens a message in a new tab or in a new window.

messages

api messages
  • function createTag — Creates a new message tag. Tagging a message will store the tag’s key in the user’s message. Throws if the specified tag key is used already.

  • function deleteTag — Deletes a message tag, removing it from the list of known tags. Its key will not be removed from tagged messages, but they will appear untagged. Recreating a deleted tag, will make all former tagged messages appear tagged again.

  • function updateTag — Updates a message tag. Throws if the specified tag key does not exist.

  • type MessageAttachment — Represents an attachment in a message.

  • type MessageHeader.headersOnly — Some account types (for example pop3) allow to download only the headers of the message, but not its body. The body of such messages will not be available.

privacy.network

  • setting globalPrivacyControl — Allow users to query the status of ‘Global Privacy Control’. This setting’s value is of type boolean, defaulting to false.

runtime

api runtime
  • function getFrameId — Get the frameId of any window global or frame element.

  • event onSuspend — Sent to the event page just before it is unloaded. This gives the extension opportunity to do some clean up. Note that since the page is unloading, any asynchronous operations started while handling this event are not guaranteed to complete. If more activity for the event page occurs before it gets unloaded the onSuspendCanceled event will be sent and the page won’t be unloaded.

  • event onSuspendCanceled — Sent after onSuspend to indicate that the app won’t be unloaded after all.

scripting

api scripting

Use the scripting API to execute script in different contexts.

spacesToolbar

The spacesToolbar API allows to manage built-in and custom spaces, and to add buttons for custom spaces to Thunderbird’s spaces toolbar.

storage

api storage
  • type StorageArea.onChanged — Fired when one or more items change.

theme

api theme