webext-schema 6.0.0 → 7.0.0

package/schemas/mail/mailext.json

@@ -2653,7 +2653,7 @@
             },
             {
               "type": "array",
-              "description": "An RGBA array of 3 integers and a fractional (a float between 0 and 1). For example <var>[220, 20, 60, 0.5]<var> for the color *crimson* with 50% opacity.",
+              "description": "An RGBA array of 3 integers and a fractional (a float between 0 and 1). For example <var>[220, 20, 60, 0.5]</var> for the color *crimson* with 50% opacity.",
               "minItems": 4,
               "maxItems": 4,
               "items": {
@@ -3001,9 +3001,10 @@
                   "optional": true,
                   "type": "string",
                   "enum": [
+                    "auto",
                     "light",
                     "dark",
-                    "auto"
+                    "system"
                   ]
                 },
                 "content_color_scheme": {
@@ -3011,9 +3012,10 @@
                   "optional": true,
                   "type": "string",
                   "enum": [
+                    "auto",
                     "light",
                     "dark",
-                    "auto"
+                    "system"
                   ]
                 }
               },
@@ -4018,45 +4020,85 @@
       "types": [
         {
           "id": "QueryInfo",
-          "description": "Object defining a query for $(ref:contacts.quickSearch).",
-          "type": "object",
-          "properties": {
-            "parentId": {
-              "type": "string",
-              "min_manifest_version": 3,
-              "optional": true,
-              "description": "The id of the address book to search. If not specified, all address books are searched."
-            },
-            "searchString": {
-              "type": "string",
-              "optional": true,
-              "description": "One or more space-separated terms to search for in predefined contact fields (defined by the preference <var>mail.addr_book.quicksearchquery.format</var>)."
-            },
-            "includeLocal": {
-              "type": "boolean",
-              "optional": true,
-              "default": true,
-              "description": "Whether to include results from local address books. Defaults to <var>true</var>."
-            },
-            "includeRemote": {
-              "type": "boolean",
-              "optional": true,
-              "default": true,
-              "description": "Whether to include results from remote address books. Defaults to <var>true</var>."
-            },
-            "includeReadOnly": {
-              "type": "boolean",
-              "optional": true,
-              "default": true,
-              "description": "Whether to include results from read-only address books. Defaults to <var>true</var>."
+          "choices": [
+            {
+              "max_manifest_version": 2,
+              "description": "Object defining a query for $(ref:contacts.quickSearch).",
+              "type": "object",
+              "properties": {
+                "searchString": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "One or more space-separated terms to search for in predefined contact fields (defined by the preference <var>mail.addr_book.quicksearchquery.format</var>)."
+                },
+                "includeLocal": {
+                  "type": "boolean",
+                  "optional": true,
+                  "default": true,
+                  "description": "Whether to include results from local address books. Defaults to <var>true</var>."
+                },
+                "includeRemote": {
+                  "type": "boolean",
+                  "optional": true,
+                  "default": true,
+                  "description": "Whether to include results from remote address books. Defaults to <var>true</var>."
+                },
+                "includeReadOnly": {
+                  "type": "boolean",
+                  "optional": true,
+                  "default": true,
+                  "description": "Whether to include results from read-only address books. Defaults to <var>true</var>."
+                },
+                "includeReadWrite": {
+                  "type": "boolean",
+                  "optional": true,
+                  "default": true,
+                  "description": "Whether to include results from read-write address books. Defaults to <var>true</var>."
+                }
+              }
             },
-            "includeReadWrite": {
-              "type": "boolean",
-              "optional": true,
-              "default": true,
-              "description": "Whether to include results from read-write address books. Defaults to <var>true</var>."
+            {
+              "min_manifest_version": 3,
+              "description": "Object defining a query for $(ref:contacts.query).",
+              "type": "object",
+              "properties": {
+                "parentId": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "The id of the address book to search. If not specified, all address books are searched."
+                },
+                "searchString": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "One or more space-separated terms to search for in predefined contact fields (defined by the preference <var>mail.addr_book.quicksearchquery.format</var>)."
+                },
+                "includeLocal": {
+                  "type": "boolean",
+                  "optional": true,
+                  "default": true,
+                  "description": "Whether to include results from local address books. Defaults to <var>true</var>."
+                },
+                "includeRemote": {
+                  "type": "boolean",
+                  "optional": true,
+                  "default": true,
+                  "description": "Whether to include results from remote address books. Defaults to <var>true</var>."
+                },
+                "includeReadOnly": {
+                  "type": "boolean",
+                  "optional": true,
+                  "default": true,
+                  "description": "Whether to include results from read-only address books. Defaults to <var>true</var>."
+                },
+                "includeReadWrite": {
+                  "type": "boolean",
+                  "optional": true,
+                  "default": true,
+                  "description": "Whether to include results from read-write address books. Defaults to <var>true</var>."
+                }
+              }
             }
-          }
+          ]
         },
         {
           "id": "ContactNode",
@@ -6522,7 +6564,7 @@
           "choices": [
             {
               "type": "string",
-              "description": "A name and email address in the format <var>Name <email@example.com></var>, or just an email address."
+              "description": "A name and email address in mailbox format (<var>Name <email@example.com></var>), or just an email address. Mailing lists are specified as <var>ListName <ListName></var>. Use $(ref:messengerUtilities.parseMailboxString) to extract the name and/or the email from the mailbox string, or to expand mailing list entries."
             },
             {
               "type": "object",
@@ -6535,7 +6577,7 @@
                 "nodeId": {
                   "type": "string",
                   "min_manifest_version": 3,
-                  "description": "The ID of a contact or mailing list node from the $(doc:addressBook.contacts) or $(doc:addressBook.mailingLists)."
+                  "description": "The ID of a contact or mailing list node from the $(doc:addressBooks.contacts) or $(doc:addressBooks.mailingLists)."
                 },
                 "type": {
                   "type": "string",
@@ -6744,12 +6786,12 @@
                 }
               ],
               "optional": true,
-              "description": " This value overrides the default fcc setting (defined by the used identity) for this message only. Either a $(ref:folders.MailFolder) specifying the folder for the copy of the sent message, or an empty string to not save a copy at all. The permission <permission>accountsRead</permission> is required to use this property."
+              "description": "This value overrides the default fcc setting (defined by the used identity) for this message only. Either a $(ref:folders.MailFolder) specifying the folder for the copy of the sent message, or an empty string to not save a copy at all. The permission <permission>accountsRead</permission> is required to use this property."
             },
             "overrideDefaultFccFolderId": {
               "min_manifest_version": 3,
               "$ref": "folders.MailFolderId",
-              "description": " This value overrides the default fcc setting (defined by the used identity) for this message only. Either a $(ref:folders.MailFolderId) specifying the folder for the copy of the sent message, or an empty string to not save a copy at all. Reset when set to <var>null</var>. The permission <permission>accountsRead</permission> is required to use this property.",
+              "description": "This value overrides the default fcc setting (defined by the used identity) for this message only. Either a $(ref:folders.MailFolderId) specifying the folder for the copy of the sent message, or an empty string to not save a copy at all. Reset when set to <var>null</var>. The permission <permission>accountsRead</permission> is required to use this property.",
               "optional": "omit-key-if-missing"
             },
             "plainTextBody": {
@@ -6770,7 +6812,7 @@
               "optional": true
             },
             "relatedMessageId": {
-              "description": "The id of the original message (in case of draft, template, forward or reply). Read-only. Is <var>undefined</var> in all other cases or if the original message was opened from file.",
+              "description": "The id of the original message (in case of draft, template, forward or reply). Read-only. Is <var>undefined</var> in all other cases or if the original message was opened from file. The <permission>messagesRead</permission> permission is required to use this property.",
               "$ref": "messages.MessageId",
               "optional": true
             },
@@ -6953,7 +6995,8 @@
           "parameters": [
             {
               "name": "tab",
-              "$ref": "tabs.Tab"
+              "$ref": "tabs.Tab",
+              "description": "The tab of the associated compose window. By the time the event listener is called, this window may have already been destroyed."
             },
             {
               "name": "sendInfo",
@@ -6982,7 +7025,11 @@
                   "items": {
                     "$ref": "messages.MessageHeader"
                   },
-                  "description": "Copies of the sent message. The number of created copies depends on the applied file carbon copy configuration (fcc)."
+                  "description": "Copies of the sent message. The number of created copies depends on the applied file carbon copy configuration (fcc). The <permission>messagesRead</permission> permission is required for this property to be included."
+                },
+                "details": {
+                  "$ref": "ComposeDetails",
+                  "description": "The $(ref:compose.ComposeDetails) of the send message."
                 }
               }
             }
