compose.rst

compose

This is preliminary documentation for the message composition window API being developed in bug 1503423.

Functions

beginNew([details])

• [details] (:ref:`compose.ComposeParams`)

beginReply(messageId, [replyType])

• messageId (integer) The message to reply to
• [replyType] (string)

Values for replyType:

• replyToSender
• replyToList
• replyToAll

beginForward(messageId, [forwardType], [details])

• messageId (integer) The message to reply to
• [forwardType] (string)
• [details] (:ref:`compose.ComposeParams`)

Values for forwardType:

• forwardInline
• forwardAsAttachment

Types

ComposeParams

object

• [bcc] (array of :ref:`compose.ComposeRecipient`)
• [body] (string)
• [cc] (array of :ref:`compose.ComposeRecipient`)
• [replyTo] (string)
• [subject] (string)
• [to] (array of :ref:`compose.ComposeRecipient`)

ComposeRecipient

string: A name and email address in the format "Name <email@example.com>", or just an email address

OR

object:

• id (string) The ID of a contact or mailing list from the :doc:`contacts` and :doc:`mailingLists` APIs
• type (string) Which sort of object this ID is for

Values for type:

• contact
• mailingList