webext-schema 7.0.0 → 7.1.0

package/schemas/mail/mailext.json

@@ -821,7 +821,7 @@
           "properties": {
             "default_locale": {
               "type": "string",
-              "optional": "true"
+              "optional": true
             },
             "l10n_resources": {
               "type": "array",
@@ -1684,7 +1684,6 @@
             },
             "documentId": {
               "type": "string",
-              "unsupported": true,
               "optional": true,
               "description": "An UUID for the document associated with this context, or undefined if it is not hosted in a document"
             },
@@ -1769,6 +1768,11 @@
               "optional": true,
               "description": "The $(topic:frame_ids)[frame] that opened the connection. 0 for top-level frames, positive for child frames. This will only be set when <code>tab</code> is set."
             },
+            "documentId": {
+              "type": "string",
+              "optional": true,
+              "description": "A UUID of the document that opened the connection."
+            },
             "id": {
               "type": "string",
               "optional": true,
@@ -2070,6 +2074,27 @@
             "description": "The fully-qualified URL to the resource."
           }
         },
+        {
+          "name": "getDocumentId",
+          "type": "function",
+          "allowedContexts": [
+            "content",
+            "devtools"
+          ],
+          "description": "Get the documentId of any window global or frame element. Throws for invalid targets, such as unloaded frames.",
+          "parameters": [
+            {
+              "type": "any",
+              "name": "target",
+              "description": "A WindowProxy or a browsing context container Element (iframe, frame, embed, or object) for the target frame."
+            }
+          ],
+          "allowCrossOriginArguments": true,
+          "returns": {
+            "type": "string",
+            "description": "The documentId of the target document."
+          }
+        },
         {
           "name": "getFrameId",
           "type": "function",
@@ -2082,7 +2107,7 @@
             {
               "type": "any",
               "name": "target",
-              "description": "A WindowProxy or a Browsing Context container element (IFrame, Frame, Embed, Object) for the target frame."
+              "description": "A WindowProxy or a browsing context container Element (iframe, frame, embed, or object) for the target frame."
             }
           ],
           "allowCrossOriginArguments": true,
@@ -2980,7 +3005,8 @@
                     ]
                   },
                   "maxItems": 15,
-                  "optional": true
+                  "optional": true,
+                  "description": "An array of alignment values, one for each image in <var>additional_backgrounds</var>."
                 },
                 "additional_backgrounds_tiling": {
                   "type": "array",
@@ -2994,7 +3020,8 @@
                     ]
                   },
                   "maxItems": 15,
-                  "optional": true
+                  "optional": true,
+                  "description": "An array of tiling values, one for each image in <var>additional_backgrounds</var>."
                 },
                 "color_scheme": {
                   "description": "If set, overrides the general theme (context menus, toolbars, content area).",
@@ -4478,6 +4505,17 @@
             }
           ]
         },
