webext-schema 7.0.0 → 7.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/node.js.yml +2 -2
- package/.prettierignore +8 -0
- package/README.md +37 -6
- package/SECURITY.md +30 -0
- package/eslint.config.mjs +27 -19
- package/index.js +9 -3
- package/modules/browser.js +81 -25
- package/modules/commander.js +8 -5
- package/modules/common.js +1 -1
- package/modules/file-util.js +23 -10
- package/modules/schema.js +21 -14
- package/modules/update.js +34 -23
- package/package.json +25 -24
- package/prettier.config.mjs +14 -0
- package/schemas/beta/webext.json +902 -204
- package/schemas/central/webext.json +902 -204
- package/schemas/mail/mailext.json +552 -17
- package/test/browser.test.js +1045 -495
- package/test/commander.test.js +7 -21
- package/test/common.test.js +7 -1
- package/test/file-util.test.js +65 -35
- package/test/index.test.js +55 -1
- package/test/schema.test.js +839 -430
- package/test/update.test.js +872 -511
- package/types/index.d.ts +8 -1
- package/types/modules/browser.d.ts +61 -61
- package/types/modules/commander.d.ts +3 -3
- package/types/modules/common.d.ts +7 -7
- package/types/modules/constant.d.ts +3 -3
- package/types/modules/file-util.d.ts +16 -16
- package/types/modules/schema.d.ts +6 -6
- package/types/modules/update.d.ts +10 -10
|
@@ -821,7 +821,7 @@
|
|
|
821
821
|
"properties": {
|
|
822
822
|
"default_locale": {
|
|
823
823
|
"type": "string",
|
|
824
|
-
"optional":
|
|
824
|
+
"optional": true
|
|
825
825
|
},
|
|
826
826
|
"l10n_resources": {
|
|
827
827
|
"type": "array",
|
|
@@ -1684,7 +1684,6 @@
|
|
|
1684
1684
|
},
|
|
1685
1685
|
"documentId": {
|
|
1686
1686
|
"type": "string",
|
|
1687
|
-
"unsupported": true,
|
|
1688
1687
|
"optional": true,
|
|
1689
1688
|
"description": "An UUID for the document associated with this context, or undefined if it is not hosted in a document"
|
|
1690
1689
|
},
|
|
@@ -1769,6 +1768,11 @@
|
|
|
1769
1768
|
"optional": true,
|
|
1770
1769
|
"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."
|
|
1771
1770
|
},
|
|
1771
|
+
"documentId": {
|
|
1772
|
+
"type": "string",
|
|
1773
|
+
"optional": true,
|
|
1774
|
+
"description": "A UUID of the document that opened the connection."
|
|
1775
|
+
},
|
|
1772
1776
|
"id": {
|
|
1773
1777
|
"type": "string",
|
|
1774
1778
|
"optional": true,
|
|
@@ -2050,6 +2054,20 @@
|
|
|
2050
2054
|
"description": "The manifest details."
|
|
2051
2055
|
}
|
|
2052
2056
|
},
|
|
2057
|
+
{
|
|
2058
|
+
"name": "getVersion",
|
|
2059
|
+
"allowedContexts": [
|
|
2060
|
+
"content",
|
|
2061
|
+
"devtools"
|
|
2062
|
+
],
|
|
2063
|
+
"description": "Returns the extension version as declared in the manifest.",
|
|
2064
|
+
"type": "function",
|
|
2065
|
+
"parameters": [],
|
|
2066
|
+
"returns": {
|
|
2067
|
+
"type": "string",
|
|
2068
|
+
"description": "The extension version."
|
|
2069
|
+
}
|
|
2070
|
+
},
|
|
2053
2071
|
{
|
|
2054
2072
|
"name": "getURL",
|
|
2055
2073
|
"type": "function",
|
|
@@ -2070,6 +2088,27 @@
|
|
|
2070
2088
|
"description": "The fully-qualified URL to the resource."
|
|
2071
2089
|
}
|
|
2072
2090
|
},
|
|
2091
|
+
{
|
|
2092
|
+
"name": "getDocumentId",
|
|
2093
|
+
"type": "function",
|
|
2094
|
+
"allowedContexts": [
|
|
2095
|
+
"content",
|
|
2096
|
+
"devtools"
|
|
2097
|
+
],
|
|
2098
|
+
"description": "Get the documentId of any window global or frame element. Throws for invalid targets, such as unloaded frames.",
|
|
2099
|
+
"parameters": [
|
|
2100
|
+
{
|
|
2101
|
+
"type": "any",
|
|
2102
|
+
"name": "target",
|
|
2103
|
+
"description": "A WindowProxy or a browsing context container Element (iframe, frame, embed, or object) for the target frame."
|
|
2104
|
+
}
|
|
2105
|
+
],
|
|
2106
|
+
"allowCrossOriginArguments": true,
|
|
2107
|
+
"returns": {
|
|
2108
|
+
"type": "string",
|
|
2109
|
+
"description": "The documentId of the target document."
|
|
2110
|
+
}
|
|
2111
|
+
},
|
|
2073
2112
|
{
|
|
2074
2113
|
"name": "getFrameId",
|
|
2075
2114
|
"type": "function",
|
|
@@ -2082,7 +2121,7 @@
|
|
|
2082
2121
|
{
|
|
2083
2122
|
"type": "any",
|
|
2084
2123
|
"name": "target",
|
|
2085
|
-
"description": "A WindowProxy or a
|
|
2124
|
+
"description": "A WindowProxy or a browsing context container Element (iframe, frame, embed, or object) for the target frame."
|
|
2086
2125
|
}
|
|
2087
2126
|
],
|
|
2088
2127
|
"allowCrossOriginArguments": true,
|
|
@@ -2980,7 +3019,8 @@
|
|
|
2980
3019
|
]
|
|
2981
3020
|
},
|
|
2982
3021
|
"maxItems": 15,
|
|
2983
|
-
"optional": true
|
|
3022
|
+
"optional": true,
|
|
3023
|
+
"description": "An array of alignment values, one for each image in <var>additional_backgrounds</var>."
|
|
2984
3024
|
},
|
|
2985
3025
|
"additional_backgrounds_tiling": {
|
|
2986
3026
|
"type": "array",
|
|
@@ -2994,7 +3034,8 @@
|
|
|
2994
3034
|
]
|
|
2995
3035
|
},
|
|
2996
3036
|
"maxItems": 15,
|
|
2997
|
-
"optional": true
|
|
3037
|
+
"optional": true,
|
|
3038
|
+
"description": "An array of tiling values, one for each image in <var>additional_backgrounds</var>."
|
|
2998
3039
|
},
|
|
2999
3040
|
"color_scheme": {
|
|
3000
3041
|
"description": "If set, overrides the general theme (context menus, toolbars, content area).",
|
|
@@ -4478,6 +4519,17 @@
|
|
|
4478
4519
|
}
|
|
4479
4520
|
]
|
|
4480
4521
|
},
|
|
4522
|
+
{
|
|
4523
|
+
"name": "onManyCreated",
|
|
4524
|
+
"type": "function",
|
|
4525
|
+
"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.",
|
|
4526
|
+
"parameters": [
|
|
4527
|
+
{
|
|
4528
|
+
"name": "node",
|
|
4529
|
+
"$ref": "AddressBookNode"
|
|
4530
|
+
}
|
|
4531
|
+
]
|
|
4532
|
+
},
|
|
4481
4533
|
{
|
|
4482
4534
|
"name": "onUpdated",
|
|
4483
4535
|
"type": "function",
|
|
@@ -4845,6 +4897,7 @@
|
|
|
4845
4897
|
"$extend": "WebExtensionManifest",
|
|
4846
4898
|
"properties": {
|
|
4847
4899
|
"action": {
|
|
4900
|
+
"description": "Defines the appearance and behavior of an action button in the toolbar.",
|
|
4848
4901
|
"min_manifest_version": 3,
|
|
4849
4902
|
"type": "object",
|
|
4850
4903
|
"additionalProperties": {
|
|
@@ -4950,6 +5003,7 @@
|
|
|
4950
5003
|
"$extend": "WebExtensionManifest",
|
|
4951
5004
|
"properties": {
|
|
4952
5005
|
"browser_action": {
|
|
5006
|
+
"description": "Defines the appearance and behavior of a browserAction button in the toolbar.",
|
|
4953
5007
|
"max_manifest_version": 2,
|
|
4954
5008
|
"type": "object",
|
|
4955
5009
|
"additionalProperties": {
|
|
@@ -6030,6 +6084,7 @@
|
|
|
6030
6084
|
"$extend": "WebExtensionManifest",
|
|
6031
6085
|
"properties": {
|
|
6032
6086
|
"cloud_file": {
|
|
6087
|
+
"description": "Defines a cloud file provider for uploading large attachments to a remote server.",
|
|
6033
6088
|
"type": "object",
|
|
6034
6089
|
"additionalProperties": {
|
|
6035
6090
|
"$ref": "UnrecognizedProperty"
|
|
@@ -6628,7 +6683,7 @@
|
|
|
6628
6683
|
"additionalFccFolderId": {
|
|
6629
6684
|
"min_manifest_version": 3,
|
|
6630
6685
|
"$ref": "folders.MailFolderId",
|
|
6631
|
-
"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.",
|
|
6686
|
+
"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.",
|
|
6632
6687
|
"optional": "omit-key-if-missing"
|
|
6633
6688
|
},
|
|
6634
6689
|
"additionalFccFolder": {
|
|
@@ -6647,7 +6702,7 @@
|
|
|
6647
6702
|
"$ref": "folders.MailFolderId"
|
|
6648
6703
|
}
|
|
6649
6704
|
],
|
|
6650
|
-
"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.",
|
|
6705
|
+
"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.",
|
|
6651
6706
|
"optional": true
|
|
6652
6707
|
},
|
|
6653
6708
|
"attachPublicPGPKey": {
|
|
@@ -7663,6 +7718,7 @@
|
|
|
7663
7718
|
"$extend": "WebExtensionManifest",
|
|
7664
7719
|
"properties": {
|
|
7665
7720
|
"compose_action": {
|
|
7721
|
+
"description": "Defines the appearance and behavior of a composeAction button in the message compose window.",
|
|
7666
7722
|
"type": "object",
|
|
7667
7723
|
"additionalProperties": {
|
|
7668
7724
|
"$ref": "UnrecognizedProperty"
|
|
@@ -8496,11 +8552,96 @@
|
|
|
8496
8552
|
]
|
|
8497
8553
|
}
|
|
8498
8554
|
]
|
|
8555
|
+
},
|
|
8556
|
+
{
|
|
8557
|
+
"id": "ComposeScript",
|
|
8558
|
+
"type": "object",
|
|
8559
|
+
"description": "A script and/or CSS to inject into compose windows via the manifest.",
|
|
8560
|
+
"properties": {
|
|
8561
|
+
"js": {
|
|
8562
|
+
"type": "array",
|
|
8563
|
+
"optional": true,
|
|
8564
|
+
"description": "The list of JavaScript files to inject.",
|
|
8565
|
+
"items": {
|
|
8566
|
+
"$ref": "ExtensionURL"
|
|
8567
|
+
}
|
|
8568
|
+
},
|
|
8569
|
+
"css": {
|
|
8570
|
+
"type": "array",
|
|
8571
|
+
"optional": true,
|
|
8572
|
+
"description": "The list of CSS files to inject.",
|
|
8573
|
+
"items": {
|
|
8574
|
+
"$ref": "ExtensionURL"
|
|
8575
|
+
}
|
|
8576
|
+
}
|
|
8577
|
+
},
|
|
8578
|
+
"additionalProperties": {
|
|
8579
|
+
"$ref": "UnrecognizedProperty"
|
|
8580
|
+
}
|
|
8581
|
+
},
|
|
8582
|
+
{
|
|
8583
|
+
"id": "MessageDisplayScript",
|
|
8584
|
+
"type": "object",
|
|
8585
|
+
"description": "A script and/or CSS to inject into message display pages via the manifest.",
|
|
8586
|
+
"properties": {
|
|
8587
|
+
"js": {
|
|
8588
|
+
"type": "array",
|
|
8589
|
+
"optional": true,
|
|
8590
|
+
"description": "The list of JavaScript files to inject.",
|
|
8591
|
+
"items": {
|
|
8592
|
+
"$ref": "ExtensionURL"
|
|
8593
|
+
}
|
|
8594
|
+
},
|
|
8595
|
+
"css": {
|
|
8596
|
+
"type": "array",
|
|
8597
|
+
"optional": true,
|
|
8598
|
+
"description": "The list of CSS files to inject.",
|
|
8599
|
+
"items": {
|
|
8600
|
+
"$ref": "ExtensionURL"
|
|
8601
|
+
}
|
|
8602
|
+
},
|
|
8603
|
+
"run_at": {
|
|
8604
|
+
"type": "string",
|
|
8605
|
+
"optional": true,
|
|
8606
|
+
"default": "document_idle",
|
|
8607
|
+
"enum": [
|
|
8608
|
+
"document_start",
|
|
8609
|
+
"document_end",
|
|
8610
|
+
"document_idle"
|
|
8611
|
+
],
|
|
8612
|
+
"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>."
|
|
8613
|
+
}
|
|
8614
|
+
},
|
|
8615
|
+
"additionalProperties": {
|
|
8616
|
+
"$ref": "UnrecognizedProperty"
|
|
8617
|
+
}
|
|
8618
|
+
},
|
|
8619
|
+
{
|
|
8620
|
+
"$extend": "WebExtensionManifest",
|
|
8621
|
+
"properties": {
|
|
8622
|
+
"compose_scripts": {
|
|
8623
|
+
"type": "array",
|
|
8624
|
+
"optional": true,
|
|
8625
|
+
"description": "Scripts and CSS to inject into compose windows.",
|
|
8626
|
+
"items": {
|
|
8627
|
+
"$ref": "ComposeScript"
|
|
8628
|
+
}
|
|
8629
|
+
},
|
|
8630
|
+
"message_display_scripts": {
|
|
8631
|
+
"type": "array",
|
|
8632
|
+
"optional": true,
|
|
8633
|
+
"description": "Scripts and CSS to inject into message display pages.",
|
|
8634
|
+
"items": {
|
|
8635
|
+
"$ref": "MessageDisplayScript"
|
|
8636
|
+
}
|
|
8637
|
+
}
|
|
8638
|
+
}
|
|
8499
8639
|
}
|
|
8500
8640
|
]
|
|
8501
8641
|
},
|
|
8502
8642
|
{
|
|
8503
8643
|
"namespace": "composeScripts",
|
|
8644
|
+
"description": "The composeScripts API allows to register and unregister scripts for the message compose window.",
|
|
8504
8645
|
"permissions": [
|
|
8505
8646
|
"compose"
|
|
8506
8647
|
],
|
|
@@ -8561,6 +8702,7 @@
|
|
|
8561
8702
|
},
|
|
8562
8703
|
{
|
|
8563
8704
|
"namespace": "messageDisplayScripts",
|
|
8705
|
+
"description": "The messageDisplayScripts API allows to register and unregister scripts for the message display window.",
|
|
8564
8706
|
"permissions": [
|
|
8565
8707
|
"messagesModify"
|
|
8566
8708
|
],
|
|
@@ -12251,6 +12393,7 @@
|
|
|
12251
12393
|
"$extend": "WebExtensionManifest",
|
|
12252
12394
|
"properties": {
|
|
12253
12395
|
"message_display_action": {
|
|
12396
|
+
"description": "Defines the appearance and behavior of a messageDisplayAction button in the message display window.",
|
|
12254
12397
|
"type": "object",
|
|
12255
12398
|
"additionalProperties": {
|
|
12256
12399
|
"$ref": "UnrecognizedProperty"
|
|
@@ -13077,16 +13220,28 @@
|
|
|
13077
13220
|
"enum": [
|
|
13078
13221
|
"messagesDelete",
|
|
13079
13222
|
"messagesImport",
|
|
13223
|
+
"messagesModifyPermanent",
|
|
13080
13224
|
"messagesMove",
|
|
13081
13225
|
"messagesRead",
|
|
13226
|
+
"messages.save",
|
|
13082
13227
|
"messagesTags",
|
|
13083
13228
|
"messagesTagsList",
|
|
13084
13229
|
"messagesUpdate",
|
|
13085
|
-
"messagesModifyPermanent",
|
|
13086
13230
|
"sensitiveDataUpload"
|
|
13087
13231
|
]
|
|
13088
13232
|
}
|
|
13089
13233
|
]
|
|
13234
|
+
},
|
|
13235
|
+
{
|
|
13236
|
+
"$extend": "OptionalOnlyPermission",
|
|
13237
|
+
"choices": [
|
|
13238
|
+
{
|
|
13239
|
+
"type": "string",
|
|
13240
|
+
"enum": [
|
|
13241
|
+
"messages.send"
|
|
13242
|
+
]
|
|
13243
|
+
}
|
|
13244
|
+
]
|
|
13090
13245
|
}
|
|
13091
13246
|
]
|
|
13092
13247
|
},
|
|
@@ -13352,6 +13507,18 @@
|
|
|
13352
13507
|
}
|
|
13353
13508
|
}
|
|
13354
13509
|
},
|
|
13510
|
+
{
|
|
13511
|
+
"id": "AttachmentType",
|
|
13512
|
+
"type": "string",
|
|
13513
|
+
"enum": [
|
|
13514
|
+
"normal",
|
|
13515
|
+
"detached",
|
|
13516
|
+
"deleted",
|
|
13517
|
+
"linked",
|
|
13518
|
+
"cloudFile"
|
|
13519
|
+
],
|
|
13520
|
+
"description": "The type of an attachment in a message."
|
|
13521
|
+
},
|
|
13355
13522
|
{
|
|
13356
13523
|
"id": "MessageAttachment",
|
|
13357
13524
|
"type": "object",
|
|
@@ -13365,13 +13532,17 @@
|
|
|
13365
13532
|
"type": "string",
|
|
13366
13533
|
"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."
|
|
13367
13534
|
},
|
|
13535
|
+
"type": {
|
|
13536
|
+
"$ref": "messages.AttachmentType",
|
|
13537
|
+
"description": "The type of this attachment."
|
|
13538
|
+
},
|
|
13368
13539
|
"headers": {
|
|
13369
13540
|
"$ref": "messages.HeadersDictionary",
|
|
13370
13541
|
"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>."
|
|
13371
13542
|
},
|
|
13372
13543
|
"name": {
|
|
13373
13544
|
"type": "string",
|
|
13374
|
-
"description": "The name, as displayed to the user, of this attachment. This is usually but not always the filename of the attached file."
|
|
13545
|
+
"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."
|
|
13375
13546
|
},
|
|
13376
13547
|
"partName": {
|
|
13377
13548
|
"type": "string",
|
|
@@ -13381,6 +13552,16 @@
|
|
|
13381
13552
|
"type": "integer",
|
|
13382
13553
|
"description": "The size in bytes of this attachment."
|
|
13383
13554
|
},
|
|
13555
|
+
"linkUrl": {
|
|
13556
|
+
"type": "string",
|
|
13557
|
+
"optional": true,
|
|
13558
|
+
"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."
|
|
13559
|
+
},
|
|
13560
|
+
"cloudFileUrl": {
|
|
13561
|
+
"type": "string",
|
|
13562
|
+
"optional": true,
|
|
13563
|
+
"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."
|
|
13564
|
+
},
|
|
13384
13565
|
"contentId": {
|
|
13385
13566
|
"type": "string",
|
|
13386
13567
|
"optional": true,
|
|
@@ -13420,6 +13601,176 @@
|
|
|
13420
13601
|
"description": "The maximum value required to match the query."
|
|
13421
13602
|
}
|
|
13422
13603
|
}
|
|
13604
|
+
},
|
|
13605
|
+
{
|
|
13606
|
+
"id": "NewMessageDetails",
|
|
13607
|
+
"type": "object",
|
|
13608
|
+
"description": "Details of a message to be sent.",
|
|
13609
|
+
"additionalProperties": true,
|
|
13610
|
+
"properties": {
|
|
13611
|
+
"identityId": {
|
|
13612
|
+
"type": "string",
|
|
13613
|
+
"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``.",
|
|
13614
|
+
"optional": true
|
|
13615
|
+
},
|
|
13616
|
+
"from": {
|
|
13617
|
+
"$ref": "compose.ComposeRecipient",
|
|
13618
|
+
"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.",
|
|
13619
|
+
"optional": true
|
|
13620
|
+
},
|
|
13621
|
+
"to": {
|
|
13622
|
+
"$ref": "compose.ComposeRecipientList",
|
|
13623
|
+
"optional": true
|
|
13624
|
+
},
|
|
13625
|
+
"cc": {
|
|
13626
|
+
"$ref": "compose.ComposeRecipientList",
|
|
13627
|
+
"optional": true
|
|
13628
|
+
},
|
|
13629
|
+
"bcc": {
|
|
13630
|
+
"$ref": "compose.ComposeRecipientList",
|
|
13631
|
+
"optional": true
|
|
13632
|
+
},
|
|
13633
|
+
"overrideDefaultFccFolder": {
|
|
13634
|
+
"choices": [
|
|
13635
|
+
{
|
|
13636
|
+
"$ref": "folders.MailFolder"
|
|
13637
|
+
},
|
|
13638
|
+
{
|
|
13639
|
+
"type": "string",
|
|
13640
|
+
"enum": [
|
|
13641
|
+
""
|
|
13642
|
+
]
|
|
13643
|
+
}
|
|
13644
|
+
],
|
|
13645
|
+
"optional": true,
|
|
13646
|
+
"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."
|
|
13647
|
+
},
|
|
13648
|
+
"additionalFccFolder": {
|
|
13649
|
+
"choices": [
|
|
13650
|
+
{
|
|
13651
|
+
"$ref": "folders.MailFolder"
|
|
13652
|
+
},
|
|
13653
|
+
{
|
|
13654
|
+
"type": "string",
|
|
13655
|
+
"enum": [
|
|
13656
|
+
""
|
|
13657
|
+
]
|
|
13658
|
+
}
|
|
13659
|
+
],
|
|
13660
|
+
"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.",
|
|
13661
|
+
"optional": true
|
|
13662
|
+
},
|
|
13663
|
+
"replyTo": {
|
|
13664
|
+
"$ref": "compose.ComposeRecipientList",
|
|
13665
|
+
"optional": true
|
|
13666
|
+
},
|
|
13667
|
+
"followupTo": {
|
|
13668
|
+
"$ref": "compose.ComposeRecipientList",
|
|
13669
|
+
"optional": true
|
|
13670
|
+
},
|
|
13671
|
+
"newsgroups": {
|
|
13672
|
+
"description": "A single newsgroup name or an array of newsgroup names.",
|
|
13673
|
+
"choices": [
|
|
13674
|
+
{
|
|
13675
|
+
"type": "string"
|
|
13676
|
+
},
|
|
13677
|
+
{
|
|
13678
|
+
"type": "array",
|
|
13679
|
+
"items": {
|
|
13680
|
+
"type": "string"
|
|
13681
|
+
}
|
|
13682
|
+
}
|
|
13683
|
+
],
|
|
13684
|
+
"optional": true
|
|
13685
|
+
},
|
|
13686
|
+
"subject": {
|
|
13687
|
+
"type": "string"
|
|
13688
|
+
},
|
|
13689
|
+
"body": {
|
|
13690
|
+
"type": "string",
|
|
13691
|
+
"description": "The HTML content for the message.",
|
|
13692
|
+
"optional": true
|
|
13693
|
+
},
|
|
13694
|
+
"plainTextBody": {
|
|
13695
|
+
"type": "string",
|
|
13696
|
+
"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.",
|
|
13697
|
+
"optional": true
|
|
13698
|
+
},
|
|
13699
|
+
"isPlainText": {
|
|
13700
|
+
"type": "boolean",
|
|
13701
|
+
"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>.",
|
|
13702
|
+
"optional": true
|
|
13703
|
+
},
|
|
13704
|
+
"deliveryFormat": {
|
|
13705
|
+
"type": "string",
|
|
13706
|
+
"enum": [
|
|
13707
|
+
"auto",
|
|
13708
|
+
"plaintext",
|
|
13709
|
+
"html",
|
|
13710
|
+
"both"
|
|
13711
|
+
],
|
|
13712
|
+
"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>.",
|
|
13713
|
+
"optional": true
|
|
13714
|
+
},
|
|
13715
|
+
"contentLanguage": {
|
|
13716
|
+
"type": "array",
|
|
13717
|
+
"items": {
|
|
13718
|
+
"type": "string"
|
|
13719
|
+
},
|
|
13720
|
+
"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.",
|
|
13721
|
+
"optional": true
|
|
13722
|
+
},
|
|
13723
|
+
"customHeaders": {
|
|
13724
|
+
"type": "array",
|
|
13725
|
+
"items": {
|
|
13726
|
+
"$ref": "compose.CustomHeader"
|
|
13727
|
+
},
|
|
13728
|
+
"description": "Array of custom headers.",
|
|
13729
|
+
"optional": true
|
|
13730
|
+
},
|
|
13731
|
+
"priority": {
|
|
13732
|
+
"type": "string",
|
|
13733
|
+
"enum": [
|
|
13734
|
+
"lowest",
|
|
13735
|
+
"low",
|
|
13736
|
+
"normal",
|
|
13737
|
+
"high",
|
|
13738
|
+
"highest"
|
|
13739
|
+
],
|
|
13740
|
+
"description": "The priority of the message.",
|
|
13741
|
+
"optional": true
|
|
13742
|
+
},
|
|
13743
|
+
"returnReceipt": {
|
|
13744
|
+
"type": "boolean",
|
|
13745
|
+
"optional": true,
|
|
13746
|
+
"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."
|
|
13747
|
+
},
|
|
13748
|
+
"deliveryStatusNotification": {
|
|
13749
|
+
"type": "boolean",
|
|
13750
|
+
"optional": true,
|
|
13751
|
+
"description": "Let the sender know when the recipient's server received the message. Not supported by all servers."
|
|
13752
|
+
},
|
|
13753
|
+
"attachVCard": {
|
|
13754
|
+
"type": "boolean",
|
|
13755
|
+
"optional": true,
|
|
13756
|
+
"description": "Wether or not the vCard of the used identity will be attached to the message during send."
|
|
13757
|
+
},
|
|
13758
|
+
"attachments": {
|
|
13759
|
+
"type": "array",
|
|
13760
|
+
"items": {
|
|
13761
|
+
"choices": [
|
|
13762
|
+
{
|
|
13763
|
+
"$ref": "compose.FileAttachment"
|
|
13764
|
+
},
|
|
13765
|
+
{
|
|
13766
|
+
"$ref": "compose.ComposeAttachment"
|
|
13767
|
+
}
|
|
13768
|
+
]
|
|
13769
|
+
},
|
|
13770
|
+
"description": "Attachments to add to the message. **Note:** :ref:`compose.ComposeAttachments` are included as real file attachments, not as cloudFile links.",
|
|
13771
|
+
"optional": true
|
|
13772
|
+
}
|
|
13773
|
+
}
|
|
13423
13774
|
}
|
|
13424
13775
|
],
|
|
13425
13776
|
"events": [
|
|
@@ -14500,6 +14851,126 @@
|
|
|
14500
14851
|
}
|
|
14501
14852
|
]
|
|
14502
14853
|
},
|
|
14854
|
+
{
|
|
14855
|
+
"name": "sendMessage",
|
|
14856
|
+
"permissions": [
|
|
14857
|
+
"messages.send"
|
|
14858
|
+
],
|
|
14859
|
+
"type": "function",
|
|
14860
|
+
"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.",
|
|
14861
|
+
"async": "callback",
|
|
14862
|
+
"parameters": [
|
|
14863
|
+
{
|
|
14864
|
+
"name": "details",
|
|
14865
|
+
"$ref": "messages.NewMessageDetails"
|
|
14866
|
+
},
|
|
14867
|
+
{
|
|
14868
|
+
"name": "options",
|
|
14869
|
+
"type": "object",
|
|
14870
|
+
"optional": true,
|
|
14871
|
+
"properties": {
|
|
14872
|
+
"mode": {
|
|
14873
|
+
"type": "string",
|
|
14874
|
+
"enum": [
|
|
14875
|
+
"default",
|
|
14876
|
+
"sendNow",
|
|
14877
|
+
"sendLater"
|
|
14878
|
+
]
|
|
14879
|
+
}
|
|
14880
|
+
}
|
|
14881
|
+
},
|
|
14882
|
+
{
|
|
14883
|
+
"type": "function",
|
|
14884
|
+
"name": "callback",
|
|
14885
|
+
"optional": true,
|
|
14886
|
+
"parameters": [
|
|
14887
|
+
{
|
|
14888
|
+
"name": "return",
|
|
14889
|
+
"type": "object",
|
|
14890
|
+
"properties": {
|
|
14891
|
+
"mode": {
|
|
14892
|
+
"type": "string",
|
|
14893
|
+
"description": "The used send mode.",
|
|
14894
|
+
"enum": [
|
|
14895
|
+
"sendNow",
|
|
14896
|
+
"sendLater"
|
|
14897
|
+
]
|
|
14898
|
+
},
|
|
14899
|
+
"headerMessageId": {
|
|
14900
|
+
"type": "string",
|
|
14901
|
+
"description": "The header messageId of the outgoing message. Only included for actually sent messages.",
|
|
14902
|
+
"optional": true
|
|
14903
|
+
},
|
|
14904
|
+
"messages": {
|
|
14905
|
+
"type": "array",
|
|
14906
|
+
"items": {
|
|
14907
|
+
"$ref": "messages.MessageHeader"
|
|
14908
|
+
},
|
|
14909
|
+
"description": "Copies of the sent message. The number of created copies depends on the applied file carbon copy configuration (fcc)."
|
|
14910
|
+
}
|
|
14911
|
+
}
|
|
14912
|
+
}
|
|
14913
|
+
]
|
|
14914
|
+
}
|
|
14915
|
+
]
|
|
14916
|
+
},
|
|
14917
|
+
{
|
|
14918
|
+
"name": "saveMessage",
|
|
14919
|
+
"permissions": [
|
|
14920
|
+
"messages.save"
|
|
14921
|
+
],
|
|
14922
|
+
"type": "function",
|
|
14923
|
+
"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.",
|
|
14924
|
+
"async": "callback",
|
|
14925
|
+
"parameters": [
|
|
14926
|
+
{
|
|
14927
|
+
"name": "details",
|
|
14928
|
+
"$ref": "NewMessageDetails"
|
|
14929
|
+
},
|
|
14930
|
+
{
|
|
14931
|
+
"name": "options",
|
|
14932
|
+
"type": "object",
|
|
14933
|
+
"optional": true,
|
|
14934
|
+
"properties": {
|
|
14935
|
+
"mode": {
|
|
14936
|
+
"type": "string",
|
|
14937
|
+
"enum": [
|
|
14938
|
+
"draft",
|
|
14939
|
+
"template"
|
|
14940
|
+
]
|
|
14941
|
+
}
|
|
14942
|
+
}
|
|
14943
|
+
},
|
|
14944
|
+
{
|
|
14945
|
+
"type": "function",
|
|
14946
|
+
"name": "callback",
|
|
14947
|
+
"optional": true,
|
|
14948
|
+
"parameters": [
|
|
14949
|
+
{
|
|
14950
|
+
"name": "return",
|
|
14951
|
+
"type": "object",
|
|
14952
|
+
"properties": {
|
|
14953
|
+
"mode": {
|
|
14954
|
+
"type": "string",
|
|
14955
|
+
"description": "The used save mode.",
|
|
14956
|
+
"enum": [
|
|
14957
|
+
"draft",
|
|
14958
|
+
"template"
|
|
14959
|
+
]
|
|
14960
|
+
},
|
|
14961
|
+
"messages": {
|
|
14962
|
+
"type": "array",
|
|
14963
|
+
"items": {
|
|
14964
|
+
"$ref": "messages.MessageHeader"
|
|
14965
|
+
},
|
|
14966
|
+
"description": "The saved message(s). The number of saved messages depends on the applied file carbon copy configuration (fcc)."
|
|
14967
|
+
}
|
|
14968
|
+
}
|
|
14969
|
+
}
|
|
14970
|
+
]
|
|
14971
|
+
}
|
|
14972
|
+
]
|
|
14973
|
+
},
|
|
14503
14974
|
{
|
|
14504
14975
|
"name": "archive",
|
|
14505
14976
|
"type": "function",
|
|
@@ -14556,8 +15027,8 @@
|
|
|
14556
15027
|
{
|
|
14557
15028
|
"type": "string",
|
|
14558
15029
|
"name": "key",
|
|
14559
|
-
"description": "Unique tag identifier (will be converted to lower case). Must
|
|
14560
|
-
"pattern": "^[^
|
|
15030
|
+
"description": "Unique tag identifier (will be converted to lower case). Must be an ASCII string that is safe to use as an IMAP keyword.",
|
|
15031
|
+
"pattern": "^[!#$&'+,\\-.0-9:=?@A-Z^_`a-z|~]+$"
|
|
14561
15032
|
},
|
|
14562
15033
|
{
|
|
14563
15034
|
"type": "string",
|
|
@@ -14784,6 +15255,32 @@
|
|
|
14784
15255
|
}
|
|
14785
15256
|
]
|
|
14786
15257
|
},
|
|
15258
|
+
{
|
|
15259
|
+
"name": "get",
|
|
15260
|
+
"type": "function",
|
|
15261
|
+
"description": "Returns a message tag identified by its key.",
|
|
15262
|
+
"async": "callback",
|
|
15263
|
+
"permissions": [
|
|
15264
|
+
"messagesTagsList"
|
|
15265
|
+
],
|
|
15266
|
+
"parameters": [
|
|
15267
|
+
{
|
|
15268
|
+
"type": "string",
|
|
15269
|
+
"name": "key",
|
|
15270
|
+
"description": "The key of the message tag to retrieve."
|
|
15271
|
+
},
|
|
15272
|
+
{
|
|
15273
|
+
"type": "function",
|
|
15274
|
+
"name": "callback",
|
|
15275
|
+
"optional": true,
|
|
15276
|
+
"parameters": [
|
|
15277
|
+
{
|
|
15278
|
+
"$ref": "messages.tags.MessageTag"
|
|
15279
|
+
}
|
|
15280
|
+
]
|
|
15281
|
+
}
|
|
15282
|
+
]
|
|
15283
|
+
},
|
|
14787
15284
|
{
|
|
14788
15285
|
"name": "create",
|
|
14789
15286
|
"type": "function",
|
|
@@ -14797,8 +15294,8 @@
|
|
|
14797
15294
|
"type": "string",
|
|
14798
15295
|
"name": "key",
|
|
14799
15296
|
"optional": true,
|
|
14800
|
-
"description": "Unique tag identifier (will be converted to lower case). Must
|
|
14801
|
-
"pattern": "^[^
|
|
15297
|
+
"description": "Unique tag identifier (will be converted to lower case). Must be an ASCII string that is safe to use as an IMAP keyword. Will be auto-generated if not provided.",
|
|
15298
|
+
"pattern": "^[!#$&'+,\\-.0-9:=?@A-Z^_`a-z|~]+$"
|
|
14802
15299
|
},
|
|
14803
15300
|
{
|
|
14804
15301
|
"type": "string",
|
|
@@ -14889,6 +15386,10 @@
|
|
|
14889
15386
|
"messengerSettings"
|
|
14890
15387
|
],
|
|
14891
15388
|
"properties": {
|
|
15389
|
+
"composeInlineSpellCheckEnabled": {
|
|
15390
|
+
"$ref": "types.Setting",
|
|
15391
|
+
"description": "Whether the inline (real-time) spell checker is enabled in the message compose window."
|
|
15392
|
+
},
|
|
14892
15393
|
"messageLineLengthLimit": {
|
|
14893
15394
|
"$ref": "types.Setting",
|
|
14894
15395
|
"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 +15676,7 @@
|
|
|
15175
15676
|
"$extend": "WebExtensionManifest",
|
|
15176
15677
|
"properties": {
|
|
15177
15678
|
"oauth_provider": {
|
|
15178
|
-
"description": "Describes an OAuth authentication provider for Thunderbird
|
|
15679
|
+
"description": "Describes an OAuth authentication provider for Thunderbird. You will need to have a client ID registered with the provider to use this API.",
|
|
15179
15680
|
"type": "object",
|
|
15180
15681
|
"properties": {
|
|
15181
15682
|
"issuer": {
|
|
@@ -15191,6 +15692,11 @@
|
|
|
15191
15692
|
"type": "string",
|
|
15192
15693
|
"optional": true
|
|
15193
15694
|
},
|
|
15695
|
+
"issuerIdentifier": {
|
|
15696
|
+
"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.",
|
|
15697
|
+
"type": "string",
|
|
15698
|
+
"optional": true
|
|
15699
|
+
},
|
|
15194
15700
|
"authorizationEndpoint": {
|
|
15195
15701
|
"description": "OAuth authorization endpoint address.",
|
|
15196
15702
|
"type": "string",
|
|
@@ -15203,22 +15709,35 @@
|
|
|
15203
15709
|
},
|
|
15204
15710
|
"redirectionEndpoint": {
|
|
15205
15711
|
"description": "OAuth redirection endpoint.",
|
|
15206
|
-
"type": "string"
|
|
15207
|
-
"format": "url"
|
|
15712
|
+
"type": "string"
|
|
15208
15713
|
},
|
|
15209
15714
|
"usePKCE": {
|
|
15210
15715
|
"description": "If the authorization uses PKCE.",
|
|
15211
15716
|
"type": "boolean",
|
|
15212
15717
|
"optional": true
|
|
15213
15718
|
},
|
|
15719
|
+
"useExternalBrowser": {
|
|
15720
|
+
"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.",
|
|
15721
|
+
"type": "boolean",
|
|
15722
|
+
"optional": true
|
|
15723
|
+
},
|
|
15214
15724
|
"hostnames": {
|
|
15215
|
-
"description": "One or more hostnames
|
|
15725
|
+
"description": "One or more server hostnames that use this OAuth provider. Include any service or autodiscovery hostnames that may initiate OAuth authentication. For example, to override many Microsoft configurations, both of these would be needed - [\"office365.com\", \"outlook.com\"]",
|
|
15216
15726
|
"type": "array",
|
|
15217
15727
|
"items": {
|
|
15218
15728
|
"type": "string"
|
|
15219
15729
|
},
|
|
15220
15730
|
"minItems": 1
|
|
15221
15731
|
},
|
|
15732
|
+
"emailDomains": {
|
|
15733
|
+
"description": "Email domains for which this OAuth provider should be used. If omitted, the provider applies to all domains in use with a given hostname",
|
|
15734
|
+
"type": "array",
|
|
15735
|
+
"items": {
|
|
15736
|
+
"type": "string"
|
|
15737
|
+
},
|
|
15738
|
+
"minItems": 1,
|
|
15739
|
+
"optional": true
|
|
15740
|
+
},
|
|
15222
15741
|
"scopes": {
|
|
15223
15742
|
"description": "The scopes to request when using this OAuth provider.",
|
|
15224
15743
|
"type": "string"
|
|
@@ -16019,6 +16538,12 @@
|
|
|
16019
16538
|
"optional": true,
|
|
16020
16539
|
"minimum": -1,
|
|
16021
16540
|
"description": "The ID of the group that the tab belongs to. -1 if the tab does not belong to a tab group."
|
|
16541
|
+
},
|
|
16542
|
+
"splitViewId": {
|
|
16543
|
+
"type": "integer",
|
|
16544
|
+
"optional": true,
|
|
16545
|
+
"minimum": -1,
|
|
16546
|
+
"description": "The ID of the Split View that the tab belongs to. -1 if the tab does not belong to a split view."
|
|
16022
16547
|
}
|
|
16023
16548
|
}
|
|
16024
16549
|
},
|
|
@@ -16182,6 +16707,11 @@
|
|
|
16182
16707
|
"optional": true,
|
|
16183
16708
|
"minimum": 0,
|
|
16184
16709
|
"description": "Open a port to a specific frame identified by <var>frameId</var> instead of all frames in the tab."
|
|
16710
|
+
},
|
|
16711
|
+
"documentId": {
|
|
16712
|
+
"type": "string",
|
|
16713
|
+
"optional": true,
|
|
16714
|
+
"description": "Open a port to a specific document identified by <var>documentId</var> instead of all frames in the tab."
|
|
16185
16715
|
}
|
|
16186
16716
|
},
|
|
16187
16717
|
"optional": true
|
|
@@ -16216,6 +16746,11 @@
|
|
|
16216
16746
|
"optional": true,
|
|
16217
16747
|
"minimum": 0,
|
|
16218
16748
|
"description": "Send a message to a specific frame identified by <var>frameId</var> instead of all frames in the tab."
|
|
16749
|
+
},
|
|
16750
|
+
"documentId": {
|
|
16751
|
+
"type": "string",
|
|
16752
|
+
"optional": true,
|
|
16753
|
+
"description": "Send a message to a specific document identified by <var>documentId</var> instead of all frames in the tab."
|
|
16219
16754
|
}
|
|
16220
16755
|
},
|
|
16221
16756
|
"optional": true
|