@@ -7023,7 +7070,11 @@
                   "items": {
                     "$ref": "messages.MessageHeader"
                   },
-                  "description": "An array with exactly one element, the saved message."
+                  "description": "An array with exactly one element, the saved message. The <permission>messagesRead</permission> permission is required for this property to be included."
+                },
+                "details": {
+                  "$ref": "ComposeDetails",
+                  "description": "The $(ref:compose.ComposeDetails) of the saved message."
                 }
               }
             }
@@ -9918,7 +9969,7 @@
             {
               "name": "key",
               "type": "string",
-              "description": "The tag key of the requested folder. See $(ref:messages.tags.list()) for the available tags. Throws when specifying an invalid tag key."
+              "description": "The tag key of the requested folder. See $(ref:messages.tags.list) for the available tags. Throws when specifying an invalid tag key."
             },
             {
               "type": "function",
@@ -10855,7 +10906,7 @@
         {
           "name": "getListedMessages",
           "type": "function",
-          "description": "Lists the messages in the current view, honoring sort order and filters.",
+          "description": "Lists the messages in the current view, honoring sort order and filters as used in the UI. Sort order of the returned messages can be overridden via the <var>options</var> parameter",
           "permissions": [
             "messagesRead"
           ],
@@ -10868,6 +10919,40 @@
               "optional": true,
               "minimum": 1
             },
+            {
+              "name": "options",
+              "type": "object",
+              "optional": true,
+              "properties": {
+                "sortType": {
+                  "type": "string",
+                  "description": "Specifies how the returned messages should be sorted. This does not change the actual sort of the displayed messages. Default sort order is <var>descending</var>, if not specified otherwise. Returning sorted messages is faster than manually sorting the messages afterwards, but slower than returning the messages in their original order.",
+                  "optional": true,
+                  "enum": [
+                    "author",
+                    "date",
+                    "flagged",
+                    "junk",
+                    "junkScore",
+                    "priority",
+                    "read",
+                    "recipients",
+                    "size",
+                    "subject",
+                    "tags"
+                  ]
+                },
+                "sortOrder": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "The sort order for the returned messages. Ignored if <var>sortType</var> is not specified.",
+                  "enum": [
+                    "ascending",
+                    "descending"
+                  ]
+                }
+              }
+            },
             {
               "type": "function",
               "name": "callback",
@@ -13061,6 +13146,7 @@
               }
             },
             "date": {
+              "description": "The date and time when the message was sent, according to the Date header in the message.",
               "$ref": "extensionTypes.Date"
             },
             "external": {
@@ -13097,6 +13183,18 @@
               "minimum": 0,
               "maximum": 100
             },
