Skip to content

Commit

Permalink
add messages.abortList() and new features for messages.query()
Browse files Browse the repository at this point in the history
  • Loading branch information
jobisoft committed Oct 23, 2023
1 parent 264393c commit 6e88bbd
Showing 1 changed file with 49 additions and 3 deletions.
52 changes: 49 additions & 3 deletions messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,29 @@ Returns the next chunk of messages in a list. See :doc:`how-to/messageLists` for

.. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

.. api-header::
:label: Required permissions

- :permission:`messagesRead`

.. _messages.abortList:

abortList(messageListId)
------------------------

.. api-section-annotation-hack::

Finalizes the specified list and terminates any process currently still adding messages.

.. api-header::
:label: Parameters


.. api-member::
:name: ``messageListId``
:type: (string)


.. api-header::
:label: Required permissions

Expand Down Expand Up @@ -403,6 +426,13 @@ Gets all messages that have the specified properties, or all messages if no prop
Returns only messages with this value matching the author. The search value is a single email address, a name or a combination (e.g.: :value:`Name <user@domain.org>`). The address part of the search value (if provided) must match the author's address completely. The name part of the search value (if provided) must match the author's name partially. All matches are done case-insensitive.


.. api-member::
:name: [``autoPaginationTimeout``]
:type: (integer, optional)

Set the timeout in ms after which results should be returned, even if the nominal number of messages-per-page has not yet been reached. Defaults to :value:`1000` ms. Setting it to :value:`0` will disable auto-pagination.


.. api-member::
:name: [``body``]
:type: (string, optional)
Expand Down Expand Up @@ -461,13 +491,27 @@ Gets all messages that have the specified properties, or all messages if no prop
Search the folder specified by ``queryInfo.folder`` recursively.


.. api-member::
:name: [``messagesPerPage``]
:type: (integer, optional)

Set the nominal number of messages-per-page for this query. Defaults to :value:`100` messages.


.. api-member::
:name: [``recipients``]
:type: (string, optional)

Returns only messages whose recipients match all specified addresses. The search value is a semicolon separated list of email addresses, names or combinations (e.g.: :value:`Name <user@domain.org>`). For a match, all specified addresses must equal a recipient's address completely and all specified names must match a recipient's name partially. All matches are done case-insensitive.


.. api-member::
:name: [``returnMessageListId``]
:type: (boolean, optional)

The *messageListId* is usually returned together with the first page, after some messages have been found. Enabling this option will change the return value of this function and return the *messageListId* directly.


.. api-member::
:name: [``subject``]
:type: (string, optional)
Expand Down Expand Up @@ -510,7 +554,7 @@ Gets all messages that have the specified properties, or all messages if no prop


.. api-member::
:type: :ref:`messages.MessageList`
:type: :ref:`messages.MessageList` or string


.. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
Expand Down Expand Up @@ -768,7 +812,7 @@ Creates a new message tag. Tagging a message will store the tag's key in the use
:name: ``key``
:type: (string)

Unique tag identifier (must use only alphanumeric characters).
Unique tag identifier (will be converted to lower case). Must not include :value:`()<>{/%*"` or spaces.


.. api-member::
Expand Down Expand Up @@ -808,7 +852,7 @@ Updates a message tag.
:name: ``key``
:type: (string)

Unique tag identifier.
Unique tag identifier (will be converted to lower case). Must not include :value:`()<>{/%*"` or spaces.


.. api-member::
Expand Down Expand Up @@ -852,6 +896,8 @@ Deletes a message tag, removing it from the list of known tags. Its key will not
.. api-member::
:name: ``key``
:type: (string)

Unique tag identifier (will be converted to lower case). Must not include :value:`()<>{/%*"` or spaces.


.. api-header::
Expand Down

0 comments on commit 6e88bbd

Please sign in to comment.