messageDisplay API
The message display API first appeared in Thunderbird 68.
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.
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
Fired when a message is displayed, whether in a 3-pane tab, a message tab, or a message window.
Parameters for onMessageDisplayed.addListener(listener)
listener(tab, message)
A function that will be called when this event occurs.
Parameters passed to the listener function
- Changes in TB 76:
previously just the tab’s ID
Required permissions
onMessagesDisplayed
– [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.
Parameters for onMessagesDisplayed.addListener(listener)
listener(tab, messages)
A function that will be called when this event occurs.
Required permissions