Skip to content

Commit

Permalink
Use MessageId type
Browse files Browse the repository at this point in the history
  • Loading branch information
jobisoft committed Dec 6, 2023
1 parent bd8b8bb commit b3dff71
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 18 deletions.
8 changes: 4 additions & 4 deletions compose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Open a new message compose window forwarding a given message.

.. api-member::
:name: ``messageId``
:type: (integer)
:type: (:ref:`messages.MessageId`)

The message to forward, as retrieved using other APIs.

Expand Down Expand Up @@ -165,7 +165,7 @@ Open a new message compose window.

.. api-member::
:name: [``messageId``]
:type: (integer, optional)
:type: (:ref:`messages.MessageId`, optional)
:annotation: -- [Added in TB 84, backported to TB 78.7.0]

If specified, the message or template to edit as a new message.
Expand Down Expand Up @@ -208,7 +208,7 @@ Open a new message compose window replying to a given message.

.. api-member::
:name: ``messageId``
:type: (integer)
:type: (:ref:`messages.MessageId`)

The message to reply to, as retrieved using other APIs.

Expand Down Expand Up @@ -1418,7 +1418,7 @@ OR
:name: ``id``
:type: (string)

The ID of a contact or mailing list from the :doc:`contacts` and :doc:`mailingLists`.
The ID of a contact or mailing list from the :doc:`contacts` and :doc:`mailingLists` APIs.


.. api-member::
Expand Down
2 changes: 1 addition & 1 deletion mailTabs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ Selects none, one or multiple messages.

.. api-member::
:name: ``messageIds``
:type: (array of integer)
:type: (array of :ref:`messages.MessageId`)

The IDs of the messages, which should be selected. The mail tab will switch to the folder of the selected messages. Throws if they belong to different folders. Array can be empty to deselect any currently selected message.

Expand Down
2 changes: 1 addition & 1 deletion messageDisplay.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Opens a message in a new tab or in a new window.

.. api-member::
:name: [``messageId``]
:type: (integer, optional)
:type: (:ref:`messages.MessageId`, optional)

The id of a message to be opened. Will throw an *ExtensionError*, if the provided ``messageId`` is unknown or invalid.

Expand Down
36 changes: 24 additions & 12 deletions messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Archives messages using the current settings. Archiving external messages will t

.. api-member::
:name: ``messageIds``
:type: (array of integer)
:type: (array of :ref:`messages.MessageId`)

The IDs of the messages to archive.

Expand All @@ -124,7 +124,7 @@ Copies messages to a specified folder.

.. api-member::
:name: ``messageIds``
:type: (array of integer)
:type: (array of :ref:`messages.MessageId`)

The IDs of the messages to copy.

Expand Down Expand Up @@ -163,7 +163,7 @@ Deletes messages permanently, or moves them to the trash folder (honoring the ac

.. api-member::
:name: ``messageIds``
:type: (array of integer)
:type: (array of :ref:`messages.MessageId`)

The IDs of the messages to delete.

Expand Down Expand Up @@ -196,7 +196,7 @@ Returns the specified message.

.. api-member::
:name: ``messageId``
:type: (integer)
:type: (:ref:`messages.MessageId`)


.. api-header::
Expand Down Expand Up @@ -229,7 +229,7 @@ Returns the specified message, including all headers and MIME parts. Throws if t

.. api-member::
:name: ``messageId``
:type: (integer)
:type: (:ref:`messages.MessageId`)


.. api-header::
Expand Down Expand Up @@ -262,7 +262,7 @@ Returns the unmodified source of a message. Throws if the message could not be r

.. api-member::
:name: ``messageId``
:type: (integer)
:type: (:ref:`messages.MessageId`)


.. api-member::
Expand Down Expand Up @@ -403,7 +403,7 @@ Moves messages to a specified folder. If the messages cannot be removed from the

.. api-member::
:name: ``messageIds``
:type: (array of integer)
:type: (array of :ref:`messages.MessageId`)

The IDs of the messages to move.

Expand Down Expand Up @@ -649,7 +649,7 @@ Updates message properties and tags. Updating external messages will throw an *E

.. api-member::
:name: ``messageId``
:type: (integer)
:type: (:ref:`messages.MessageId`)


.. api-member::
Expand Down Expand Up @@ -734,7 +734,7 @@ Gets the content of a :ref:`messages.MessageAttachment` as a `File <https://deve

.. api-member::
:name: ``messageId``
:type: (integer)
:type: (:ref:`messages.MessageId`)


.. api-member::
Expand Down Expand Up @@ -777,7 +777,7 @@ Lists the attachments of a message.

.. api-member::
:name: ``messageId``
:type: (integer)
:type: (:ref:`messages.MessageId`)


.. api-header::
Expand Down Expand Up @@ -810,7 +810,7 @@ Opens the specified attachment

.. api-member::
:name: ``messageId``
:type: (integer)
:type: (:ref:`messages.MessageId`)


.. api-member::
Expand Down Expand Up @@ -1155,7 +1155,7 @@ Basic information about a message.

.. api-member::
:name: ``id``
:type: (integer)
:type: (:ref:`messages.MessageId`)


.. api-member::
Expand Down Expand Up @@ -1225,6 +1225,18 @@ Basic information about a message.
Whether the message has been marked as read. Not available for external or attached messages.


.. _messages.MessageId:

MessageId
---------

.. api-section-annotation-hack::

A unique id representing a :ref:`messages.MessageHeader` and the associated message. This id doesn’t refer to the Message-ID email header. It is an internal tracking number that does not remain after a restart. Nor does it follow an email that has been moved to a different folder.

.. api-header::
:label: integer

.. _messages.MessageList:

MessageList
Expand Down

0 comments on commit b3dff71

Please sign in to comment.