Closed Bug 1688477 Opened 4 years ago Closed 4 years ago

Documentation for browser.compose.beginNew implies messageId is optional, but it is a required argument

Categories

(Thunderbird :: Add-Ons: Extensions API, defect)

Product:
Thunderbird
Component:
Add-Ons: Extensions API
Type:
defect

Tracking

(Not tracked)

Status:
RESOLVED INVALID

People

(Reporter: standard8, Unassigned)

Details

The documentation and schema say that the messageId parameter for browser.compose.beginNew is optional.

However, it is a required argument - as undefined or null - if you pass the ComposeDetails as well.

I think it would be better if the documentation made that clearer.

Summary: Documentation for browser.compose.beingNew implies messageId is optional, but it is a required argument → Documentation for browser.compose.beginNew implies messageId is optional, but it is a required argument

I cannot confirm this in 78.7.0 and Daily. Where did you observe an error?

It is true that "undefined" is passed into openComposeWindow as relatedMessageId here:

https://searchfox.org/comm-central/source/mail/components/extensions/parent/ext-compose.js#599

But openComposeWindow is always checking if relatedMessageId is defined before using it.

Status: NEW → RESOLVED
Closed: 4 years ago
Resolution: --- → INVALID
You need to log in before you can comment on or make changes to this bug.