+        {
+          "name": "onManyCreated",
+          "type": "function",
+          "description": "Fired when a large number of contacts are added. The contacts are not emitted for performance reasons. The event indicates significant changes, and consumers should rebuild any cached representation of the address book.",
+          "parameters": [
+            {
+              "name": "node",
+              "$ref": "AddressBookNode"
+            }
+          ]
+        },
         {
           "name": "onUpdated",
           "type": "function",
@@ -4845,6 +4883,7 @@
           "$extend": "WebExtensionManifest",
           "properties": {
             "action": {
+              "description": "Defines the appearance and behavior of an action button in the toolbar.",
               "min_manifest_version": 3,
               "type": "object",
               "additionalProperties": {
@@ -4950,6 +4989,7 @@
           "$extend": "WebExtensionManifest",
           "properties": {
             "browser_action": {
+              "description": "Defines the appearance and behavior of a browserAction button in the toolbar.",
               "max_manifest_version": 2,
               "type": "object",
               "additionalProperties": {
@@ -6030,6 +6070,7 @@
           "$extend": "WebExtensionManifest",
           "properties": {
             "cloud_file": {
+              "description": "Defines a cloud file provider for uploading large attachments to a remote server.",
               "type": "object",
               "additionalProperties": {
                 "$ref": "UnrecognizedProperty"
@@ -6628,7 +6669,7 @@
             "additionalFccFolderId": {
               "min_manifest_version": 3,
               "$ref": "folders.MailFolderId",
-              "description": "An additional fcc folder which can be selected while composing the message. Cleared when set to <var>null</var>. The permission <permission>accountsRead</permission> is required to use this property.",
+              "description": "An additional fcc folder which can be selected while composing the message. Cleared when set to <var>null</var>. Has no effect when the message is saved as a draft or template; the additional copy is only created when the message is actually sent or queued for sending. The permission <permission>accountsRead</permission> is required to use this property.",
               "optional": "omit-key-if-missing"
             },
             "additionalFccFolder": {
@@ -6647,7 +6688,7 @@
                   "$ref": "folders.MailFolderId"
                 }
               ],
-              "description": "An additional fcc folder which can be selected while composing the message, an empty string if not used. The permission <permission>accountsRead</permission> is required to use this property.",
+              "description": "An additional fcc folder which can be selected while composing the message, an empty string if not used. Has no effect when the message is saved as a draft or template; the additional copy is only created when the message is actually sent or queued for sending. The permission <permission>accountsRead</permission> is required to use this property.",
               "optional": true
             },
             "attachPublicPGPKey": {
@@ -7663,6 +7704,7 @@
           "$extend": "WebExtensionManifest",
           "properties": {
             "compose_action": {
+              "description": "Defines the appearance and behavior of a composeAction button in the message compose window.",
               "type": "object",
               "additionalProperties": {
                 "$ref": "UnrecognizedProperty"
@@ -8496,11 +8538,96 @@
               ]
             }
           ]
+        },
+        {
+          "id": "ComposeScript",
+          "type": "object",
+          "description": "A script and/or CSS to inject into compose windows via the manifest.",
+          "properties": {
+            "js": {
+              "type": "array",
+              "optional": true,
+              "description": "The list of JavaScript files to inject.",
+              "items": {
+                "$ref": "ExtensionURL"
+              }
+            },
+            "css": {
+              "type": "array",
+              "optional": true,
+              "description": "The list of CSS files to inject.",
+              "items": {
+                "$ref": "ExtensionURL"
+              }
+            }
+          },
+          "additionalProperties": {
+            "$ref": "UnrecognizedProperty"
+          }
+        },
+        {
+          "id": "MessageDisplayScript",
+          "type": "object",
+          "description": "A script and/or CSS to inject into message display pages via the manifest.",
+          "properties": {
+            "js": {
+              "type": "array",
+              "optional": true,
+              "description": "The list of JavaScript files to inject.",
+              "items": {
+                "$ref": "ExtensionURL"
+              }
+            },
+            "css": {
+              "type": "array",
+              "optional": true,
+              "description": "The list of CSS files to inject.",
+              "items": {
+                "$ref": "ExtensionURL"
+              }
+            },
+            "run_at": {
+              "type": "string",
+              "optional": true,
+              "default": "document_idle",
+              "enum": [
+                "document_start",
+                "document_end",
+                "document_idle"
+              ],
+              "description": "Determines when the files specified in css and js are injected. The states directly correspond to <code>Document.readyState</code>: <var>loading</var>, <var>interactive</var> and <var>complete</var>."
+            }
+          },
+          "additionalProperties": {
+            "$ref": "UnrecognizedProperty"
+          }
+        },
+        {
+          "$extend": "WebExtensionManifest",
+          "properties": {
+            "compose_scripts": {
+              "type": "array",
+              "optional": true,
+              "description": "Scripts and CSS to inject into compose windows.",
+              "items": {
+                "$ref": "ComposeScript"
+              }
+            },
+            "message_display_scripts": {
+              "type": "array",
+              "optional": true,
+              "description": "Scripts and CSS to inject into message display pages.",
+              "items": {
+                "$ref": "MessageDisplayScript"
+              }
+            }
+          }
         }
       ]
     },
     {
       "namespace": "composeScripts",
+      "description": "The composeScripts API allows to register and unregister scripts for the message compose window.",
       "permissions": [
         "compose"
       ],
@@ -8561,6 +8688,7 @@
     },
     {
       "namespace": "messageDisplayScripts",
+      "description": "The messageDisplayScripts API allows to register and unregister scripts for the message display window.",
       "permissions": [
         "messagesModify"
       ],
@@ -12251,6 +12379,7 @@
           "$extend": "WebExtensionManifest",
           "properties": {
             "message_display_action": {
+              "description": "Defines the appearance and behavior of a messageDisplayAction button in the message display window.",
               "type": "object",
               "additionalProperties": {
                 "$ref": "UnrecognizedProperty"
@@ -13077,16 +13206,28 @@
               "enum": [
                 "messagesDelete",
                 "messagesImport",
+                "messagesModifyPermanent",
                 "messagesMove",
                 "messagesRead",
+                "messages.save",
                 "messagesTags",
                 "messagesTagsList",
                 "messagesUpdate",
-                "messagesModifyPermanent",
                 "sensitiveDataUpload"
               ]
             }
           ]
+        },
+        {
+          "$extend": "OptionalOnlyPermission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "messages.send"
+              ]
+            }
+          ]
         }
       ]
     },
@@ -13352,6 +13493,18 @@
             }
           }
         },