+            "priority": {
+              "type": "string",
+              "description": "The priority of the message.",
+              "enum": [
+                "none",
+                "lowest",
+                "low",
+                "normal",
+                "high",
+                "highest"
+              ]
+            },
             "read": {
               "type": "boolean",
               "optional": true,
@@ -13180,15 +13278,9 @@
               ]
             },
             "headers": {
-              "type": "object",
+              "$ref": "messages.HeadersDictionary",
               "description": "A <em>dictionary object</em> of RFC 2047 decoded part headers as <em>key-value</em> pairs, with the header name as <em>key</em>, and an array of headers as <em>value</em>. Only present if requested, see the <var>decodeHeaders</var> option of $(ref:messages.getFull).",
-              "optional": true,
-              "additionalProperties": {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              }
+              "optional": true
             },
             "name": {
               "type": "string",
@@ -13214,15 +13306,9 @@
               "optional": true
             },
             "rawHeaders": {
-              "type": "object",
+              "$ref": "messages.HeadersDictionary",
               "description": "A <em>dictionary object</em> of raw part headers as <em>key-value</em> pairs, with the header name as <em>key</em>, and an array of headers as <em>value</em>. Only present if requested, see the <var>decodeHeaders</var> option of $(ref:messages.getFull).",
-              "optional": true,
-              "additionalProperties": {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              }
+              "optional": true
             },
             "size": {
               "type": "integer",
@@ -13280,14 +13366,8 @@
               "description": "The content type of the attachment. A value of <var>text/x-moz-deleted</var> indicates that the original attachment was permanently deleted and replaced by a placeholder text attachment with some meta information about the original attachment."
             },
             "headers": {
-              "type": "object",
-              "description": "A <em>dictionary object</em> of RFC 2047 decoded attachment headers as <em>key-value</em> pairs, with the header name as <em>key</em>, and an array of headers as <em>value</em>.",
-              "additionalProperties": {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              }
+              "$ref": "messages.HeadersDictionary",
+              "description": "A <em>dictionary object</em> of RFC 2047 decoded attachment headers as <em>key-value</em> pairs, with the header name as <em>key</em>, and an array of headers as <em>value</em>."
             },
             "name": {
               "type": "string",
@@ -13313,6 +13393,17 @@
             }
           }
         },
