messengerSettings API
The messengerSettings API allows to access global messenger settings.
Property: messagePlainTextFlowedOutputEnabled
Whether long lines in outgoing plain text messages will get soft line breaks ( \n) or hard line breaks (\n), to comply with requirements from RFC 2822. Soft line breaks will be ignored when displayed by the receiving client. When flowed output is enabled, add-ons should not create plain text messages with manually inserted hard or soft line breaks to achieve a certain text width, as that will most probably interfere with the default line break handling and generate ridged text. When flowed output is disabled, add-ons could add hard line breaks to have control over the final message, but any line longer than the maximum line length will still receive additional hard line breaks. See messageLineLengthLimit. This property is read-only.
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.
messengerSettings
Read Thunderbird settings.
Functions
clear(details)
Clears the setting, restoring any default value.
Parameters
details
Which setting to clear.
scope
Where to clear the setting (default: regular).
Required permissions
get(details)
Gets the value of a setting.
Parameters
details
Return type (Promise)
_returns
Details of the currently effective value.
levelOfControl
The level of control of the setting.
value
The value of the setting.
incognitoSpecific
Whether the effective value is specific to the incognito session.<br/>This property will only be present if the incognito property in the details parameter of get() was true.
Required permissions
set(details)
Sets the value of a setting.
Parameters
details
Which setting to change.
value
The value of the setting. <br/>Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.
scope
Where to set the setting (default: regular).
Required permissions
Events
onChange
Fired after the setting changes.
Parameters for onChange.addListener(listener)
listener(details)
A function that will be called when this event occurs.
Parameters passed to the listener function
details
levelOfControl
The level of control of the setting.
value
The value of the setting after the change.
incognitoSpecific
Whether the value that has changed is specific to the incognito session.<br/>This property will only be present if the user has enabled the extension in incognito mode.
Required permissions
Types
LevelOfControl
One of
not_controllable: cannot be controlled by any extension
controlled_by_other_extensions: controlled by extensions with higher precedence
controllable_by_this_extension: can be controlled by this extension
controlled_by_this_extension: controlled by this extension
SettingScope
The scope of the Setting. One of
regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),
regular_only: setting for the regular profile only (not inherited by the incognito profile),
incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences). Only regular is supported by Thunderbird at this time.