+        {
+          "id": "AttachmentType",
+          "type": "string",
+          "enum": [
+            "normal",
+            "detached",
+            "deleted",
+            "linked",
+            "cloudFile"
+          ],
+          "description": "The type of an attachment in a message."
+        },
         {
           "id": "MessageAttachment",
           "type": "object",
@@ -13365,13 +13518,17 @@
               "type": "string",
               "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."
             },
+            "type": {
+              "$ref": "messages.AttachmentType",
+              "description": "The type of this attachment."
+            },
             "headers": {
               "$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",
-              "description": "The name, as displayed to the user, of this attachment. This is usually but not always the filename of the attached file."
+              "description": "The name, as displayed to the user, of this attachment. This is usually but not always the filename of the attached file. For a <var>cloudFile</var> attachment, this is the real name of the linked file, when the message provides one."
             },
             "partName": {
               "type": "string",
@@ -13381,6 +13538,16 @@
               "type": "integer",
               "description": "The size in bytes of this attachment."
             },
+            "linkUrl": {
+              "type": "string",
+              "optional": true,
+              "description": "The remote location the attachment's content is linked to. Present for <var>linked</var> attachments (see $(ref:messages.AttachmentType)), whose content is not part of the message and can be fetched from this url."
+            },
+            "cloudFileUrl": {
+              "type": "string",
+              "optional": true,
+              "description": "The remote location a <var>cloudFile</var> attachment's content is stored at. Present for <var>cloudFile</var> attachments (see $(ref:messages.AttachmentType)), whose content is not part of the message."
+            },
             "contentId": {
               "type": "string",
               "optional": true,
@@ -13420,6 +13587,176 @@
               "description": "The maximum value required to match the query."
             }
           }
