Build documentation with latest features (TB 122)

thunderbird · Dec 1, 2023 · 81a3d4b · 81a3d4b
1 parent 0054628
commit 81a3d4b
Show file tree

Hide file tree

Showing 22 changed files with 57 additions and 38 deletions.
diff --git a/accounts.rst b/accounts.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
 

diff --git a/action.rst b/action.rst
@@ -10,7 +10,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
   * `"API List" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/apiList>`__

diff --git a/addressBooks.provider.rst b/addressBooks.provider.rst
@@ -7,7 +7,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/contacts`
   * :doc:`/how-to/eventListeners`

diff --git a/addressBooks.rst b/addressBooks.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/contacts`
   * :doc:`/how-to/eventListeners`

diff --git a/cloudFile.rst b/cloudFile.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
   * `"DropBox Uploader" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/dropbox>`__

diff --git a/commands.rst b/commands.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
 

diff --git a/compose.rst b/compose.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
   * `"Compose Body" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/composeBody>`__

diff --git a/composeAction.rst b/composeAction.rst
@@ -10,7 +10,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
 

diff --git a/contacts.rst b/contacts.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/contacts`
   * :doc:`/how-to/eventListeners`

diff --git a/folders.rst b/folders.rst
@@ -6,10 +6,11 @@
   * `Functions`_
   * `Events`_
   * `Types`_
+  * `Properties`_
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
 
@@ -515,10 +516,10 @@ Gets folders that match the specified properties, or all folders if no propertie
 
 
       .. api-member::
-         :name: [``mostRecent``]
-         :type: (boolean, optional)
+         :name: [``limit``]
+         :type: (integer, optional)
 
-         Whether the folder (excluding subfolders) has been used within the last month. The returned folders will be sorted by their recentness and limited to the most recent ones, which is controlled by the :value:`mail.folder_widget.max_recent` preference. A value of :value:`false` is ignored.
+         Limits the number of returned folders. If used together with :value:`recent`, supports being set to :ref:`folders.DEFAULT_MOST_RECENT_LIMIT`
 
 
       .. api-member::
@@ -539,7 +540,7 @@ Gets folders that match the specified properties, or all folders if no propertie
          :name: [``recent``]
          :type: (boolean, optional)
 
-         Whether the folder (excluding subfolders) has been used within the last month, or not. The returned folders will be sorted by their recentness. Ignored if :value:`mostRecent` is specified.
+         Whether the folder (excluding subfolders) has been used within the last month, or not. The returned folders will be sorted by their recentness.
 
 
       .. api-member::
@@ -1244,3 +1245,17 @@ RegularExpression
 
       Supported RegExp flags: :value:`i` = case insensitive, and/or one of :value:`u` = unicode support or :value:`v` = extended unicode support
 
+
+.. rst-class:: api-main-section
+
+Properties
+==========
+
+.. _folders.DEFAULT_MOST_RECENT_LIMIT:
+
+DEFAULT_MOST_RECENT_LIMIT
+-------------------------
+
+.. api-section-annotation-hack:: 
+
+The number of most recent folders used in Thunderbird's UI. Controled by the :value:`mail.folder_widget.max_recent` preference.
diff --git a/identities.rst b/identities.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
 

diff --git a/mailTabs.rst b/mailTabs.rst
@@ -8,7 +8,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
   * `"Quickfilter" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/quickfilter>`__

diff --git a/mailingLists.rst b/mailingLists.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/contacts`
   * :doc:`/how-to/eventListeners`

diff --git a/menus.rst b/menus.rst
@@ -11,7 +11,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
   * `"Quickfilter" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/quickfilter>`__

diff --git a/messageDisplay.rst b/messageDisplay.rst
@@ -7,10 +7,12 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * `"Message Display" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/messageDisplay>`__
 
+.. _messageDisplay_api:
+
 ==================
 messageDisplay API
 ==================

diff --git a/messageDisplayAction.rst b/messageDisplayAction.rst
@@ -10,7 +10,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * `"Message Display" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/messageDisplay>`__
 

diff --git a/messageDisplayScripts.rst b/messageDisplayScripts.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * `"Inline Attachment Preview" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/messageDisplayScript.pdfPreview>`__
   * `"Notification Banner" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/messageDisplayScript.pdfPreview>`__

diff --git a/messages.rst b/messages.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/messageLists`
   * :doc:`/how-to/eventListeners`
@@ -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`
@@ -763,7 +768,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::
@@ -803,7 +808,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
@@ -823,6 +828,7 @@ Marks or unmarks a message as junk, read, flagged, or tagged. Updating external
    :label: Required permissions
 
    - :permission:`messagesRead`
+   - :permission:`messagesUpdate`
 
 .. rst-class:: api-main-section
 
@@ -1348,7 +1354,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:

diff --git a/messages.tags.rst b/messages.tags.rst
@@ -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
 
@@ -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:
@@ -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:
@@ -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:
 
@@ -173,7 +170,6 @@ Updates a message tag.
 .. api-header::
    :label: Required permissions
 
-   - :permission:`messagesRead`
    - :permission:`messagesTags`
 
 .. rst-class:: api-main-section
@@ -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.
 
diff --git a/tabs.rst b/tabs.rst
@@ -10,7 +10,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
 

diff --git a/theme.rst b/theme.rst
@@ -11,7 +11,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * `Theme guide <https://developer.thunderbird.net/add-ons/web-extension-themes>`__
   * :doc:`/how-to/eventListeners`

diff --git a/windows.rst b/windows.rst
@@ -9,7 +9,7 @@
 
   .. include:: /developer-resources.rst
 
-  ≡ Other relevant information
+  ≡ Related information
 
   * :doc:`/how-to/eventListeners`
   * `"Await Popup" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/awaitPopup>`__