+        {
+          "id": "HeadersDictionary",
+          "type": "object",
+          "description": "A <em>dictionary object</em> of headers as <em>key-value</em> pairs, with the header name as <em>key</em>, and an array of headers as <em>value</em>.",
+          "additionalProperties": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
         {
           "id": "QueryRange",
           "type": "object",
@@ -13443,6 +13534,40 @@
               "name": "folderId",
               "$ref": "folders.MailFolderId"
             },
+            {
+              "name": "options",
+              "type": "object",
+              "optional": true,
+              "properties": {
+                "sortType": {
+                  "type": "string",
+                  "description": "Specifies how the returned messages should be sorted. Default sort order is <var>descending</var>, if not specified otherwise. Returning sorted messages is faster than manually sorting the messages afterwards, but slower than returning the messages in their original order.",
+                  "optional": true,
+                  "enum": [
+                    "author",
+                    "date",
+                    "flagged",
+                    "junk",
+                    "junkScore",
+                    "priority",
+                    "read",
+                    "recipients",
+                    "size",
+                    "subject",
+                    "tags"
+                  ]
+                },
+                "sortOrder": {
+                  "type": "string",
+                  "description": "The sort order for the returned messages. Ignored if <var>sortType</var> is not specified.",
+                  "optional": true,
+                  "enum": [
+                    "ascending",
+                    "descending"
+                  ]
+                }
+              }
+            },
             {
               "type": "function",
               "name": "callback",
@@ -13477,6 +13602,40 @@
                 }
               ]
             },
+            {
+              "name": "options",
+              "type": "object",
+              "optional": true,
+              "properties": {
+                "sortType": {
+                  "type": "string",
+                  "description": "Specifies how the returned messages should be sorted. Default sort order is <var>descending</var>, if not specified otherwise. Returning sorted messages is faster than manually sorting the messages afterwards, but slower than returning the messages in their original order.",
+                  "optional": true,
+                  "enum": [
+                    "author",
+                    "date",
+                    "flagged",
+                    "junk",
+                    "junkScore",
+                    "priority",
+                    "read",
+                    "recipients",
+                    "size",
+                    "subject",
+                    "tags"
+                  ]
+                },
+                "sortOrder": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "The sort order for the returned messages. Ignored if <var>sortType</var> is not specified.",
+                  "enum": [
+                    "ascending",
+                    "descending"
+                  ]
+                }
+              }
+            },
             {
               "type": "function",
               "name": "callback",
@@ -13589,6 +13748,40 @@
             }
           ]
         },