+        },
+        {
+          "id": "NewMessageDetails",
+          "type": "object",
+          "description": "Details of a message to be sent.",
+          "additionalProperties": true,
+          "properties": {
+            "identityId": {
+              "type": "string",
+              "description": "The ID of an identity from the :doc:`accounts` API. Defaults to the default identity. The permission <permission>accountsRead</permission> is required to include the ``identityId``.",
+              "optional": true
+            },
+            "from": {
+              "$ref": "compose.ComposeRecipient",
+              "description": "*Caution*: Setting a value for ``from`` does not change the used identity, it overrides the FROM header. Many email servers do not accept emails where the FROM header does not match the sender identity. Must be set to exactly one valid email address.",
+              "optional": true
+            },
+            "to": {
+              "$ref": "compose.ComposeRecipientList",
+              "optional": true
+            },
+            "cc": {
+              "$ref": "compose.ComposeRecipientList",
+              "optional": true
+            },
+            "bcc": {
+              "$ref": "compose.ComposeRecipientList",
+              "optional": true
+            },
+            "overrideDefaultFccFolder": {
+              "choices": [
+                {
+                  "$ref": "folders.MailFolder"
+                },
+                {
+                  "type": "string",
+                  "enum": [
+                    ""
+                  ]
+                }
+              ],
+              "optional": true,
+              "description": " This value overrides the default fcc setting (defined by the used identity) for this message. 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."
+            },
+            "additionalFccFolder": {
+              "choices": [
+                {
+                  "$ref": "folders.MailFolder"
+                },
+                {
+                  "type": "string",
+                  "enum": [
+                    ""
+                  ]
+                }
+              ],
+              "description": "An additional fcc folder. Only effective for send operations ($(ref:messages.sendMessage)), has no effect for save operations ($(ref:messages.saveMessage)), which only ever store the message in the primary draft or template folder. For compatibility with :ref:`compose.ComposeDetails`, setting an empty string is supported as well, but has no effect.",
+              "optional": true
+            },
+            "replyTo": {
+              "$ref": "compose.ComposeRecipientList",
+              "optional": true
+            },
+            "followupTo": {
+              "$ref": "compose.ComposeRecipientList",
+              "optional": true
+            },
+            "newsgroups": {
+              "description": "A single newsgroup name or an array of newsgroup names.",
+              "choices": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ],
+              "optional": true
+            },
+            "subject": {
+              "type": "string"
+            },
+            "body": {
+              "type": "string",
+              "description": "The HTML content for the message.",
+              "optional": true
+            },
+            "plainTextBody": {
+              "type": "string",
+              "description": "The content for a plain text message. A specified <value>body</value> will be preferred, except when <value>isPlainText</value> is specified as well.",
+              "optional": true
+            },
+            "isPlainText": {
+              "type": "boolean",
+              "description": "Whether the message should be sent as plain text or as HTML. Prefers a specified <value>plainTextBody</value> over a specified <value>body</value>.",
+              "optional": true
+            },
+            "deliveryFormat": {
+              "type": "string",
+              "enum": [
+                "auto",
+                "plaintext",
+                "html",
+                "both"
+              ],
+              "description": "Defines the mime format of the sent message. Defaults to <value>auto</value>, which prefers to send plain text messages, if the specified body does not include any formatting.\n**Note**: If a plain text body and an HTML body is included in the message, the plain text body is always derived from the included HTML body. It is not possible to specify two independent values via <value>body</value> and <value>plainTextBody</value>.",
+              "optional": true
+            },
+            "contentLanguage": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "The languages of the message content, used for the <em>Content-Language</em> header. Each entry is a free-form language tag (for example <var>en-US</var>). If omitted, no <em>Content-Language</em> header is added. The i18n API's <var>detectLanguage()</var> can be used to derive a value from the message body, which should be converted to plain text first (for example via $(ref:messengerUtilities.convertToPlainText)), so that markup does not influence the detection.",
+              "optional": true
+            },
+            "customHeaders": {
+              "type": "array",
+              "items": {
+                "$ref": "compose.CustomHeader"
+              },
+              "description": "Array of custom headers.",
+              "optional": true
+            },
+            "priority": {
+              "type": "string",
+              "enum": [
+                "lowest",
+                "low",
+                "normal",
+                "high",
+                "highest"
+              ],
+              "description": "The priority of the message.",
+              "optional": true
+            },
+            "returnReceipt": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Add the <em>Disposition-Notification-To</em> header to the message to requests the recipients email client to send a reply once the message has been received. Recipient server may strip the header and the recipient might ignore the request."
+            },
+            "deliveryStatusNotification": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Let the sender know when the recipient's server received the message. Not supported by all servers."
+            },
+            "attachVCard": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Wether or not the vCard of the used identity will be attached to the message during send."
+            },
+            "attachments": {
+              "type": "array",
+              "items": {
+                "choices": [
+                  {
+                    "$ref": "compose.FileAttachment"
+                  },
+                  {
+                    "$ref": "compose.ComposeAttachment"
+                  }
+                ]
+              },
+              "description": "Attachments to add to the message. **Note:** :ref:`compose.ComposeAttachments` are included as real file attachments, not as cloudFile links.",
+              "optional": true
+            }
+          }
         }
       ],
       "events": [
@@ -14500,6 +14837,126 @@
             }
           ]
         },
