Skip to content

Commit

Permalink
update messages and messages.tags API
Browse files Browse the repository at this point in the history
  • Loading branch information
jobisoft committed Jan 11, 2024
1 parent 07a7150 commit f464cb9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
14 changes: 10 additions & 4 deletions messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,12 @@ Permissions
.. api-member::
:name: :permission:`messagesRead`

Read your email messages and mark or tag them
Read your email messages

.. api-member::
:name: :permission:`messagesUpdate`

Change properties and tags of your email messages

.. api-member::
:name: :permission:`sensitiveDataUpload`
Expand Down Expand Up @@ -596,7 +601,7 @@ Gets all messages that have the specified properties, or all messages if no prop
:type: (:ref:`messages.tags.TagsDetail`, optional)
:annotation: -- [Added in TB 74]

Returns only messages with the specified tags. For a list of available tags, call the :ref:`messages.listTags` method.
Returns only messages with the specified tags. For a list of available tags, call the :ref:`messages.tags.list` method.


.. api-member::
Expand Down Expand Up @@ -636,7 +641,7 @@ update(messageId, newProperties)

.. api-section-annotation-hack::

Marks or unmarks a message as junk, read, flagged, or tagged. Updating external messages will throw an *ExtensionError*.
Updates message properties and tags. Updating external messages will throw an *ExtensionError*.

.. api-header::
:label: Parameters
Expand All @@ -656,6 +661,7 @@ Marks or unmarks a message as junk, read, flagged, or tagged. Updating external
:label: Required permissions

- :permission:`messagesRead`
- :permission:`messagesUpdate`

.. _messages.abortList:

Expand Down Expand Up @@ -1360,7 +1366,7 @@ Message properties used in :ref:`messages.update` and :ref:`messages.import`. Th
:name: [``tags``]
:type: (array of string, optional)

Tags associated with this message. For a list of available tags, call the listTags method.
Tags associated with this message. For a list of available tags, call the :ref:`messages.tags.list` method.


.. _messages.QueryRange:
Expand Down
14 changes: 5 additions & 9 deletions messages.tags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,10 @@ Permissions

Create, modify and delete message tags

.. rst-class:: api-permission-info

.. note::
.. api-member::
:name: :permission:`messagesTagsList`

The permission :permission:`messagesRead` is required to use ``messenger.messages.tags.*``.
List message tags

.. rst-class:: api-main-section

Expand Down Expand Up @@ -78,7 +77,6 @@ Creates a new message tag. Tagging a message will store the tag's key in the use
.. api-header::
:label: Required permissions

- :permission:`messagesRead`
- :permission:`messagesTags`

.. _messages.tags.delete:
Expand All @@ -104,7 +102,6 @@ Deletes a message tag, removing it from the list of known tags. Its key will not
.. api-header::
:label: Required permissions

- :permission:`messagesRead`
- :permission:`messagesTags`

.. _messages.tags.list:
Expand All @@ -129,7 +126,7 @@ Returns a list of tags that can be set on messages, and their human-friendly nam
.. api-header::
:label: Required permissions

- :permission:`messagesRead`
- :permission:`messagesTagsList`

.. _messages.tags.update:

Expand Down Expand Up @@ -173,7 +170,6 @@ Updates a message tag.
.. api-header::
:label: Required permissions

- :permission:`messagesRead`
- :permission:`messagesTags`

.. rst-class:: api-main-section
Expand Down Expand Up @@ -252,5 +248,5 @@ Used for filtering messages by tag in various methods. Note that functions using
:name: ``tags``
:type: (object)

A *dictionary object* with one or more filter condition as *key-value* pairs, the *key* being the tag to filter on, and the *value* being a boolean expression, requesting whether a message must include (:value:`true`) or exclude (:value:`false`) the tag. For a list of available tags, call the :ref:`messages.listTags` method.
A *dictionary object* with one or more filter condition as *key-value* pairs, the *key* being the tag to filter on, and the *value* being a boolean expression, requesting whether a message must include (:value:`true`) or exclude (:value:`false`) the tag. For a list of available tags, call the :ref:`messages.tags.list` method.

0 comments on commit f464cb9

Please sign in to comment.