browserSettings API

Hint

The browserSettings API is inherited from Firefox, and its primary documentation is maintained by Mozilla at MDN. Thunderbird implements only the subset of functions, events, and types listed here. The MDN pages may provide further details and examples, but they may also reference features that are not supported in Thunderbird.

Use the browser.browserSettings API to control global settings of the browser.

Permissions

The following permissions influence the behavior of the API. Depending on which permissions are requested, additional methods might be available, or certain data may be included in responses.

Hint

Request permissions only when needed. Unnecessary requests may result in rejection during ATN review.

browserSettings



Read and modify browser settings.

Note

The permission browserSettings is required to use messenger.browserSettings.*.

Types

ColorManagementMode

Color management mode.

string

Supported values:

full



off



tagged_only



ContextMenuMouseEvent

After which mouse event context menus should popup.

string

Supported values:

mousedown



mouseup



ImageAnimationBehavior

How images should be animated in the browser.

string

Supported values:

none



normal



once



Properties

allowPopupsForUserEvents

Allows or disallows pop-up windows from opening in response to user events.

cacheEnabled

Enables or disables the browser cache.

contextMenuShowEvent

Controls after which mouse event context menus popup. This setting’s value is of type ContextMenuMouseEvent, which has possible values of mouseup and mousedown.

ftpProtocolEnabled

Returns whether the FTP protocol is enabled. Read-only.

Note

From version 88, this setting is read-only (see bug 1626365).

imageAnimationBehavior

Controls the behaviour of image animation in the browser. This setting’s value is of type ImageAnimationBehavior, defaulting to normal.

overrideContentColorScheme

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

overrideDocumentColors

This setting controls whether the user-chosen colors override the page’s colors.

useDocumentFonts

This setting controls whether the document’s fonts are used.

verticalTabs

This boolean setting controls whether vertical tabs are enabled.

webNotificationsDisabled

Disables webAPI notifications.

zoomFullPage

This boolean setting controls whether zoom is applied to the full page or to text only.