+        {
+          "name": "sendMessage",
+          "permissions": [
+            "messages.send"
+          ],
+          "type": "function",
+          "description": "Sends a message programmatically in the background without user interaction. If the send mode is not specified or set to <value>default</value>, the message will be sent directly if the user is online and placed in the user's outbox otherwise. The returned Promise fulfills once the message has been successfully sent or placed in the user's outbox. Throws when there has been an error while sending the message to the outgoing mail server.\n**Note:** If no <value>deliveryFormat</value> is specified, the message is sent as plain text when the body contains no HTML formatting.\n**Note:** It is possible to pass in a :ref:`compose.ComposeDetails` object as the <value>details</value> parameter, and it will be interpreted as a :ref:`messages.NewMessageDetails` object.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "details",
+              "$ref": "messages.NewMessageDetails"
+            },
+            {
+              "name": "options",
+              "type": "object",
+              "optional": true,
+              "properties": {
+                "mode": {
+                  "type": "string",
+                  "enum": [
+                    "default",
+                    "sendNow",
+                    "sendLater"
+                  ]
+                }
+              }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "name": "return",
+                  "type": "object",
+                  "properties": {
+                    "mode": {
+                      "type": "string",
+                      "description": "The used send mode.",
+                      "enum": [
+                        "sendNow",
+                        "sendLater"
+                      ]
+                    },
+                    "headerMessageId": {
+                      "type": "string",
+                      "description": "The header messageId of the outgoing message. Only included for actually sent messages.",
+                      "optional": true
+                    },
+                    "messages": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "messages.MessageHeader"
+                      },
+                      "description": "Copies of the sent message. The number of created copies depends on the applied file carbon copy configuration (fcc)."
+                    }
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "saveMessage",
+          "permissions": [
+            "messages.save"
+          ],
+          "type": "function",
+          "description": "Saves a message programmatically as a draft or as a template in the background without user interaction. The save mode defaults to <value>draft</value>. The returned Promise fulfills once the message has been successfully saved. Throws when there has been an error while saving the message.\n**Note:** If no <value>deliveryFormat</value> is specified, the message is saved as plain text when the body contains no HTML formatting.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "details",
+              "$ref": "NewMessageDetails"
+            },
+            {
+              "name": "options",
+              "type": "object",
+              "optional": true,
+              "properties": {
+                "mode": {
+                  "type": "string",
+                  "enum": [
+                    "draft",
+                    "template"
+                  ]
+                }
+              }
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "name": "return",
+                  "type": "object",
+                  "properties": {
+                    "mode": {
+                      "type": "string",
+                      "description": "The used save mode.",
+                      "enum": [
+                        "draft",
+                        "template"
+                      ]
+                    },
+                    "messages": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "messages.MessageHeader"
+                      },
+                      "description": "The saved message(s). The number of saved messages depends on the applied file carbon copy configuration (fcc)."
+                    }
+                  }
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "archive",
           "type": "function",
