messageDisplay¶
The message display API first appeared in Thunderbird 70 and was backported to Thunderbird 68.2.
A message can be displayed in either a 3-pane tab, a tab of its own, or in a window of its own.
All are referenced by tabId in this API. Display windows are considered to have exactly one
tab, which has limited functionality compared to tabs from the main window.
More functions are planned for this API for adding to the user interface, as well as a message display action (similar to browserAction and composeAction).
Functions¶
getDisplayedMessage(tabId)¶
Gets the currently displayed message in the specified tab. It returns null if no messages are displayed, or if multiple messages are displayed.
Parameters
tabId
(integer)
Return type (Promise)
Required permissions
getDisplayedMessages(tabId)¶
– [Added in TB 81, backported to TB 78.4.0]
Gets an array of the currently displayed messages in the specified tab. The array is empty if no messages are displayed.
Parameters
tabId
(integer)
Return type (Promise)
array of MessageHeader
Required permissions
Events¶
onMessageDisplayed(tab, message)¶
Fired when a message is displayed, whether in a 3-pane tab, a message tab, or a message window.
Parameters for event listeners
- Changes in TB 76
previously just the tab’s ID
Required permissions
onMessagesDisplayed(tab, messages)¶
– [Added in TB 81, backported to TB 78.4.0]
Fired when either a single message is displayed or when multiple messages are displayed, whether in a 3-pane tab, a message tab, or a message window.
Required permissions