≡ privacy.network API

• Permissions

• Types

• Properties

≡ Add-on developer resources

• Introduction to add-on development

• "Hello world" extension tutorial

• Developer community

• Sample extensions (Github)

• Using Promises

• Additional resources on DTN

≡ Guides

• Working with WebExtension events

• Working with message lists

• Working with vCard contacts

privacy.network API

Hint

The privacy.network 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.privacy API to control usage of the features in the browser that can affect a user’s privacy.

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.

privacy

privacy

Read and modify privacy settings.

Note

The permission privacy is required to use messenger.privacy.network.*.

Types

HTTPSOnlyModeOption

The mode for https-only mode.

string

Supported values:

always

always

never

never

private_browsing

private_browsing

IPHandlingPolicy

The IP handling policy of WebRTC.

string

Supported values:

default

default

default_public_and_private_interfaces

default_public_and_private_interfaces

default_public_interface_only

default_public_interface_only

disable_non_proxied_udp

disable_non_proxied_udp

proxy_only

proxy_only

tlsVersionRestrictionConfig

An object which describes TLS minimum and maximum versions.

object

maximum

[maximum]

(string, optional)

The maximum TLS version supported.

Supported values:

TLSv1

TLSv1

TLSv1.1

TLSv1.1

TLSv1.2

TLSv1.2

TLSv1.3

TLSv1.3

unknown

unknown

minimum

[minimum]

(string, optional)

The minimum TLS version supported.

Supported values:

TLSv1

TLSv1

TLSv1.1

TLSv1.1

TLSv1.2

TLSv1.2

TLSv1.3

TLSv1.3

unknown

unknown

Properties

globalPrivacyControl

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

httpsOnlyMode

Allow users to query the mode for ‘HTTPS-Only Mode’. This setting’s value is of type HTTPSOnlyModeOption, defaulting to never.

networkPredictionEnabled

If enabled, the browser attempts to speed up your web browsing experience by pre-resolving DNS entries, prerendering sites (<link rel=’prefetch’ …>), and preemptively opening TCP and SSL connections to servers. This preference’s value is a boolean, defaulting to true.

peerConnectionEnabled

Allow users to enable and disable RTCPeerConnections (aka WebRTC).

tlsVersionRestriction

This property controls the minimum and maximum TLS versions. This setting’s value is an object of tlsVersionRestrictionConfig.

webRTCIPHandlingPolicy

Allow users to specify the media performance/privacy tradeoffs which impacts how WebRTC traffic will be routed and how much local address information is exposed. This preference’s value is of type IPHandlingPolicy, defaulting to default.

Note

Starting in Thunderbird 70, a value of disable_non_proxied_udp requires a proxy if one is configured, but allows connections to go through if no proxy is set up. Previously, in this mode WebRTC could only be used if a proxy was configured and TURN over TCP was available; this behavior is now exposed as proxy_only.