@@ -14784,6 +15241,32 @@
             }
           ]
         },
+        {
+          "name": "get",
+          "type": "function",
+          "description": "Returns a message tag identified by its key.",
+          "async": "callback",
+          "permissions": [
+            "messagesTagsList"
+          ],
+          "parameters": [
+            {
+              "type": "string",
+              "name": "key",
+              "description": "The key of the message tag to retrieve."
+            },
+            {
+              "type": "function",
+              "name": "callback",
+              "optional": true,
+              "parameters": [
+                {
+                  "$ref": "messages.tags.MessageTag"
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "create",
           "type": "function",
@@ -14889,6 +15372,10 @@
         "messengerSettings"
       ],
       "properties": {
+        "composeInlineSpellCheckEnabled": {
+          "$ref": "types.Setting",
+          "description": "Whether the inline (real-time) spell checker is enabled in the message compose window."
+        },
         "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."
@@ -15175,7 +15662,7 @@
           "$extend": "WebExtensionManifest",
           "properties": {
             "oauth_provider": {
-              "description": "Describes an OAuth authentication provider for Thunderbird to use when connecting to mail/address book/calendar services. You will need to have a client ID registered with the provider to use this API.",
+              "description": "Describes an OAuth authentication provider for Thunderbird. You will need to have a client ID registered with the provider to use this API.",
               "type": "object",
               "properties": {
                 "issuer": {
@@ -15191,6 +15678,11 @@
                   "type": "string",
                   "optional": true
                 },
+                "issuerIdentifier": {
+                  "description": "The OAuth authorization server issuer identifier, as defined by RFC 9207. If provided, it <em>must</em> be an exact string match to what the provider gives in the iss field.",
+                  "type": "string",
+                  "optional": true
+                },
                 "authorizationEndpoint": {
                   "description": "OAuth authorization endpoint address.",
                   "type": "string",
@@ -15203,14 +15695,18 @@
                 },
                 "redirectionEndpoint": {
                   "description": "OAuth redirection endpoint.",
-                  "type": "string",
-                  "format": "url"
+                  "type": "string"
                 },
                 "usePKCE": {
                   "description": "If the authorization uses PKCE.",
                   "type": "boolean",
                   "optional": true
                 },
+                "useExternalBrowser": {
+                  "description": "If the login flow should use the system web browser. If true, the redirectionEndpoint <em>must</em> be a loopback address, so an origin of http://127.0.0.1 or http://localhost.",
+                  "type": "boolean",
+                  "optional": true
+                },
                 "hostnames": {
                   "description": "One or more hostnames which use this OAuth provider.",
                   "type": "array",
@@ -16019,6 +16515,12 @@
               "optional": true,
               "minimum": -1,
               "description": "The ID of the group that the tab belongs to. -1 if the tab does not belong to a tab group."
+            },
+            "splitViewId": {
+              "type": "integer",
+              "optional": true,
+              "minimum": -1,
+              "description": "The ID of the Split View that the tab belongs to. -1 if the tab does not belong to a split view."
             }
           }
         },
@@ -16182,6 +16684,11 @@
                   "optional": true,
                   "minimum": 0,
                   "description": "Open a port to a specific frame identified by <var>frameId</var> instead of all frames in the tab."
+                },
+                "documentId": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "Open a port to a specific document identified by <var>documentId</var> instead of all frames in the tab."
                 }
               },
               "optional": true
@@ -16216,6 +16723,11 @@
                   "optional": true,
                   "minimum": 0,
                   "description": "Send a message to a specific frame identified by <var>frameId</var> instead of all frames in the tab."
+                },
+                "documentId": {
+                  "type": "string",
+                  "optional": true,
+                  "description": "Send a message to a specific document identified by <var>documentId</var> instead of all frames in the tab."
                 }
               },
               "optional": true