≡ messageDisplayScripts API

• Permissions

• Functions

• Types

≡ 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

messageDisplayScripts API

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.

messagesModify

messagesModify

Read and modify your email messages as they are displayed to you.

Note

The permission messagesModify is required to use messenger.messageDisplayScripts.*.

Functions

register(messageDisplayScriptOptions)

– [Added in TB 82]

Register a message display script programmatically.

Note

Registered scripts will only be applied to newly opened messages. To apply the script to already open messages, manually inject your script by calling executeScript([tabId], details) for each of the open messageDisplay tabs.

Parameters

messageDisplayScriptOptions

messageDisplayScriptOptions

(RegisteredMessageDisplayScriptOptions)

Required permissions

• messagesModify

Types

ExtensionFileOrCode

Specify code, either by pointing to a file or by providing the code directly. Only one of the two is allowed.

object

file

file

(ExtensionURL)

A URL relative to the extension’s manifest.json file, and pointing to a JavaScript file to register.

or

object

code

code

(string)

A string of JavaScript code to register.

ExtensionURL

A path relative to the root of the extension.

string

RegisteredMessageDisplayScript

– [Added in TB 82]

An object that represents a message display script registered programmatically

object

RegisteredMessageDisplayScriptOptions

– [Added in TB 82]

Details of a message display script registered programmatically

object

css

[css]

(array of ExtensionFileOrCode, optional)

The list of CSS files to inject

js

[js]

(array of ExtensionFileOrCode, optional)

The list of JavaScript files to inject

runAt

[runAt]

(string, optional)

– [Added in TB 126]

Determines when the files specified in css and js are injected. The states directly correspond to Document.readyState: loading, interactive and complete

Supported values:

document_end

document_end

document_idle

document_idle

document_start

document_start