webext-schema 5.6.1 → 7.0.0
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/FUNDING.yml +13 -0
- package/.github/workflows/node.js.yml +31 -0
- package/eslint.config.mjs +52 -0
- package/modules/browser.js +5 -5
- package/modules/common.js +7 -7
- package/modules/schema.js +3 -4
- package/modules/update.js +0 -9
- package/package.json +17 -19
- package/schemas/beta/webext.json +41 -166
- package/schemas/central/webext.json +35 -206
- package/schemas/mail/mailext.json +325 -97
- package/test/browser.test.js +3040 -0
- package/test/commander.test.js +134 -0
- package/test/common.test.js +120 -0
- package/test/constant.test.js +34 -0
- package/test/file/test 2.cmd +2 -0
- package/test/file/test 2.sh +2 -0
- package/test/file/test.cmd +2 -0
- package/test/file/test.js +1 -0
- package/test/file/test.sh +2 -0
- package/test/file/test.txt +1 -0
- package/test/file-util.test.js +370 -0
- package/test/index.test.js +13 -0
- package/test/mocha/setup.js +40 -0
- package/test/schema.test.js +1280 -0
- package/test/update.test.js +1022 -0
- package/types/modules/browser.d.ts +5 -5
- package/types/modules/common.d.ts +5 -5
- package/types/modules/update.d.ts +0 -1
- package/schemas/esr/webext.json +0 -21462
- package/schemas/release/webext.json +0 -22485
|
@@ -381,6 +381,11 @@
|
|
|
381
381
|
"optional": true,
|
|
382
382
|
"description": "The JavaScript world for a script to execute within. Defaults to \"ISOLATED\"."
|
|
383
383
|
},
|
|
384
|
+
"cssOrigin": {
|
|
385
|
+
"$ref": "extensionTypes.CSSOrigin",
|
|
386
|
+
"optional": true,
|
|
387
|
+
"description": "The css origin of the stylesheet to inject. Defaults to \"author\"."
|
|
388
|
+
},
|
|
384
389
|
"cookieStoreId": {
|
|
385
390
|
"choices": [
|
|
386
391
|
{
|
|
@@ -1032,7 +1037,7 @@
|
|
|
1032
1037
|
},
|
|
1033
1038
|
{
|
|
1034
1039
|
"id": "ExtensionInstallType",
|
|
1035
|
-
"description": "How the extension was installed
|
|
1040
|
+
"description": "How the extension was installed.<dl><dt>development</dt><dd>The extension was loaded unpacked in developer mode,</dd><dt>normal</dt><dd>The extension was installed normally via an .xpi file</dd><dt>sideload</dt><dd>The extension was installed by other software on the machine</dd><dt>admin</dt><dd>The extension was installed by policy</dd><dt>other</dt><dd>The extension was installed by other means.</dd></dl>",
|
|
1036
1041
|
"type": "string",
|
|
1037
1042
|
"enum": [
|
|
1038
1043
|
"development",
|
|
@@ -1811,6 +1816,7 @@
|
|
|
1811
1816
|
"aarch64",
|
|
1812
1817
|
"arm",
|
|
1813
1818
|
"ppc64",
|
|
1819
|
+
"riscv64",
|
|
1814
1820
|
"s390x",
|
|
1815
1821
|
"sparc64",
|
|
1816
1822
|
"x86-32",
|
|
@@ -2187,7 +2193,7 @@
|
|
|
2187
2193
|
],
|
|
2188
2194
|
"returns": {
|
|
2189
2195
|
"$ref": "Port",
|
|
2190
|
-
"description": "Port through which messages can be sent and received. The port's $(ref:runtime.Port
|
|
2196
|
+
"description": "Port through which messages can be sent and received. The port's $(ref:runtime.Port.onDisconnect) event is fired if the extension/app does not exist. "
|
|
2191
2197
|
}
|
|
2192
2198
|
},
|
|
2193
2199
|
{
|
|
@@ -2647,7 +2653,7 @@
|
|
|
2647
2653
|
},
|
|
2648
2654
|
{
|
|
2649
2655
|
"type": "array",
|
|
2650
|
-
"description": "An RGBA array of 3 integers and a fractional (a float between 0 and 1). For example <var>[220, 20, 60, 0.5]
|
|
2656
|
+
"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.",
|
|
2651
2657
|
"minItems": 4,
|
|
2652
2658
|
"maxItems": 4,
|
|
2653
2659
|
"items": {
|
|
@@ -2995,9 +3001,10 @@
|
|
|
2995
3001
|
"optional": true,
|
|
2996
3002
|
"type": "string",
|
|
2997
3003
|
"enum": [
|
|
3004
|
+
"auto",
|
|
2998
3005
|
"light",
|
|
2999
3006
|
"dark",
|
|
3000
|
-
"
|
|
3007
|
+
"system"
|
|
3001
3008
|
]
|
|
3002
3009
|
},
|
|
3003
3010
|
"content_color_scheme": {
|
|
@@ -3005,9 +3012,10 @@
|
|
|
3005
3012
|
"optional": true,
|
|
3006
3013
|
"type": "string",
|
|
3007
3014
|
"enum": [
|
|
3015
|
+
"auto",
|
|
3008
3016
|
"light",
|
|
3009
3017
|
"dark",
|
|
3010
|
-
"
|
|
3018
|
+
"system"
|
|
3011
3019
|
]
|
|
3012
3020
|
}
|
|
3013
3021
|
},
|
|
@@ -4012,45 +4020,85 @@
|
|
|
4012
4020
|
"types": [
|
|
4013
4021
|
{
|
|
4014
4022
|
"id": "QueryInfo",
|
|
4015
|
-
"
|
|
4016
|
-
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
"type": "
|
|
4020
|
-
"
|
|
4021
|
-
|
|
4022
|
-
|
|
4023
|
-
|
|
4024
|
-
|
|
4025
|
-
|
|
4026
|
-
|
|
4027
|
-
|
|
4028
|
-
|
|
4029
|
-
|
|
4030
|
-
|
|
4031
|
-
|
|
4032
|
-
|
|
4033
|
-
|
|
4034
|
-
|
|
4035
|
-
|
|
4036
|
-
|
|
4037
|
-
|
|
4038
|
-
|
|
4039
|
-
|
|
4040
|
-
|
|
4041
|
-
|
|
4042
|
-
|
|
4043
|
-
|
|
4044
|
-
|
|
4045
|
-
|
|
4023
|
+
"choices": [
|
|
4024
|
+
{
|
|
4025
|
+
"max_manifest_version": 2,
|
|
4026
|
+
"description": "Object defining a query for $(ref:contacts.quickSearch).",
|
|
4027
|
+
"type": "object",
|
|
4028
|
+
"properties": {
|
|
4029
|
+
"searchString": {
|
|
4030
|
+
"type": "string",
|
|
4031
|
+
"optional": true,
|
|
4032
|
+
"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>)."
|
|
4033
|
+
},
|
|
4034
|
+
"includeLocal": {
|
|
4035
|
+
"type": "boolean",
|
|
4036
|
+
"optional": true,
|
|
4037
|
+
"default": true,
|
|
4038
|
+
"description": "Whether to include results from local address books. Defaults to <var>true</var>."
|
|
4039
|
+
},
|
|
4040
|
+
"includeRemote": {
|
|
4041
|
+
"type": "boolean",
|
|
4042
|
+
"optional": true,
|
|
4043
|
+
"default": true,
|
|
4044
|
+
"description": "Whether to include results from remote address books. Defaults to <var>true</var>."
|
|
4045
|
+
},
|
|
4046
|
+
"includeReadOnly": {
|
|
4047
|
+
"type": "boolean",
|
|
4048
|
+
"optional": true,
|
|
4049
|
+
"default": true,
|
|
4050
|
+
"description": "Whether to include results from read-only address books. Defaults to <var>true</var>."
|
|
4051
|
+
},
|
|
4052
|
+
"includeReadWrite": {
|
|
4053
|
+
"type": "boolean",
|
|
4054
|
+
"optional": true,
|
|
4055
|
+
"default": true,
|
|
4056
|
+
"description": "Whether to include results from read-write address books. Defaults to <var>true</var>."
|
|
4057
|
+
}
|
|
4058
|
+
}
|
|
4046
4059
|
},
|
|
4047
|
-
|
|
4048
|
-
"
|
|
4049
|
-
"
|
|
4050
|
-
"
|
|
4051
|
-
"
|
|
4060
|
+
{
|
|
4061
|
+
"min_manifest_version": 3,
|
|
4062
|
+
"description": "Object defining a query for $(ref:contacts.query).",
|
|
4063
|
+
"type": "object",
|
|
4064
|
+
"properties": {
|
|
4065
|
+
"parentId": {
|
|
4066
|
+
"type": "string",
|
|
4067
|
+
"optional": true,
|
|
4068
|
+
"description": "The id of the address book to search. If not specified, all address books are searched."
|
|
4069
|
+
},
|
|
4070
|
+
"searchString": {
|
|
4071
|
+
"type": "string",
|
|
4072
|
+
"optional": true,
|
|
4073
|
+
"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>)."
|
|
4074
|
+
},
|
|
4075
|
+
"includeLocal": {
|
|
4076
|
+
"type": "boolean",
|
|
4077
|
+
"optional": true,
|
|
4078
|
+
"default": true,
|
|
4079
|
+
"description": "Whether to include results from local address books. Defaults to <var>true</var>."
|
|
4080
|
+
},
|
|
4081
|
+
"includeRemote": {
|
|
4082
|
+
"type": "boolean",
|
|
4083
|
+
"optional": true,
|
|
4084
|
+
"default": true,
|
|
4085
|
+
"description": "Whether to include results from remote address books. Defaults to <var>true</var>."
|
|
4086
|
+
},
|
|
4087
|
+
"includeReadOnly": {
|
|
4088
|
+
"type": "boolean",
|
|
4089
|
+
"optional": true,
|
|
4090
|
+
"default": true,
|
|
4091
|
+
"description": "Whether to include results from read-only address books. Defaults to <var>true</var>."
|
|
4092
|
+
},
|
|
4093
|
+
"includeReadWrite": {
|
|
4094
|
+
"type": "boolean",
|
|
4095
|
+
"optional": true,
|
|
4096
|
+
"default": true,
|
|
4097
|
+
"description": "Whether to include results from read-write address books. Defaults to <var>true</var>."
|
|
4098
|
+
}
|
|
4099
|
+
}
|
|
4052
4100
|
}
|
|
4053
|
-
|
|
4101
|
+
]
|
|
4054
4102
|
},
|
|
4055
4103
|
{
|
|
4056
4104
|
"id": "ContactNode",
|
|
@@ -6509,14 +6557,14 @@
|
|
|
6509
6557
|
},
|
|
6510
6558
|
{
|
|
6511
6559
|
"namespace": "compose",
|
|
6512
|
-
"
|
|
6560
|
+
"description": "The compose API allows to interact with the message composition window.",
|
|
6513
6561
|
"types": [
|
|
6514
6562
|
{
|
|
6515
6563
|
"id": "ComposeRecipient",
|
|
6516
6564
|
"choices": [
|
|
6517
6565
|
{
|
|
6518
6566
|
"type": "string",
|
|
6519
|
-
"description": "A name and email address in
|
|
6567
|
+
"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."
|
|
6520
6568
|
},
|
|
6521
6569
|
{
|
|
6522
6570
|
"type": "object",
|
|
@@ -6529,7 +6577,7 @@
|
|
|
6529
6577
|
"nodeId": {
|
|
6530
6578
|
"type": "string",
|
|
6531
6579
|
"min_manifest_version": 3,
|
|
6532
|
-
"description": "The ID of a contact or mailing list node from the $(doc:
|
|
6580
|
+
"description": "The ID of a contact or mailing list node from the $(doc:addressBooks.contacts) or $(doc:addressBooks.mailingLists)."
|
|
6533
6581
|
},
|
|
6534
6582
|
"type": {
|
|
6535
6583
|
"type": "string",
|
|
@@ -6738,12 +6786,12 @@
|
|
|
6738
6786
|
}
|
|
6739
6787
|
],
|
|
6740
6788
|
"optional": true,
|
|
6741
|
-
"description": "
|
|
6789
|
+
"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."
|
|
6742
6790
|
},
|
|
6743
6791
|
"overrideDefaultFccFolderId": {
|
|
6744
6792
|
"min_manifest_version": 3,
|
|
6745
6793
|
"$ref": "folders.MailFolderId",
|
|
6746
|
-
"description": "
|
|
6794
|
+
"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.",
|
|
6747
6795
|
"optional": "omit-key-if-missing"
|
|
6748
6796
|
},
|
|
6749
6797
|
"plainTextBody": {
|
|
@@ -6764,7 +6812,7 @@
|
|
|
6764
6812
|
"optional": true
|
|
6765
6813
|
},
|
|
6766
6814
|
"relatedMessageId": {
|
|
6767
|
-
"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.",
|
|
6815
|
+
"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.",
|
|
6768
6816
|
"$ref": "messages.MessageId",
|
|
6769
6817
|
"optional": true
|
|
6770
6818
|
},
|
|
@@ -6947,7 +6995,8 @@
|
|
|
6947
6995
|
"parameters": [
|
|
6948
6996
|
{
|
|
6949
6997
|
"name": "tab",
|
|
6950
|
-
"$ref": "tabs.Tab"
|
|
6998
|
+
"$ref": "tabs.Tab",
|
|
6999
|
+
"description": "The tab of the associated compose window. By the time the event listener is called, this window may have already been destroyed."
|
|
6951
7000
|
},
|
|
6952
7001
|
{
|
|
6953
7002
|
"name": "sendInfo",
|
|
@@ -6976,7 +7025,11 @@
|
|
|
6976
7025
|
"items": {
|
|
6977
7026
|
"$ref": "messages.MessageHeader"
|
|
6978
7027
|
},
|
|
6979
|
-
"description": "Copies of the sent message. The number of created copies depends on the applied file carbon copy configuration (fcc)."
|
|
7028
|
+
"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."
|
|
7029
|
+
},
|
|
7030
|
+
"details": {
|
|
7031
|
+
"$ref": "ComposeDetails",
|
|
7032
|
+
"description": "The $(ref:compose.ComposeDetails) of the send message."
|
|
6980
7033
|
}
|
|
6981
7034
|
}
|
|
6982
7035
|
}
|
|
@@ -7017,7 +7070,11 @@
|
|
|
7017
7070
|
"items": {
|
|
7018
7071
|
"$ref": "messages.MessageHeader"
|
|
7019
7072
|
},
|
|
7020
|
-
"description": "An array with exactly one element, the saved message."
|
|
7073
|
+
"description": "An array with exactly one element, the saved message. The <permission>messagesRead</permission> permission is required for this property to be included."
|
|
7074
|
+
},
|
|
7075
|
+
"details": {
|
|
7076
|
+
"$ref": "ComposeDetails",
|
|
7077
|
+
"description": "The $(ref:compose.ComposeDetails) of the saved message."
|
|
7021
7078
|
}
|
|
7022
7079
|
}
|
|
7023
7080
|
}
|
|
@@ -9912,7 +9969,7 @@
|
|
|
9912
9969
|
{
|
|
9913
9970
|
"name": "key",
|
|
9914
9971
|
"type": "string",
|
|
9915
|
-
"description": "The tag key of the requested folder. See $(ref:messages.tags.list
|
|
9972
|
+
"description": "The tag key of the requested folder. See $(ref:messages.tags.list) for the available tags. Throws when specifying an invalid tag key."
|
|
9916
9973
|
},
|
|
9917
9974
|
{
|
|
9918
9975
|
"type": "function",
|
|
@@ -10849,7 +10906,7 @@
|
|
|
10849
10906
|
{
|
|
10850
10907
|
"name": "getListedMessages",
|
|
10851
10908
|
"type": "function",
|
|
10852
|
-
"description": "Lists the messages in the current view, honoring sort order and filters.",
|
|
10909
|
+
"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",
|
|
10853
10910
|
"permissions": [
|
|
10854
10911
|
"messagesRead"
|
|
10855
10912
|
],
|
|
@@ -10862,6 +10919,40 @@
|
|
|
10862
10919
|
"optional": true,
|
|
10863
10920
|
"minimum": 1
|
|
10864
10921
|
},
|
|
10922
|
+
{
|
|
10923
|
+
"name": "options",
|
|
10924
|
+
"type": "object",
|
|
10925
|
+
"optional": true,
|
|
10926
|
+
"properties": {
|
|
10927
|
+
"sortType": {
|
|
10928
|
+
"type": "string",
|
|
10929
|
+
"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.",
|
|
10930
|
+
"optional": true,
|
|
10931
|
+
"enum": [
|
|
10932
|
+
"author",
|
|
10933
|
+
"date",
|
|
10934
|
+
"flagged",
|
|
10935
|
+
"junk",
|
|
10936
|
+
"junkScore",
|
|
10937
|
+
"priority",
|
|
10938
|
+
"read",
|
|
10939
|
+
"recipients",
|
|
10940
|
+
"size",
|
|
10941
|
+
"subject",
|
|
10942
|
+
"tags"
|
|
10943
|
+
]
|
|
10944
|
+
},
|
|
10945
|
+
"sortOrder": {
|
|
10946
|
+
"type": "string",
|
|
10947
|
+
"optional": true,
|
|
10948
|
+
"description": "The sort order for the returned messages. Ignored if <var>sortType</var> is not specified.",
|
|
10949
|
+
"enum": [
|
|
10950
|
+
"ascending",
|
|
10951
|
+
"descending"
|
|
10952
|
+
]
|
|
10953
|
+
}
|
|
10954
|
+
}
|
|
10955
|
+
},
|
|
10865
10956
|
{
|
|
10866
10957
|
"type": "function",
|
|
10867
10958
|
"name": "callback",
|
|
@@ -11257,7 +11348,7 @@
|
|
|
11257
11348
|
"selectedMessages": {
|
|
11258
11349
|
"$ref": "messages.MessageList",
|
|
11259
11350
|
"optional": true,
|
|
11260
|
-
"description": "The selected message(s) in the message list (a.k.a. the thread pane). Only available for the <var>message_list</var> context. The <permission>messagesRead</permission> permission is required. The returned selection includes the messages which would be affected by a context action through
|
|
11351
|
+
"description": "The selected message(s) in the message list (a.k.a. the thread pane). Only available for the <var>message_list</var> context. The <permission>messagesRead</permission> permission is required. The returned selection includes the messages which would be affected by a context action through Thunderbird's UI, which may not be the currently selected messages. For example, if the user has multiple messages selected and opens the context menu for a message outside that selection, only the message for which the context menu was opened, is returned."
|
|
11261
11352
|
},
|
|
11262
11353
|
"displayedFolder": {
|
|
11263
11354
|
"$ref": "folders.MailFolder",
|
|
@@ -11277,7 +11368,7 @@
|
|
|
11277
11368
|
"$ref": "folders.MailFolder"
|
|
11278
11369
|
},
|
|
11279
11370
|
"optional": true,
|
|
11280
|
-
"description": "The selected folders in the folder pane. Only available for the <var>folder_pane</var> context. The <permission>accountsRead</permission> permission is required. The returned selection includes the folders which would be affected by a context action through
|
|
11371
|
+
"description": "The selected folders in the folder pane. Only available for the <var>folder_pane</var> context. The <permission>accountsRead</permission> permission is required. The returned selection includes the folders which would be affected by a context action through Thunderbird's UI, which may not be the currently selected folders. For example, if the user has multiple folders selected and opens the context menu for a folder outside that selection, only the folder for which the context menu was opened, is returned."
|
|
11281
11372
|
},
|
|
11282
11373
|
"selectedAccount": {
|
|
11283
11374
|
"$ref": "accounts.MailAccount",
|
|
@@ -11431,7 +11522,7 @@
|
|
|
11431
11522
|
"selectedMessages": {
|
|
11432
11523
|
"$ref": "messages.MessageList",
|
|
11433
11524
|
"optional": true,
|
|
11434
|
-
"description": "The selected message(s) in the message list (a.k.a. the thread pane). Only available for the <var>message_list</var> context. The <permission>messagesRead</permission> permission is required. The returned selection includes the messages which would be affected by a context action through
|
|
11525
|
+
"description": "The selected message(s) in the message list (a.k.a. the thread pane). Only available for the <var>message_list</var> context. The <permission>messagesRead</permission> permission is required. The returned selection includes the messages which would be affected by a context action through Thunderbird's UI, which may not be the currently selected messages. For example, if the user has multiple messages selected and opens the context menu for a message outside that selection, only the message for which the context menu was opened, is returned."
|
|
11435
11526
|
},
|
|
11436
11527
|
"displayedFolder": {
|
|
11437
11528
|
"$ref": "folders.MailFolder",
|
|
@@ -11451,7 +11542,7 @@
|
|
|
11451
11542
|
"$ref": "folders.MailFolder"
|
|
11452
11543
|
},
|
|
11453
11544
|
"optional": true,
|
|
11454
|
-
"description": "The selected folders in the folder pane. Only available for the <var>folder_pane</var> context. The <permission>accountsRead</permission> permission is required. The returned selection includes the folders which would be affected by a context action through
|
|
11545
|
+
"description": "The selected folders in the folder pane. Only available for the <var>folder_pane</var> context. The <permission>accountsRead</permission> permission is required. The returned selection includes the folders which would be affected by a context action through Thunderbird's UI, which may not be the currently selected folders. For example, if the user has multiple folders selected and opens the context menu for a folder outside that selection, only the folder for which the context menu was opened, is returned."
|
|
11455
11546
|
},
|
|
11456
11547
|
"selectedAccount": {
|
|
11457
11548
|
"$ref": "accounts.MailAccount",
|
|
@@ -13055,6 +13146,7 @@
|
|
|
13055
13146
|
}
|
|
13056
13147
|
},
|
|
13057
13148
|
"date": {
|
|
13149
|
+
"description": "The date and time when the message was sent, according to the Date header in the message.",
|
|
13058
13150
|
"$ref": "extensionTypes.Date"
|
|
13059
13151
|
},
|
|
13060
13152
|
"external": {
|
|
@@ -13091,6 +13183,18 @@
|
|
|
13091
13183
|
"minimum": 0,
|
|
13092
13184
|
"maximum": 100
|
|
13093
13185
|
},
|
|
13186
|
+
"priority": {
|
|
13187
|
+
"type": "string",
|
|
13188
|
+
"description": "The priority of the message.",
|
|
13189
|
+
"enum": [
|
|
13190
|
+
"none",
|
|
13191
|
+
"lowest",
|
|
13192
|
+
"low",
|
|
13193
|
+
"normal",
|
|
13194
|
+
"high",
|
|
13195
|
+
"highest"
|
|
13196
|
+
]
|
|
13197
|
+
},
|
|
13094
13198
|
"read": {
|
|
13095
13199
|
"type": "boolean",
|
|
13096
13200
|
"optional": true,
|
|
@@ -13174,15 +13278,9 @@
|
|
|
13174
13278
|
]
|
|
13175
13279
|
},
|
|
13176
13280
|
"headers": {
|
|
13177
|
-
"
|
|
13281
|
+
"$ref": "messages.HeadersDictionary",
|
|
13178
13282
|
"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).",
|
|
13179
|
-
"optional": true
|
|
13180
|
-
"additionalProperties": {
|
|
13181
|
-
"type": "array",
|
|
13182
|
-
"items": {
|
|
13183
|
-
"type": "string"
|
|
13184
|
-
}
|
|
13185
|
-
}
|
|
13283
|
+
"optional": true
|
|
13186
13284
|
},
|
|
13187
13285
|
"name": {
|
|
13188
13286
|
"type": "string",
|
|
@@ -13208,15 +13306,9 @@
|
|
|
13208
13306
|
"optional": true
|
|
13209
13307
|
},
|
|
13210
13308
|
"rawHeaders": {
|
|
13211
|
-
"
|
|
13309
|
+
"$ref": "messages.HeadersDictionary",
|
|
13212
13310
|
"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).",
|
|
13213
|
-
"optional": true
|
|
13214
|
-
"additionalProperties": {
|
|
13215
|
-
"type": "array",
|
|
13216
|
-
"items": {
|
|
13217
|
-
"type": "string"
|
|
13218
|
-
}
|
|
13219
|
-
}
|
|
13311
|
+
"optional": true
|
|
13220
13312
|
},
|
|
13221
13313
|
"size": {
|
|
13222
13314
|
"type": "integer",
|
|
@@ -13274,14 +13366,8 @@
|
|
|
13274
13366
|
"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."
|
|
13275
13367
|
},
|
|
13276
13368
|
"headers": {
|
|
13277
|
-
"
|
|
13278
|
-
"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>."
|
|
13279
|
-
"additionalProperties": {
|
|
13280
|
-
"type": "array",
|
|
13281
|
-
"items": {
|
|
13282
|
-
"type": "string"
|
|
13283
|
-
}
|
|
13284
|
-
}
|
|
13369
|
+
"$ref": "messages.HeadersDictionary",
|
|
13370
|
+
"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>."
|
|
13285
13371
|
},
|
|
13286
13372
|
"name": {
|
|
13287
13373
|
"type": "string",
|
|
@@ -13307,6 +13393,17 @@
|
|
|
13307
13393
|
}
|
|
13308
13394
|
}
|
|
13309
13395
|
},
|
|
13396
|
+
{
|
|
13397
|
+
"id": "HeadersDictionary",
|
|
13398
|
+
"type": "object",
|
|
13399
|
+
"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>.",
|
|
13400
|
+
"additionalProperties": {
|
|
13401
|
+
"type": "array",
|
|
13402
|
+
"items": {
|
|
13403
|
+
"type": "string"
|
|
13404
|
+
}
|
|
13405
|
+
}
|
|
13406
|
+
},
|
|
13310
13407
|
{
|
|
13311
13408
|
"id": "QueryRange",
|
|
13312
13409
|
"type": "object",
|
|
@@ -13437,6 +13534,40 @@
|
|
|
13437
13534
|
"name": "folderId",
|
|
13438
13535
|
"$ref": "folders.MailFolderId"
|
|
13439
13536
|
},
|
|
13537
|
+
{
|
|
13538
|
+
"name": "options",
|
|
13539
|
+
"type": "object",
|
|
13540
|
+
"optional": true,
|
|
13541
|
+
"properties": {
|
|
13542
|
+
"sortType": {
|
|
13543
|
+
"type": "string",
|
|
13544
|
+
"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.",
|
|
13545
|
+
"optional": true,
|
|
13546
|
+
"enum": [
|
|
13547
|
+
"author",
|
|
13548
|
+
"date",
|
|
13549
|
+
"flagged",
|
|
13550
|
+
"junk",
|
|
13551
|
+
"junkScore",
|
|
13552
|
+
"priority",
|
|
13553
|
+
"read",
|
|
13554
|
+
"recipients",
|
|
13555
|
+
"size",
|
|
13556
|
+
"subject",
|
|
13557
|
+
"tags"
|
|
13558
|
+
]
|
|
13559
|
+
},
|
|
13560
|
+
"sortOrder": {
|
|
13561
|
+
"type": "string",
|
|
13562
|
+
"description": "The sort order for the returned messages. Ignored if <var>sortType</var> is not specified.",
|
|
13563
|
+
"optional": true,
|
|
13564
|
+
"enum": [
|
|
13565
|
+
"ascending",
|
|
13566
|
+
"descending"
|
|
13567
|
+
]
|
|
13568
|
+
}
|
|
13569
|
+
}
|
|
13570
|
+
},
|
|
13440
13571
|
{
|
|
13441
13572
|
"type": "function",
|
|
13442
13573
|
"name": "callback",
|
|
@@ -13471,6 +13602,40 @@
|
|
|
13471
13602
|
}
|
|
13472
13603
|
]
|
|
13473
13604
|
},
|
|
13605
|
+
{
|
|
13606
|
+
"name": "options",
|
|
13607
|
+
"type": "object",
|
|
13608
|
+
"optional": true,
|
|
13609
|
+
"properties": {
|
|
13610
|
+
"sortType": {
|
|
13611
|
+
"type": "string",
|
|
13612
|
+
"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.",
|
|
13613
|
+
"optional": true,
|
|
13614
|
+
"enum": [
|
|
13615
|
+
"author",
|
|
13616
|
+
"date",
|
|
13617
|
+
"flagged",
|
|
13618
|
+
"junk",
|
|
13619
|
+
"junkScore",
|
|
13620
|
+
"priority",
|
|
13621
|
+
"read",
|
|
13622
|
+
"recipients",
|
|
13623
|
+
"size",
|
|
13624
|
+
"subject",
|
|
13625
|
+
"tags"
|
|
13626
|
+
]
|
|
13627
|
+
},
|
|
13628
|
+
"sortOrder": {
|
|
13629
|
+
"type": "string",
|
|
13630
|
+
"optional": true,
|
|
13631
|
+
"description": "The sort order for the returned messages. Ignored if <var>sortType</var> is not specified.",
|
|
13632
|
+
"enum": [
|
|
13633
|
+
"ascending",
|
|
13634
|
+
"descending"
|
|
13635
|
+
]
|
|
13636
|
+
}
|
|
13637
|
+
}
|
|
13638
|
+
},
|
|
13474
13639
|
{
|
|
13475
13640
|
"type": "function",
|
|
13476
13641
|
"name": "callback",
|
|
@@ -13583,6 +13748,40 @@
|
|
|
13583
13748
|
}
|
|
13584
13749
|
]
|
|
13585
13750
|
},
|
|
13751
|
+
{
|
|
13752
|
+
"name": "getHeaders",
|
|
13753
|
+
"type": "function",
|
|
13754
|
+
"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.",
|
|
13755
|
+
"async": "callback",
|
|
13756
|
+
"parameters": [
|
|
13757
|
+
{
|
|
13758
|
+
"name": "messageId",
|
|
13759
|
+
"$ref": "messages.MessageId"
|
|
13760
|
+
},
|
|
13761
|
+
{
|
|
13762
|
+
"name": "options",
|
|
13763
|
+
"type": "object",
|
|
13764
|
+
"properties": {
|
|
13765
|
+
"decodeHeaders": {
|
|
13766
|
+
"type": "boolean",
|
|
13767
|
+
"description": "Whether to decode RFC 2047 encoded headers. Defaults to <var>true</var>.",
|
|
13768
|
+
"optional": true
|
|
13769
|
+
}
|
|
13770
|
+
},
|
|
13771
|
+
"optional": true
|
|
13772
|
+
},
|
|
13773
|
+
{
|
|
13774
|
+
"type": "function",
|
|
13775
|
+
"name": "callback",
|
|
13776
|
+
"optional": true,
|
|
13777
|
+
"parameters": [
|
|
13778
|
+
{
|
|
13779
|
+
"$ref": "messages.HeadersDictionary"
|
|
13780
|
+
}
|
|
13781
|
+
]
|
|
13782
|
+
}
|
|
13783
|
+
]
|
|
13784
|
+
},
|
|
13586
13785
|
{
|
|
13587
13786
|
"name": "getRaw",
|
|
13588
13787
|
"type": "function",
|
|
@@ -13660,7 +13859,7 @@
|
|
|
13660
13859
|
{
|
|
13661
13860
|
"name": "listAttachments",
|
|
13662
13861
|
"type": "function",
|
|
13663
|
-
"description": "Lists the attachments of a message.",
|
|
13862
|
+
"description": "Lists the attachments of a message. If the message is encrypted, the attachments of the decrypted message are listed.",
|
|
13664
13863
|
"async": "callback",
|
|
13665
13864
|
"parameters": [
|
|
13666
13865
|
{
|
|
@@ -13685,7 +13884,7 @@
|
|
|
13685
13884
|
{
|
|
13686
13885
|
"name": "listInlineTextParts",
|
|
13687
13886
|
"type": "function",
|
|
13688
|
-
"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.",
|
|
13887
|
+
"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.",
|
|
13689
13888
|
"async": "callback",
|
|
13690
13889
|
"parameters": [
|
|
13691
13890
|
{
|
|
@@ -13710,7 +13909,7 @@
|
|
|
13710
13909
|
{
|
|
13711
13910
|
"name": "getAttachmentFile",
|
|
13712
13911
|
"type": "function",
|
|
13713
|
-
"description": "Gets the content of a $(ref:messages.MessageAttachment) as a $(url:dom-file)[File] object.",
|
|
13912
|
+
"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.",
|
|
13714
13913
|
"async": "callback",
|
|
13715
13914
|
"parameters": [
|
|
13716
13915
|
{
|
|
@@ -13719,6 +13918,7 @@
|
|
|
13719
13918
|
},
|
|
13720
13919
|
{
|
|
13721
13920
|
"name": "partName",
|
|
13921
|
+
"description": "The <var>partName</var> of an attachment to be retrieved from the decrypted message.",
|
|
13722
13922
|
"type": "string",
|
|
13723
13923
|
"pattern": "^\\d+(\\.\\d+\\$?)*$"
|
|
13724
13924
|
},
|
|
@@ -13739,7 +13939,7 @@
|
|
|
13739
13939
|
{
|
|
13740
13940
|
"name": "deleteAttachments",
|
|
13741
13941
|
"type": "function",
|
|
13742
|
-
"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.",
|
|
13942
|
+
"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>.",
|
|
13743
13943
|
"permissions": [
|
|
13744
13944
|
"messagesModifyPermanent"
|
|
13745
13945
|
],
|
|
@@ -14493,10 +14693,11 @@
|
|
|
14493
14693
|
},
|
|
14494
14694
|
"mode": {
|
|
14495
14695
|
"type": "string",
|
|
14496
|
-
"description": "Whether all of the tag filters must apply,
|
|
14696
|
+
"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.",
|
|
14497
14697
|
"enum": [
|
|
14498
14698
|
"all",
|
|
14499
|
-
"any"
|
|
14699
|
+
"any",
|
|
14700
|
+
"none"
|
|
14500
14701
|
]
|
|
14501
14702
|
}
|
|
14502
14703
|
}
|
|
@@ -14547,7 +14748,7 @@
|
|
|
14547
14748
|
"type": "function",
|
|
14548
14749
|
"description": "Fired when a message tag has been deleted.",
|
|
14549
14750
|
"permissions": [
|
|
14550
|
-
"
|
|
14751
|
+
"messagesTagsList"
|
|
14551
14752
|
],
|
|
14552
14753
|
"parameters": [
|
|
14553
14754
|
{
|
|
@@ -14688,13 +14889,17 @@
|
|
|
14688
14889
|
"messengerSettings"
|
|
14689
14890
|
],
|
|
14690
14891
|
"properties": {
|
|
14892
|
+
"messageLineLengthLimit": {
|
|
14893
|
+
"$ref": "types.Setting",
|
|
14894
|
+
"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."
|
|
14895
|
+
},
|
|
14691
14896
|
"messagePlainTextFlowedOutputEnabled": {
|
|
14692
14897
|
"$ref": "types.Setting",
|
|
14693
|
-
"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)."
|
|
14898
|
+
"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."
|
|
14694
14899
|
},
|
|
14695
|
-
"
|
|
14900
|
+
"readerDisplayAttachmentsInline": {
|
|
14696
14901
|
"$ref": "types.Setting",
|
|
14697
|
-
"description": "
|
|
14902
|
+
"description": "Whether supported attachments (for example, media files) are shown inline within the body of displayed messages. This property is read-only."
|
|
14698
14903
|
}
|
|
14699
14904
|
}
|
|
14700
14905
|
}
|
|
@@ -14826,10 +15031,33 @@
|
|
|
14826
15031
|
"description": "The string to be parsed (e.g. <var>User <user@example.com>, other-user@example.com</var>)"
|
|
14827
15032
|
},
|
|
14828
15033
|
{
|
|
14829
|
-
"
|
|
14830
|
-
"name": "preserveGroups",
|
|
15034
|
+
"name": "options",
|
|
14831
15035
|
"optional": true,
|
|
14832
|
-
"
|
|
15036
|
+
"choices": [
|
|
15037
|
+
{
|
|
15038
|
+
"type": "boolean",
|
|
15039
|
+
"deprecated": "Specify the options object instead of a plain boolean to preserve groups.",
|
|
15040
|
+
"description": "Keep grouped hierarchies. Groups may be specified in a mailbox string as follows: <var>GroupName : user1 <user1@example.com>, user2@example,com ;</var>."
|
|
15041
|
+
},
|
|
15042
|
+
{
|
|
15043
|
+
"type": "object",
|
|
15044
|
+
"properties": {
|
|
15045
|
+
"preserveGroups": {
|
|
15046
|
+
"type": "boolean",
|
|
15047
|
+
"optional": true,
|
|
15048
|
+
"description": "Keep grouped hierarchies. Groups may be specified in a mailbox string as follows: <var>GroupName : user1 <user1@example.com>, user2@example,com ;</var>."
|
|
15049
|
+
},
|
|
15050
|
+
"expandMailingLists": {
|
|
15051
|
+
"type": "boolean",
|
|
15052
|
+
"optional": true,
|
|
15053
|
+
"permissions": [
|
|
15054
|
+
"addressBooks"
|
|
15055
|
+
],
|
|
15056
|
+
"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."
|
|
15057
|
+
}
|
|
15058
|
+
}
|
|
15059
|
+
}
|
|
15060
|
+
]
|
|
14833
15061
|
},
|
|
14834
15062
|
{
|
|
14835
15063
|
"type": "function",
|
|
@@ -16170,7 +16398,7 @@
|
|
|
16170
16398
|
"title": {
|
|
16171
16399
|
"type": "string",
|
|
16172
16400
|
"optional": true,
|
|
16173
|
-
"description": "Match page titles against a pattern."
|
|
16401
|
+
"description": "Match page titles against a pattern. The <permission>tabs</permission> permission is required to use this property."
|
|
16174
16402
|
},
|
|
16175
16403
|
"url": {
|
|
16176
16404
|
"choices": [
|
|
@@ -16185,7 +16413,7 @@
|
|
|
16185
16413
|
}
|
|
16186
16414
|
],
|
|
16187
16415
|
"optional": true,
|
|
16188
|
-
"description": "Match tabs against one or more $(url:match-patterns)[URL Patterns]. Fragment identifiers are not matched."
|
|
16416
|
+
"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."
|
|
16189
16417
|
},
|
|
16190
16418
|
"windowId": {
|
|
16191
16419
|
"type": "integer",
|
|
@@ -16284,7 +16512,7 @@
|
|
|
16284
16512
|
{
|
|
16285
16513
|
"name": "move",
|
|
16286
16514
|
"type": "function",
|
|
16287
|
-
"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>.",
|
|
16515
|
+
"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.",
|
|
16288
16516
|
"async": "callback",
|
|
16289
16517
|
"parameters": [
|
|
16290
16518
|
{
|