+        {
+          "name": "getHeaders",
+          "type": "function",
+          "description": "Returns all message headers of the specified message, without MIME structure parsing. Throws an error if the message cannot be read, for example due to network issues. This function is significantly faster than $(ref:messages.getFull) when only the header information is required.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "messageId",
+              "$ref": "messages.MessageId"
+            },
+            {
+              "name": "options",
+              "type": "object",
+              "properties": {
+                "decodeHeaders": {
+                  "type": "boolean",
+                  "description": "Whether to decode RFC 2047 encoded headers. Defaults to <var>true</var>.",
+                  "optional": true
+                }
+              },
+              "optional": true
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "$ref": "messages.HeadersDictionary"
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "getRaw",
           "type": "function",
@@ -13666,7 +13859,7 @@
         {
           "name": "listAttachments",
           "type": "function",
-          "description": "Lists the attachments of a message.",
+          "description": "Lists the attachments of a message. If the message is encrypted, the attachments of the decrypted message are listed.",
           "async": "callback",
           "parameters": [
             {
@@ -13691,7 +13884,7 @@
         {
           "name": "listInlineTextParts",
           "type": "function",
-          "description": "Lists all inline text parts of a message. These parts are not returned by $(ref:messages.listAttachments) and usually make up the readable content of the message, mostly with content type <var>text/plain</var> or <var>text/html</var>. If a message only includes a part with content type <var>text/html</var>, the method $(ref:messengerUtilities.convertToPlainText) can be used to retreive a plain text version.",
+          "description": "Lists all inline text parts of a message. These parts are not returned by $(ref:messages.listAttachments) and usually make up the readable content of the message, mostly with content type <var>text/plain</var> or <var>text/html</var>. If a message only includes a part with content type <var>text/html</var>, the method $(ref:messengerUtilities.convertToPlainText) can be used to retreive a plain text version. If the message is encrypted, the inline text parts of the decrypted message are listed.",
           "async": "callback",
           "parameters": [
             {
@@ -13716,7 +13909,7 @@
         {
           "name": "getAttachmentFile",
           "type": "function",
-          "description": "Gets the content of a $(ref:messages.MessageAttachment) as a $(url:dom-file)[File] object.",
+          "description": "Gets the content of a $(ref:messages.MessageAttachment) as a $(url:dom-file)[File] object. If the message is encrypted, the function retrieves the attachment from the decrypted message.",
           "async": "callback",
           "parameters": [
             {
@@ -13725,6 +13918,7 @@
             },
             {
               "name": "partName",
+              "description": "The <var>partName</var> of an attachment to be retrieved from the decrypted message.",
               "type": "string",
               "pattern": "^\\d+(\\.\\d+\\$?)*$"
             },
@@ -13745,7 +13939,7 @@
         {
           "name": "deleteAttachments",
           "type": "function",
-          "description": "Deletes the specified attachments and replaces them by placeholder text attachments with meta information about the original attachments and a <var>text/x-moz-deleted</var> content type. This permanently modifies the message.",
+          "description": "Deletes the specified attachments and replaces them by placeholder text attachments with meta information about the original attachments and a <var>text/x-moz-deleted</var> content type. This permanently modifies the message. Deleting attachments of encrypted messages is not supported and will throw an <em>ExtensionError</em>.",
           "permissions": [
             "messagesModifyPermanent"
           ],
@@ -14499,10 +14693,11 @@
             },
             "mode": {
               "type": "string",
-              "description": "Whether all of the tag filters must apply, or any of them.",
+              "description": "Whether <var>all</var> of the tag filters must apply, <var>any</var> of them, or <var>none</var>. The <var>none</var> mode ignores the provided filters and selects only messages without any tags.",
               "enum": [
                 "all",
-                "any"
+                "any",
+                "none"
               ]
             }
           }
@@ -14553,7 +14748,7 @@
           "type": "function",
           "description": "Fired when a message tag has been deleted.",
           "permissions": [
-            "accountsRead"
+            "messagesTagsList"
           ],
           "parameters": [
             {
@@ -14694,13 +14889,17 @@
         "messengerSettings"
       ],
       "properties": {
+        "messageLineLengthLimit": {
+          "$ref": "types.Setting",
+          "description": "The line length limit for outgoing messages, to comply with requirements from RFC 2822. See description of $(ref:messengerSettings.messagePlainTextFlowedOutputEnabled). This property is read-only."
+        },
         "messagePlainTextFlowedOutputEnabled": {
           "$ref": "types.Setting",
-          "description": "Whether long lines in outgoing plain text messages will get soft line breaks (<var> \n</var>) or hard line breaks (<var>\n</var>), to comply with requirements from RFC 2822. Soft line breaks will be ignored when displayed by the receiving client. When flowed output is enabled, add-ons should not create plain text messages with manually inserted hard or soft line breaks to achieve a certain text width, as that will most probably interfere with the default line break handling and generate ridged text. When flowed output is disabled, add-ons could add hard line breaks to have control over the final message, but any line longer than the maximum line length will still receive additional hard line breaks. See $(ref:messengerSettings.messageLineLengthLimit)."
+          "description": "Whether long lines in outgoing plain text messages will get soft line breaks (<var> \n</var>) or hard line breaks (<var>\n</var>), to comply with requirements from RFC 2822. Soft line breaks will be ignored when displayed by the receiving client. When flowed output is enabled, add-ons should not create plain text messages with manually inserted hard or soft line breaks to achieve a certain text width, as that will most probably interfere with the default line break handling and generate ridged text. When flowed output is disabled, add-ons could add hard line breaks to have control over the final message, but any line longer than the maximum line length will still receive additional hard line breaks. See $(ref:messengerSettings.messageLineLengthLimit). This property is read-only."
         },
-        "messageLineLengthLimit": {
+        "readerDisplayAttachmentsInline": {
           "$ref": "types.Setting",
-          "description": "The line length limit for outgoing messages, to comply with requirements from RFC 2822. See description of $(ref:messengerSettings.messagePlainTextFlowedOutputEnabled)."
+          "description": "Whether supported attachments (for example, media files) are shown inline within the body of displayed messages. This property is read-only."
         }
       }
     }
@@ -14832,10 +15031,33 @@
               "description": "The string to be parsed (e.g. <var>User <user@example.com>, other-user@example.com</var>)"
             },
             {
-              "type": "boolean",
-              "name": "preserveGroups",
+              "name": "options",
               "optional": true,
-              "description": "Keep grouped hierarchies. Groups may be specified in a mailbox string as follows: <var>GroupName : user1 <user1@example.com>, user2@example,com ;</var>."
+              "choices": [
+                {
+                  "type": "boolean",
+                  "deprecated": "Specify the options object instead of a plain boolean to preserve groups.",
+                  "description": "Keep grouped hierarchies. Groups may be specified in a mailbox string as follows: <var>GroupName : user1 <user1@example.com>, user2@example,com ;</var>."
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "preserveGroups": {
+                      "type": "boolean",
+                      "optional": true,
+                      "description": "Keep grouped hierarchies. Groups may be specified in a mailbox string as follows: <var>GroupName : user1 <user1@example.com>, user2@example,com ;</var>."
+                    },
+                    "expandMailingLists": {
+                      "type": "boolean",
+                      "optional": true,
+                      "permissions": [
+                        "addressBooks"
+                      ],
+                      "description": "Expand Thunderbird mailing lists (specified as <var>ListName <ListName></var>) and include the parsed primary email addresses of all members. When used together with <var>preserveGroups</var>, the mailing list's name and hierarchy are preserved. If the mailing list does not exist, or the <permission>addressBook</permission> permission is not granted, the entries are not expanded and returned unchanged."
+                    }
+                  }
+                }
+              ]
             },
             {
               "type": "function",
@@ -16176,7 +16398,7 @@
                 "title": {
                   "type": "string",
                   "optional": true,
-                  "description": "Match page titles against a pattern."
+                  "description": "Match page titles against a pattern. The <permission>tabs</permission> permission is required to use this property."
                 },
                 "url": {
                   "choices": [
@@ -16191,7 +16413,7 @@
                     }
                   ],
                   "optional": true,
-                  "description": "Match tabs against one or more $(url:match-patterns)[URL Patterns]. Fragment identifiers are not matched."
+                  "description": "Match tabs against one or more $(url:match-patterns)[URL Patterns]. Fragment identifiers are not matched. The <permission>tabs</permission> permission is required to use this property."
                 },
                 "windowId": {
                   "type": "integer",
@@ -16290,7 +16512,7 @@
         {
           "name": "move",
           "type": "function",
-          "description": "Moves one or more tabs to a new position within its current window, or to a different window. Tabs can only be moved to and from windows of type <var>normal</var>.",
+          "description": "Moves one or more tabs to a new position within its current window, or to a different window. Tabs can only be moved to and from windows of type <var>normal</var>. The primary mail tab cannot be moved, attempting to actively reposition it will throw an <em>ExtensionError</em>. Other tabs also cannot be placed before the primary mail tab, they will automatically be positioned after it, ensuring that the primary mail tab always remains first.",
           "async": "callback",
           "parameters": [
             {