webext-schema 5.6.0 → 6.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/modules/browser.js +5 -5
- package/modules/common.js +7 -7
- package/modules/schema.js +5 -5
- package/modules/update.js +0 -4
- package/package.json +16 -17
- package/schemas/beta/webext.json +103 -167
- package/schemas/central/webext.json +91 -165
- package/schemas/mail/mailext.json +246 -169
- package/types/modules/browser.d.ts +5 -5
- package/types/modules/common.d.ts +5 -5
- package/schemas/release/webext.json +0 -22069
|
@@ -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
|
{
|
|
@@ -893,6 +898,28 @@
|
|
|
893
898
|
"description": "Message localized for current locale."
|
|
894
899
|
}
|
|
895
900
|
},
|
|
901
|
+
{
|
|
902
|
+
"name": "getPreferredSystemLanguages",
|
|
903
|
+
"type": "function",
|
|
904
|
+
"async": "callback",
|
|
905
|
+
"description": "Gets the preferred locales of the operating system. This is different from the locales set in the browser; to get those, use $(ref:i18n.getAcceptLanguages).",
|
|
906
|
+
"parameters": [
|
|
907
|
+
{
|
|
908
|
+
"type": "function",
|
|
909
|
+
"name": "callback",
|
|
910
|
+
"parameters": [
|
|
911
|
+
{
|
|
912
|
+
"name": "languages",
|
|
913
|
+
"type": "array",
|
|
914
|
+
"items": {
|
|
915
|
+
"$ref": "LanguageCode"
|
|
916
|
+
},
|
|
917
|
+
"description": "Array of LanguageCode"
|
|
918
|
+
}
|
|
919
|
+
]
|
|
920
|
+
}
|
|
921
|
+
]
|
|
922
|
+
},
|
|
896
923
|
{
|
|
897
924
|
"name": "getUILanguage",
|
|
898
925
|
"type": "function",
|
|
@@ -1010,7 +1037,7 @@
|
|
|
1010
1037
|
},
|
|
1011
1038
|
{
|
|
1012
1039
|
"id": "ExtensionInstallType",
|
|
1013
|
-
"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>",
|
|
1014
1041
|
"type": "string",
|
|
1015
1042
|
"enum": [
|
|
1016
1043
|
"development",
|
|
@@ -1789,6 +1816,7 @@
|
|
|
1789
1816
|
"aarch64",
|
|
1790
1817
|
"arm",
|
|
1791
1818
|
"ppc64",
|
|
1819
|
+
"riscv64",
|
|
1792
1820
|
"s390x",
|
|
1793
1821
|
"sparc64",
|
|
1794
1822
|
"x86-32",
|
|
@@ -2165,7 +2193,7 @@
|
|
|
2165
2193
|
],
|
|
2166
2194
|
"returns": {
|
|
2167
2195
|
"$ref": "Port",
|
|
2168
|
-
"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. "
|
|
2169
2197
|
}
|
|
2170
2198
|
},
|
|
2171
2199
|
{
|
|
@@ -2610,7 +2638,7 @@
|
|
|
2610
2638
|
"choices": [
|
|
2611
2639
|
{
|
|
2612
2640
|
"type": "string",
|
|
2613
|
-
"description": "A string containing a valid
|
|
2641
|
+
"description": "A string containing a valid $(url:css-color-string)[CSS color string], including hexadecimal or functional representations. For example the color *crimson* can be specified as: <li><var>crimson</var> <li><var>#dc143c</var> <li><var>rgb(220, 20, 60)</var> (or <var>rgba(220, 20, 60, 0.5)</var> to set 50% opacity) <li><var>hsl(348, 83%, 47%)</var> (or <var>hsla(348, 83%, 47%, 0.5)</var> to set 50% opacity)"
|
|
2614
2642
|
},
|
|
2615
2643
|
{
|
|
2616
2644
|
"type": "array",
|
|
@@ -2641,13 +2669,13 @@
|
|
|
2641
2669
|
"properties": {
|
|
2642
2670
|
"stylesheet": {
|
|
2643
2671
|
"optional": true,
|
|
2644
|
-
"description": "URL to a stylesheet introducing additional CSS variables, extending the theme-able areas of Thunderbird.
|
|
2672
|
+
"description": "URL to a stylesheet introducing additional CSS variables, extending the theme-able areas of Thunderbird.",
|
|
2645
2673
|
"$ref": "ExtensionURL"
|
|
2646
2674
|
},
|
|
2647
2675
|
"images": {
|
|
2648
2676
|
"type": "object",
|
|
2649
2677
|
"optional": true,
|
|
2650
|
-
"description": "A <em>dictionary object</em> with one or more <em>key-value</em> pairs to map new theme image keys to internal Thunderbird CSS image variables. The new image key is usable as an image reference in $(ref:theme.ThemeType).
|
|
2678
|
+
"description": "A <em>dictionary object</em> with one or more <em>key-value</em> pairs to map new theme image keys to internal Thunderbird CSS image variables. The new image key is usable as an image reference in $(ref:theme.ThemeType).",
|
|
2651
2679
|
"additionalProperties": {
|
|
2652
2680
|
"type": "string"
|
|
2653
2681
|
}
|
|
@@ -2655,7 +2683,7 @@
|
|
|
2655
2683
|
"colors": {
|
|
2656
2684
|
"type": "object",
|
|
2657
2685
|
"optional": true,
|
|
2658
|
-
"description": "A <em>dictionary object</em> with one or more <em>key-value</em> pairs to map new theme color keys to internal Thunderbird CSS color variables. The
|
|
2686
|
+
"description": "A <em>dictionary object</em> with one or more <em>key-value</em> pairs to map new theme color keys to internal Thunderbird CSS color variables. The new color key is usable as a color reference in $(ref:theme.ThemeType).",
|
|
2659
2687
|
"additionalProperties": {
|
|
2660
2688
|
"type": "string"
|
|
2661
2689
|
}
|
|
@@ -2663,7 +2691,7 @@
|
|
|
2663
2691
|
"properties": {
|
|
2664
2692
|
"type": "object",
|
|
2665
2693
|
"optional": true,
|
|
2666
|
-
"description": "A <em>dictionary object</em> with one or more <em>key-value</em> pairs to map new theme property keys to internal Thunderbird CSS property variables. The new property key is usable as a property reference in $(ref:theme.ThemeType).
|
|
2694
|
+
"description": "A <em>dictionary object</em> with one or more <em>key-value</em> pairs to map new theme property keys to internal Thunderbird CSS property variables. The new property key is usable as a property reference in $(ref:theme.ThemeType).",
|
|
2667
2695
|
"additionalProperties": {
|
|
2668
2696
|
"type": "string"
|
|
2669
2697
|
}
|
|
@@ -3005,12 +3033,13 @@
|
|
|
3005
3033
|
"$import": "manifest.ManifestBase",
|
|
3006
3034
|
"properties": {
|
|
3007
3035
|
"theme": {
|
|
3008
|
-
"$ref": "ThemeType"
|
|
3036
|
+
"$ref": "ThemeType",
|
|
3037
|
+
"description": "Properties for a static theme. A static theme must not contain any other WebExtension logic. If additional logic is required, request the <permission>theme</permission> permission and load/update the theme dynamically. More information about themes can be found in the $(url:dtn-web-extension-themes)[theme guide]"
|
|
3009
3038
|
},
|
|
3010
3039
|
"dark_theme": {
|
|
3011
3040
|
"$ref": "ThemeType",
|
|
3012
3041
|
"optional": true,
|
|
3013
|
-
"description": "Fallback properties for the dark system theme."
|
|
3042
|
+
"description": "Fallback properties for the dark system theme in a static theme."
|
|
3014
3043
|
},
|
|
3015
3044
|
"default_locale": {
|
|
3016
3045
|
"type": "string",
|
|
@@ -3166,6 +3195,7 @@
|
|
|
3166
3195
|
},
|
|
3167
3196
|
{
|
|
3168
3197
|
"namespace": "accounts",
|
|
3198
|
+
"description": "The accounts API provides access to the user's server accounts.",
|
|
3169
3199
|
"permissions": [
|
|
3170
3200
|
"accountsRead"
|
|
3171
3201
|
],
|
|
@@ -3235,6 +3265,7 @@
|
|
|
3235
3265
|
"max_manifest_version": 2,
|
|
3236
3266
|
"type": "string",
|
|
3237
3267
|
"enum": [
|
|
3268
|
+
"ews",
|
|
3238
3269
|
"imap",
|
|
3239
3270
|
"nntp",
|
|
3240
3271
|
"none",
|
|
@@ -3246,6 +3277,7 @@
|
|
|
3246
3277
|
"min_manifest_version": 3,
|
|
3247
3278
|
"type": "string",
|
|
3248
3279
|
"enum": [
|
|
3280
|
+
"ews",
|
|
3249
3281
|
"imap",
|
|
3250
3282
|
"local",
|
|
3251
3283
|
"nntp",
|
|
@@ -3586,6 +3618,7 @@
|
|
|
3586
3618
|
},
|
|
3587
3619
|
{
|
|
3588
3620
|
"namespace": "addressBooks",
|
|
3621
|
+
"description": "The addressBooks API allows to access and manage the user's address books.",
|
|
3589
3622
|
"permissions": [
|
|
3590
3623
|
"addressBooks"
|
|
3591
3624
|
],
|
|
@@ -3834,6 +3867,7 @@
|
|
|
3834
3867
|
},
|
|
3835
3868
|
{
|
|
3836
3869
|
"namespace": "addressBooks.provider",
|
|
3870
|
+
"description": "The address book provider API allows to add address books, which are not stored or cached by Thunderbird itself, but are handled completely by the extension. Address books created by the this API will forward all access requests to the WebExtension.",
|
|
3837
3871
|
"permissions": [
|
|
3838
3872
|
"addressBooks"
|
|
3839
3873
|
],
|
|
@@ -3842,7 +3876,7 @@
|
|
|
3842
3876
|
"name": "onSearchRequest",
|
|
3843
3877
|
"max_manifest_version": 2,
|
|
3844
3878
|
"type": "function",
|
|
3845
|
-
"description": "Registering this listener will create a read-only address book, similar to an LDAP address book. When selecting this address book, users will first see no contacts, but they can search for
|
|
3879
|
+
"description": "Registering this listener will create a read-only address book, similar to an LDAP address book. When selecting this address book, users will first see no contacts, but they can search for contacts, which will fire this event. Contacts returned by the listener callback will be displayed as contact cards in the address book. Several listeners can be registered, to create multiple address books.",
|
|
3846
3880
|
"parameters": [
|
|
3847
3881
|
{
|
|
3848
3882
|
"name": "node",
|
|
@@ -3857,7 +3891,7 @@
|
|
|
3857
3891
|
{
|
|
3858
3892
|
"name": "query",
|
|
3859
3893
|
"type": "string",
|
|
3860
|
-
"description": "The boolean query expression corresponding to the search.
|
|
3894
|
+
"description": "The boolean query expression corresponding to the search.",
|
|
3861
3895
|
"optional": true
|
|
3862
3896
|
}
|
|
3863
3897
|
],
|
|
@@ -3884,13 +3918,27 @@
|
|
|
3884
3918
|
}
|
|
3885
3919
|
}
|
|
3886
3920
|
}
|
|
3887
|
-
]
|
|
3921
|
+
],
|
|
3922
|
+
"returns": {
|
|
3923
|
+
"type": "object",
|
|
3924
|
+
"properties": {
|
|
3925
|
+
"results": {
|
|
3926
|
+
"type": "array",
|
|
3927
|
+
"items": {
|
|
3928
|
+
"$ref": "ContactProperties"
|
|
3929
|
+
}
|
|
3930
|
+
},
|
|
3931
|
+
"isCompleteResult": {
|
|
3932
|
+
"type": "boolean"
|
|
3933
|
+
}
|
|
3934
|
+
}
|
|
3935
|
+
}
|
|
3888
3936
|
},
|
|
3889
3937
|
{
|
|
3890
3938
|
"name": "onSearchRequest",
|
|
3891
3939
|
"min_manifest_version": 3,
|
|
3892
3940
|
"type": "function",
|
|
3893
|
-
"description": "Registering this listener will create a read-only address book, similar to an LDAP address book. When selecting this address book, users will first see no contacts, but they can search for
|
|
3941
|
+
"description": "Registering this listener will create a read-only address book, similar to an LDAP address book. When selecting this address book, users will first see no contacts, but they can search for contacts, which will fire this event. Contacts returned by the listener callback will be displayed as contact cards in the address book. Several listeners can be registered, to create multiple address books.",
|
|
3894
3942
|
"parameters": [
|
|
3895
3943
|
{
|
|
3896
3944
|
"name": "node",
|
|
@@ -3905,7 +3953,7 @@
|
|
|
3905
3953
|
{
|
|
3906
3954
|
"name": "query",
|
|
3907
3955
|
"type": "string",
|
|
3908
|
-
"description": "The boolean query expression corresponding to the search.
|
|
3956
|
+
"description": "The boolean query expression corresponding to the search.",
|
|
3909
3957
|
"optional": true
|
|
3910
3958
|
}
|
|
3911
3959
|
],
|
|
@@ -3932,7 +3980,21 @@
|
|
|
3932
3980
|
}
|
|
3933
3981
|
}
|
|
3934
3982
|
}
|
|
3935
|
-
]
|
|
3983
|
+
],
|
|
3984
|
+
"returns": {
|
|
3985
|
+
"type": "object",
|
|
3986
|
+
"properties": {
|
|
3987
|
+
"results": {
|
|
3988
|
+
"type": "array",
|
|
3989
|
+
"items": {
|
|
3990
|
+
"$ref": "ContactProperties"
|
|
3991
|
+
}
|
|
3992
|
+
},
|
|
3993
|
+
"isCompleteResult": {
|
|
3994
|
+
"type": "boolean"
|
|
3995
|
+
}
|
|
3996
|
+
}
|
|
3997
|
+
}
|
|
3936
3998
|
}
|
|
3937
3999
|
]
|
|
3938
4000
|
},
|
|
@@ -3948,6 +4010,7 @@
|
|
|
3948
4010
|
},
|
|
3949
4011
|
{
|
|
3950
4012
|
"namespace": "contacts",
|
|
4013
|
+
"description": "The contacts API allows to access and manage the user's contacts.",
|
|
3951
4014
|
"max_manifest_version": 2,
|
|
3952
4015
|
"permissions": [
|
|
3953
4016
|
"addressBooks"
|
|
@@ -4036,7 +4099,7 @@
|
|
|
4036
4099
|
{
|
|
4037
4100
|
"id": "ContactProperties",
|
|
4038
4101
|
"type": "object",
|
|
4039
|
-
"description": "A set of individual properties for a particular contact, and its vCard string. Further information can be found in $(doc:
|
|
4102
|
+
"description": "A set of individual properties for a particular contact, and its vCard string. Further information can be found in $(doc:guides/vcard).",
|
|
4040
4103
|
"patternProperties": {
|
|
4041
4104
|
"^\\w+$": {
|
|
4042
4105
|
"choices": [
|
|
@@ -4259,13 +4322,14 @@
|
|
|
4259
4322
|
{
|
|
4260
4323
|
"name": "id",
|
|
4261
4324
|
"type": "string",
|
|
4262
|
-
"description": "Assigns the contact an id. If an existing contact has this id, an exception is thrown.
|
|
4325
|
+
"description": "Assigns the contact an id. If an existing contact has this id, an exception is thrown.",
|
|
4326
|
+
"deprecated": "The card's id should be specified directly in the vCard string.",
|
|
4263
4327
|
"optional": true
|
|
4264
4328
|
},
|
|
4265
4329
|
{
|
|
4266
4330
|
"name": "properties",
|
|
4267
4331
|
"$ref": "ContactProperties",
|
|
4268
|
-
"description": "The properties object for the new contact. If it includes a <var>vCard</var> member, all specified
|
|
4332
|
+
"description": "The properties object for the new contact. If it includes a <var>vCard</var> member, all specified $(url:legacy-properties)[legacy properties] are ignored and the new contact will be based on the provided vCard string. If a UID is specified in the vCard string, which is already used by another contact, an exception is thrown."
|
|
4269
4333
|
},
|
|
4270
4334
|
{
|
|
4271
4335
|
"type": "function",
|
|
@@ -4324,7 +4388,7 @@
|
|
|
4324
4388
|
{
|
|
4325
4389
|
"name": "properties",
|
|
4326
4390
|
"$ref": "ContactProperties",
|
|
4327
|
-
"description": "An object with properties to update the specified contact. Individual properties are removed, if they are set to <var>null</var>. If the provided object includes a <var>vCard</var> member, all specified
|
|
4391
|
+
"description": "An object with properties to update the specified contact. Individual properties are removed, if they are set to <var>null</var>. If the provided object includes a <var>vCard</var> member, all specified $(url:legacy-properties)[legacy properties] are ignored and the details of the contact will be replaced by the provided vCard. Changes to the UID will be ignored."
|
|
4328
4392
|
}
|
|
4329
4393
|
],
|
|
4330
4394
|
"description": "Updates a contact."
|
|
@@ -4423,6 +4487,7 @@
|
|
|
4423
4487
|
},
|
|
4424
4488
|
{
|
|
4425
4489
|
"namespace": "mailingLists",
|
|
4490
|
+
"description": "The mailingLists API allows to access and manage the user's mailing lists.",
|
|
4426
4491
|
"max_manifest_version": 2,
|
|
4427
4492
|
"permissions": [
|
|
4428
4493
|
"addressBooks"
|
|
@@ -4768,7 +4833,7 @@
|
|
|
4768
4833
|
"items": {
|
|
4769
4834
|
"$ref": "ThemeIcons"
|
|
4770
4835
|
},
|
|
4771
|
-
"description": "Specifies dark and light icons to be used with themes. The <var>light</var> icon is used on dark backgrounds and vice versa.
|
|
4836
|
+
"description": "Specifies dark and light icons to be used with themes. The <var>light</var> icon is used on dark backgrounds and vice versa. The default theme uses the <var>default_icon</var> for light backgrounds (if specified)."
|
|
4772
4837
|
},
|
|
4773
4838
|
"default_popup": {
|
|
4774
4839
|
"type": "string",
|
|
@@ -4780,7 +4845,7 @@
|
|
|
4780
4845
|
"browser_style": {
|
|
4781
4846
|
"type": "boolean",
|
|
4782
4847
|
"optional": true,
|
|
4783
|
-
"description": "Enable browser styles. See the
|
|
4848
|
+
"description": "Enable browser styles. See the $(url:mdn-browser-styles)[MDN documentation on browser styles] for more information.",
|
|
4784
4849
|
"default": false
|
|
4785
4850
|
},
|
|
4786
4851
|
"default_area": {
|
|
@@ -4873,7 +4938,7 @@
|
|
|
4873
4938
|
"items": {
|
|
4874
4939
|
"$ref": "ThemeIcons"
|
|
4875
4940
|
},
|
|
4876
|
-
"description": "Specifies dark and light icons to be used with themes. The <var>light</var> icon is used on dark backgrounds and vice versa.
|
|
4941
|
+
"description": "Specifies dark and light icons to be used with themes. The <var>light</var> icon is used on dark backgrounds and vice versa. The default theme uses the <var>default_icon</var> for light backgrounds (if specified)."
|
|
4877
4942
|
},
|
|
4878
4943
|
"default_popup": {
|
|
4879
4944
|
"type": "string",
|
|
@@ -4885,7 +4950,7 @@
|
|
|
4885
4950
|
"browser_style": {
|
|
4886
4951
|
"type": "boolean",
|
|
4887
4952
|
"optional": true,
|
|
4888
|
-
"description": "Enable browser styles. See the
|
|
4953
|
+
"description": "Enable browser styles. See the $(url:mdn-browser-styles)[MDN documentation on browser styles] for more information.",
|
|
4889
4954
|
"default": false
|
|
4890
4955
|
},
|
|
4891
4956
|
"default_area": {
|
|
@@ -4978,12 +5043,12 @@
|
|
|
4978
5043
|
"type": "any"
|
|
4979
5044
|
},
|
|
4980
5045
|
"postprocess": "convertImageDataToURL",
|
|
4981
|
-
"description": "Pixel data for an image. Must be an
|
|
5046
|
+
"description": "Pixel data for an image. Must be an $(url:image-data)[ImageData] object (for example, from a $(url:canvas-element)[canvas] element)."
|
|
4982
5047
|
},
|
|
4983
5048
|
{
|
|
4984
5049
|
"id": "ImageDataDictionary",
|
|
4985
5050
|
"type": "object",
|
|
4986
|
-
"description": "A <em>dictionary object</em> to specify multiple
|
|
5051
|
+
"description": "A <em>dictionary object</em> to specify multiple $(url:image-data)[ImageData] objects in different sizes, so the icon does not have to be scaled for a device with a different pixel density. Each entry is a <em>name-value</em> pair with <em>value</em> being an $(url:image-data)[ImageData] object, and <em>name</em> its size.",
|
|
4987
5052
|
"patternProperties": {
|
|
4988
5053
|
"^[1-9]\\d*$": {
|
|
4989
5054
|
"$ref": "ImageDataType"
|
|
@@ -5683,7 +5748,7 @@
|
|
|
5683
5748
|
{
|
|
5684
5749
|
"name": "onClicked",
|
|
5685
5750
|
"type": "function",
|
|
5686
|
-
"description": "Fired when an action button is clicked. This event will not fire if the action has a popup. This is a user input event handler. For asynchronous listeners some
|
|
5751
|
+
"description": "Fired when an action button is clicked. This event will not fire if the action has a popup. This is a user input event handler. For asynchronous listeners some $(url:user-input-restrictions)[restrictions] apply.",
|
|
5687
5752
|
"parameters": [
|
|
5688
5753
|
{
|
|
5689
5754
|
"name": "tab",
|
|
@@ -5930,7 +5995,7 @@
|
|
|
5930
5995
|
"properties": {
|
|
5931
5996
|
"browser_style": {
|
|
5932
5997
|
"type": "boolean",
|
|
5933
|
-
"description": "Enable browser styles in the <var>management_url</var> page. See the
|
|
5998
|
+
"description": "Enable browser styles in the <var>management_url</var> page. See the $(url:mdn-browser-styles)[MDN documentation on browser styles] for more information.",
|
|
5934
5999
|
"optional": true,
|
|
5935
6000
|
"default": false
|
|
5936
6001
|
},
|
|
@@ -5938,7 +6003,7 @@
|
|
|
5938
6003
|
"type": "string",
|
|
5939
6004
|
"optional": true,
|
|
5940
6005
|
"deprecated": true,
|
|
5941
|
-
"description": "This property is no longer used. The only supported data format for the <var>data</var> argument in $(ref:cloudFile.onFileUpload) is
|
|
6006
|
+
"description": "This property is no longer used. The only supported data format for the <var>data</var> argument in $(ref:cloudFile.onFileUpload) is $(url:dom-file)[File]."
|
|
5942
6007
|
},
|
|
5943
6008
|
"reuse_uploads": {
|
|
5944
6009
|
"description": "If a previously uploaded cloud file attachment is reused at a later time in a different message, Thunderbird may use the already known <var>url</var> and <var>templateInfo</var> values without triggering the registered $(ref:cloudFile.onFileUpload) listener again. Setting this option to <var>false</var> will always trigger the registered listener, providing the already known values through the <var>relatedFileInfo</var> parameter of the $(ref:cloudFile.onFileUpload) event, to let the provider decide how to handle these cases.",
|
|
@@ -5950,7 +6015,7 @@
|
|
|
5950
6015
|
"type": "string",
|
|
5951
6016
|
"format": "relativeUrl",
|
|
5952
6017
|
"preprocess": "localize",
|
|
5953
|
-
"description": "A page for configuring accounts, to be displayed in the preferences UI.
|
|
6018
|
+
"description": "A page for configuring accounts, to be displayed in the preferences UI."
|
|
5954
6019
|
},
|
|
5955
6020
|
"name": {
|
|
5956
6021
|
"type": "string",
|
|
@@ -5978,6 +6043,7 @@
|
|
|
5978
6043
|
},
|
|
5979
6044
|
{
|
|
5980
6045
|
"namespace": "cloudFile",
|
|
6046
|
+
"description": "The cloudFile (a.k.a. fileLink) API allows to create a provider to store large attachments in the cloud instead of attaching them directly to the message.",
|
|
5981
6047
|
"permissions": [
|
|
5982
6048
|
"manifest:cloud_file"
|
|
5983
6049
|
],
|
|
@@ -6249,7 +6315,7 @@
|
|
|
6249
6315
|
},
|
|
6250
6316
|
"format": {
|
|
6251
6317
|
"optional": true,
|
|
6252
|
-
"description": "A format options object as used by
|
|
6318
|
+
"description": "A format options object as used by $(url:date-time-format)[Intl.DateTimeFormat].",
|
|
6253
6319
|
"type": "object",
|
|
6254
6320
|
"additionalProperties": true
|
|
6255
6321
|
}
|
|
@@ -6449,6 +6515,7 @@
|
|
|
6449
6515
|
},
|
|
6450
6516
|
{
|
|
6451
6517
|
"namespace": "compose",
|
|
6518
|
+
"description": "The compose API allows to interact with the message composition window.",
|
|
6452
6519
|
"types": [
|
|
6453
6520
|
{
|
|
6454
6521
|
"id": "ComposeRecipient",
|
|
@@ -6525,9 +6592,6 @@
|
|
|
6525
6592
|
"additionalFccFolder": {
|
|
6526
6593
|
"max_manifest_version": 2,
|
|
6527
6594
|
"choices": [
|
|
6528
|
-
{
|
|
6529
|
-
"$ref": "folders.MailFolderId"
|
|
6530
|
-
},
|
|
6531
6595
|
{
|
|
6532
6596
|
"$ref": "folders.MailFolder"
|
|
6533
6597
|
},
|
|
@@ -6536,6 +6600,9 @@
|
|
|
6536
6600
|
"enum": [
|
|
6537
6601
|
""
|
|
6538
6602
|
]
|
|
6603
|
+
},
|
|
6604
|
+
{
|
|
6605
|
+
"$ref": "folders.MailFolderId"
|
|
6539
6606
|
}
|
|
6540
6607
|
],
|
|
6541
6608
|
"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.",
|
|
@@ -6549,7 +6616,7 @@
|
|
|
6549
6616
|
"attachVCard": {
|
|
6550
6617
|
"type": "boolean",
|
|
6551
6618
|
"optional": true,
|
|
6552
|
-
"description": "Whether or not the vCard of the used identity will be attached to the message during send.
|
|
6619
|
+
"description": "Whether or not the vCard of the used identity will be attached to the message during send."
|
|
6553
6620
|
},
|
|
6554
6621
|
"attachments": {
|
|
6555
6622
|
"type": "array",
|
|
@@ -6663,9 +6730,6 @@
|
|
|
6663
6730
|
"overrideDefaultFccFolder": {
|
|
6664
6731
|
"max_manifest_version": 2,
|
|
6665
6732
|
"choices": [
|
|
6666
|
-
{
|
|
6667
|
-
"$ref": "folders.MailFolderId"
|
|
6668
|
-
},
|
|
6669
6733
|
{
|
|
6670
6734
|
"$ref": "folders.MailFolder"
|
|
6671
6735
|
},
|
|
@@ -6674,6 +6738,9 @@
|
|
|
6674
6738
|
"enum": [
|
|
6675
6739
|
""
|
|
6676
6740
|
]
|
|
6741
|
+
},
|
|
6742
|
+
{
|
|
6743
|
+
"$ref": "folders.MailFolderId"
|
|
6677
6744
|
}
|
|
6678
6745
|
],
|
|
6679
6746
|
"optional": true,
|
|
@@ -6810,7 +6877,7 @@
|
|
|
6810
6877
|
},
|
|
6811
6878
|
"encryptBody": {
|
|
6812
6879
|
"type": "boolean",
|
|
6813
|
-
"description": "Whether encryption of the message body using the OpenPGP technology is enabled.
|
|
6880
|
+
"description": "Whether encryption of the message body using the OpenPGP technology is enabled."
|
|
6814
6881
|
},
|
|
6815
6882
|
"encryptSubject": {
|
|
6816
6883
|
"type": "boolean",
|
|
@@ -6832,7 +6899,7 @@
|
|
|
6832
6899
|
},
|
|
6833
6900
|
"encryptBody": {
|
|
6834
6901
|
"type": "boolean",
|
|
6835
|
-
"description": "Whether encryption of the message body using the S/MIME technology is enabled.
|
|
6902
|
+
"description": "Whether encryption of the message body using the S/MIME technology is enabled."
|
|
6836
6903
|
},
|
|
6837
6904
|
"signMessage": {
|
|
6838
6905
|
"type": "boolean",
|
|
@@ -6845,7 +6912,7 @@
|
|
|
6845
6912
|
{
|
|
6846
6913
|
"name": "onBeforeSend",
|
|
6847
6914
|
"type": "function",
|
|
6848
|
-
"description": "Fired when a message is about to be sent from the compose window. This is a user input event handler. For asynchronous listeners some
|
|
6915
|
+
"description": "Fired when a message is about to be sent from the compose window. This is a user input event handler. For asynchronous listeners some $(url:user-input-restrictions)[restrictions] apply.",
|
|
6849
6916
|
"permissions": [
|
|
6850
6917
|
"compose"
|
|
6851
6918
|
],
|
|
@@ -6956,7 +7023,7 @@
|
|
|
6956
7023
|
"items": {
|
|
6957
7024
|
"$ref": "messages.MessageHeader"
|
|
6958
7025
|
},
|
|
6959
|
-
"description": "
|
|
7026
|
+
"description": "An array with exactly one element, the saved message."
|
|
6960
7027
|
}
|
|
6961
7028
|
}
|
|
6962
7029
|
}
|
|
@@ -7051,7 +7118,7 @@
|
|
|
7051
7118
|
{
|
|
7052
7119
|
"name": "beginNew",
|
|
7053
7120
|
"type": "function",
|
|
7054
|
-
"description": "Open a new message compose window
|
|
7121
|
+
"description": "Open a new message compose window.",
|
|
7055
7122
|
"async": "callback",
|
|
7056
7123
|
"parameters": [
|
|
7057
7124
|
{
|
|
@@ -7081,7 +7148,7 @@
|
|
|
7081
7148
|
{
|
|
7082
7149
|
"name": "beginReply",
|
|
7083
7150
|
"type": "function",
|
|
7084
|
-
"description": "Open a new message compose window replying to a given message
|
|
7151
|
+
"description": "Open a new message compose window replying to a given message.",
|
|
7085
7152
|
"async": "callback",
|
|
7086
7153
|
"parameters": [
|
|
7087
7154
|
{
|
|
@@ -7120,7 +7187,7 @@
|
|
|
7120
7187
|
{
|
|
7121
7188
|
"name": "beginForward",
|
|
7122
7189
|
"type": "function",
|
|
7123
|
-
"description": "Open a new message compose window forwarding a given message
|
|
7190
|
+
"description": "Open a new message compose window forwarding a given message.",
|
|
7124
7191
|
"async": "callback",
|
|
7125
7192
|
"parameters": [
|
|
7126
7193
|
{
|
|
@@ -7185,7 +7252,7 @@
|
|
|
7185
7252
|
"name": "setComposeDetails",
|
|
7186
7253
|
"type": "function",
|
|
7187
7254
|
"async": true,
|
|
7188
|
-
"description": "Updates the compose window. The properties of the given $(ref:compose.ComposeDetails) object will be used to overwrite the current values of the specified compose window, so only properties that are to be changed should be included. Modified settings will be treated as user initiated, and turn off further automatic changes on these settings
|
|
7255
|
+
"description": "Updates the compose window. The properties of the given $(ref:compose.ComposeDetails) object will be used to overwrite the current values of the specified compose window, so only properties that are to be changed should be included. Modified settings will be treated as user initiated, and turn off further automatic changes on these settings.",
|
|
7189
7256
|
"permissions": [
|
|
7190
7257
|
"compose"
|
|
7191
7258
|
],
|
|
@@ -7281,7 +7348,7 @@
|
|
|
7281
7348
|
{
|
|
7282
7349
|
"name": "getAttachmentFile",
|
|
7283
7350
|
"type": "function",
|
|
7284
|
-
"description": "Gets the content of a $(ref:compose.ComposeAttachment) as a
|
|
7351
|
+
"description": "Gets the content of a $(ref:compose.ComposeAttachment) as a $(url:dom-file)[File] object.",
|
|
7285
7352
|
"async": "callback",
|
|
7286
7353
|
"parameters": [
|
|
7287
7354
|
{
|
|
@@ -7503,7 +7570,7 @@
|
|
|
7503
7570
|
"items": {
|
|
7504
7571
|
"$ref": "messages.MessageHeader"
|
|
7505
7572
|
},
|
|
7506
|
-
"description": "
|
|
7573
|
+
"description": "An array with exactly one element, the saved message."
|
|
7507
7574
|
}
|
|
7508
7575
|
}
|
|
7509
7576
|
}
|
|
@@ -7574,7 +7641,7 @@
|
|
|
7574
7641
|
"items": {
|
|
7575
7642
|
"$ref": "ThemeIcons"
|
|
7576
7643
|
},
|
|
7577
|
-
"description": "Specifies dark and light icons to be used with themes. The <var>light</var> icon is used on dark backgrounds and vice versa.
|
|
7644
|
+
"description": "Specifies dark and light icons to be used with themes. The <var>light</var> icon is used on dark backgrounds and vice versa. The default theme uses the <var>default_icon</var> for light backgrounds (if specified)."
|
|
7578
7645
|
},
|
|
7579
7646
|
"default_popup": {
|
|
7580
7647
|
"type": "string",
|
|
@@ -7586,7 +7653,7 @@
|
|
|
7586
7653
|
"browser_style": {
|
|
7587
7654
|
"type": "boolean",
|
|
7588
7655
|
"optional": true,
|
|
7589
|
-
"description": "Enable browser styles. See the
|
|
7656
|
+
"description": "Enable browser styles. See the $(url:mdn-browser-styles)[MDN documentation on browser styles] for more information.",
|
|
7590
7657
|
"default": false
|
|
7591
7658
|
},
|
|
7592
7659
|
"default_area": {
|
|
@@ -7642,12 +7709,12 @@
|
|
|
7642
7709
|
"type": "any"
|
|
7643
7710
|
},
|
|
7644
7711
|
"postprocess": "convertImageDataToURL",
|
|
7645
|
-
"description": "Pixel data for an image. Must be an
|
|
7712
|
+
"description": "Pixel data for an image. Must be an $(url:image-data)[ImageData] object (for example, from a $(url:canvas-element)[canvas] element)."
|
|
7646
7713
|
},
|
|
7647
7714
|
{
|
|
7648
7715
|
"id": "ImageDataDictionary",
|
|
7649
7716
|
"type": "object",
|
|
7650
|
-
"description": "A <em>dictionary object</em> to specify multiple
|
|
7717
|
+
"description": "A <em>dictionary object</em> to specify multiple $(url:image-data)[ImageData] objects in different sizes, so the icon does not have to be scaled for a device with a different pixel density. Each entry is a <em>name-value</em> pair with <em>value</em> being an $(url:image-data)[ImageData] object, and <em>name</em> its size.",
|
|
7651
7718
|
"patternProperties": {
|
|
7652
7719
|
"^[1-9]\\d*$": {
|
|
7653
7720
|
"$ref": "ImageDataType"
|
|
@@ -8347,7 +8414,7 @@
|
|
|
8347
8414
|
{
|
|
8348
8415
|
"name": "onClicked",
|
|
8349
8416
|
"type": "function",
|
|
8350
|
-
"description": "Fired when a composeAction button is clicked. This event will not fire if the composeAction has a popup. This is a user input event handler. For asynchronous listeners some
|
|
8417
|
+
"description": "Fired when a composeAction button is clicked. This event will not fire if the composeAction has a popup. This is a user input event handler. For asynchronous listeners some $(url:user-input-restrictions)[restrictions] apply.",
|
|
8351
8418
|
"parameters": [
|
|
8352
8419
|
{
|
|
8353
8420
|
"name": "tab",
|
|
@@ -8430,7 +8497,7 @@
|
|
|
8430
8497
|
{
|
|
8431
8498
|
"name": "register",
|
|
8432
8499
|
"type": "function",
|
|
8433
|
-
"description": "Register a compose script programmatically.
|
|
8500
|
+
"description": "Register a compose script programmatically.",
|
|
8434
8501
|
"async": true,
|
|
8435
8502
|
"parameters": [
|
|
8436
8503
|
{
|
|
@@ -8501,7 +8568,7 @@
|
|
|
8501
8568
|
{
|
|
8502
8569
|
"name": "register",
|
|
8503
8570
|
"type": "function",
|
|
8504
|
-
"description": "Register a message display script programmatically.
|
|
8571
|
+
"description": "Register a message display script programmatically.",
|
|
8505
8572
|
"async": true,
|
|
8506
8573
|
"parameters": [
|
|
8507
8574
|
{
|
|
@@ -8532,6 +8599,7 @@
|
|
|
8532
8599
|
},
|
|
8533
8600
|
{
|
|
8534
8601
|
"namespace": "folders",
|
|
8602
|
+
"description": "The folders API allows to access and manage the user's message folders.",
|
|
8535
8603
|
"permissions": [
|
|
8536
8604
|
"accountsRead"
|
|
8537
8605
|
],
|
|
@@ -8975,12 +9043,12 @@
|
|
|
8975
9043
|
"isTag": {
|
|
8976
9044
|
"type": "boolean",
|
|
8977
9045
|
"optional": true,
|
|
8978
|
-
"description": "Whether the folder is a virtual tag folder, or not.
|
|
9046
|
+
"description": "Whether the folder is a virtual tag folder, or not. Virtual tag folders are always skipped, unless this property is set to <var>true</var>"
|
|
8979
9047
|
},
|
|
8980
9048
|
"isUnified": {
|
|
8981
9049
|
"type": "boolean",
|
|
8982
9050
|
"optional": true,
|
|
8983
|
-
"description": "Whether the folder is a unified mailbox folder, or not.
|
|
9051
|
+
"description": "Whether the folder is a unified mailbox folder, or not. Unified mailbox folders are always skipped, unless this property is set to <var>true</var>"
|
|
8984
9052
|
},
|
|
8985
9053
|
"isVirtual": {
|
|
8986
9054
|
"type": "boolean",
|
|
@@ -9179,9 +9247,6 @@
|
|
|
9179
9247
|
{
|
|
9180
9248
|
"name": "destination",
|
|
9181
9249
|
"choices": [
|
|
9182
|
-
{
|
|
9183
|
-
"$ref": "folders.MailFolderId"
|
|
9184
|
-
},
|
|
9185
9250
|
{
|
|
9186
9251
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.create() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
9187
9252
|
"$ref": "folders.MailFolder"
|
|
@@ -9189,6 +9254,9 @@
|
|
|
9189
9254
|
{
|
|
9190
9255
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.create() requires to specify the MailFolderId of the account's rootFolder, instead of a full MailAccount object.",
|
|
9191
9256
|
"$ref": "accounts.MailAccount"
|
|
9257
|
+
},
|
|
9258
|
+
{
|
|
9259
|
+
"$ref": "folders.MailFolderId"
|
|
9192
9260
|
}
|
|
9193
9261
|
]
|
|
9194
9262
|
},
|
|
@@ -9221,12 +9289,12 @@
|
|
|
9221
9289
|
{
|
|
9222
9290
|
"name": "folder",
|
|
9223
9291
|
"choices": [
|
|
9224
|
-
{
|
|
9225
|
-
"$ref": "folders.MailFolderId"
|
|
9226
|
-
},
|
|
9227
9292
|
{
|
|
9228
9293
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.rename() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
9229
9294
|
"$ref": "folders.MailFolder"
|
|
9295
|
+
},
|
|
9296
|
+
{
|
|
9297
|
+
"$ref": "folders.MailFolderId"
|
|
9230
9298
|
}
|
|
9231
9299
|
]
|
|
9232
9300
|
},
|
|
@@ -9289,21 +9357,18 @@
|
|
|
9289
9357
|
{
|
|
9290
9358
|
"name": "source",
|
|
9291
9359
|
"choices": [
|
|
9292
|
-
{
|
|
9293
|
-
"$ref": "folders.MailFolderId"
|
|
9294
|
-
},
|
|
9295
9360
|
{
|
|
9296
9361
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.move() requires to specify a MailFolderId for its source parameter, instead of a full MailFolder object.",
|
|
9297
9362
|
"$ref": "folders.MailFolder"
|
|
9363
|
+
},
|
|
9364
|
+
{
|
|
9365
|
+
"$ref": "folders.MailFolderId"
|
|
9298
9366
|
}
|
|
9299
9367
|
]
|
|
9300
9368
|
},
|
|
9301
9369
|
{
|
|
9302
9370
|
"name": "destination",
|
|
9303
9371
|
"choices": [
|
|
9304
|
-
{
|
|
9305
|
-
"$ref": "folders.MailFolderId"
|
|
9306
|
-
},
|
|
9307
9372
|
{
|
|
9308
9373
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.move() requires to specify a MailFolderId for its destination parameter, instead of a full MailFolder object.",
|
|
9309
9374
|
"$ref": "folders.MailFolder"
|
|
@@ -9311,6 +9376,9 @@
|
|
|
9311
9376
|
{
|
|
9312
9377
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.move() requires to specify the MailFolderId of the account's rootFolder for its destination parameter, instead of a full MailAccount object.",
|
|
9313
9378
|
"$ref": "accounts.MailAccount"
|
|
9379
|
+
},
|
|
9380
|
+
{
|
|
9381
|
+
"$ref": "folders.MailFolderId"
|
|
9314
9382
|
}
|
|
9315
9383
|
]
|
|
9316
9384
|
},
|
|
@@ -9369,21 +9437,18 @@
|
|
|
9369
9437
|
{
|
|
9370
9438
|
"name": "source",
|
|
9371
9439
|
"choices": [
|
|
9372
|
-
{
|
|
9373
|
-
"$ref": "folders.MailFolderId"
|
|
9374
|
-
},
|
|
9375
9440
|
{
|
|
9376
9441
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.copy() requires to specify a MailFolderId for its source parameter, instead of a full MailFolder object.",
|
|
9377
9442
|
"$ref": "folders.MailFolder"
|
|
9443
|
+
},
|
|
9444
|
+
{
|
|
9445
|
+
"$ref": "folders.MailFolderId"
|
|
9378
9446
|
}
|
|
9379
9447
|
]
|
|
9380
9448
|
},
|
|
9381
9449
|
{
|
|
9382
9450
|
"name": "destination",
|
|
9383
9451
|
"choices": [
|
|
9384
|
-
{
|
|
9385
|
-
"$ref": "folders.MailFolderId"
|
|
9386
|
-
},
|
|
9387
9452
|
{
|
|
9388
9453
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.copy() requires to specify a MailFolderId for its destination parameter, instead of a full MailFolder object.",
|
|
9389
9454
|
"$ref": "folders.MailFolder"
|
|
@@ -9391,6 +9456,9 @@
|
|
|
9391
9456
|
{
|
|
9392
9457
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.copy() requires to specify the MailFolderId of the account's rootFolder for its destination parameter, instead of a full MailAccount object.",
|
|
9393
9458
|
"$ref": "accounts.MailAccount"
|
|
9459
|
+
},
|
|
9460
|
+
{
|
|
9461
|
+
"$ref": "folders.MailFolderId"
|
|
9394
9462
|
}
|
|
9395
9463
|
]
|
|
9396
9464
|
},
|
|
@@ -9450,12 +9518,12 @@
|
|
|
9450
9518
|
{
|
|
9451
9519
|
"name": "folder",
|
|
9452
9520
|
"choices": [
|
|
9453
|
-
{
|
|
9454
|
-
"$ref": "folders.MailFolderId"
|
|
9455
|
-
},
|
|
9456
9521
|
{
|
|
9457
9522
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.delete() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
9458
9523
|
"$ref": "folders.MailFolder"
|
|
9524
|
+
},
|
|
9525
|
+
{
|
|
9526
|
+
"$ref": "folders.MailFolderId"
|
|
9459
9527
|
}
|
|
9460
9528
|
]
|
|
9461
9529
|
}
|
|
@@ -9491,12 +9559,12 @@
|
|
|
9491
9559
|
{
|
|
9492
9560
|
"name": "folder",
|
|
9493
9561
|
"choices": [
|
|
9494
|
-
{
|
|
9495
|
-
"$ref": "folders.MailFolderId"
|
|
9496
|
-
},
|
|
9497
9562
|
{
|
|
9498
9563
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.update() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
9499
9564
|
"$ref": "folders.MailFolder"
|
|
9565
|
+
},
|
|
9566
|
+
{
|
|
9567
|
+
"$ref": "folders.MailFolderId"
|
|
9500
9568
|
}
|
|
9501
9569
|
]
|
|
9502
9570
|
},
|
|
@@ -9552,12 +9620,12 @@
|
|
|
9552
9620
|
{
|
|
9553
9621
|
"name": "folder",
|
|
9554
9622
|
"choices": [
|
|
9555
|
-
{
|
|
9556
|
-
"$ref": "folders.MailFolderId"
|
|
9557
|
-
},
|
|
9558
9623
|
{
|
|
9559
9624
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.getFolderInfo() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
9560
9625
|
"$ref": "folders.MailFolder"
|
|
9626
|
+
},
|
|
9627
|
+
{
|
|
9628
|
+
"$ref": "folders.MailFolderId"
|
|
9561
9629
|
}
|
|
9562
9630
|
]
|
|
9563
9631
|
},
|
|
@@ -9606,12 +9674,12 @@
|
|
|
9606
9674
|
{
|
|
9607
9675
|
"name": "folder",
|
|
9608
9676
|
"choices": [
|
|
9609
|
-
{
|
|
9610
|
-
"$ref": "folders.MailFolderId"
|
|
9611
|
-
},
|
|
9612
9677
|
{
|
|
9613
9678
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.getFolderCapabilities() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
9614
9679
|
"$ref": "folders.MailFolder"
|
|
9680
|
+
},
|
|
9681
|
+
{
|
|
9682
|
+
"$ref": "folders.MailFolderId"
|
|
9615
9683
|
}
|
|
9616
9684
|
]
|
|
9617
9685
|
},
|
|
@@ -9660,12 +9728,12 @@
|
|
|
9660
9728
|
{
|
|
9661
9729
|
"name": "folder",
|
|
9662
9730
|
"choices": [
|
|
9663
|
-
{
|
|
9664
|
-
"$ref": "folders.MailFolderId"
|
|
9665
|
-
},
|
|
9666
9731
|
{
|
|
9667
9732
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.getParentFolders() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
9668
9733
|
"$ref": "folders.MailFolder"
|
|
9734
|
+
},
|
|
9735
|
+
{
|
|
9736
|
+
"$ref": "folders.MailFolderId"
|
|
9669
9737
|
}
|
|
9670
9738
|
]
|
|
9671
9739
|
},
|
|
@@ -9767,9 +9835,6 @@
|
|
|
9767
9835
|
{
|
|
9768
9836
|
"name": "folder",
|
|
9769
9837
|
"choices": [
|
|
9770
|
-
{
|
|
9771
|
-
"$ref": "folders.MailFolderId"
|
|
9772
|
-
},
|
|
9773
9838
|
{
|
|
9774
9839
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.getSubFolders() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
9775
9840
|
"$ref": "folders.MailFolder"
|
|
@@ -9777,6 +9842,9 @@
|
|
|
9777
9842
|
{
|
|
9778
9843
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.getSubFolders() requires to specify the MailFolderId of the account's rootFolder, instead of a full MailAccount object.",
|
|
9779
9844
|
"$ref": "accounts.MailAccount"
|
|
9845
|
+
},
|
|
9846
|
+
{
|
|
9847
|
+
"$ref": "folders.MailFolderId"
|
|
9780
9848
|
}
|
|
9781
9849
|
]
|
|
9782
9850
|
},
|
|
@@ -9877,12 +9945,12 @@
|
|
|
9877
9945
|
{
|
|
9878
9946
|
"name": "folder",
|
|
9879
9947
|
"choices": [
|
|
9880
|
-
{
|
|
9881
|
-
"$ref": "folders.MailFolderId"
|
|
9882
|
-
},
|
|
9883
9948
|
{
|
|
9884
9949
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: folders.markAsRead() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
9885
9950
|
"$ref": "folders.MailFolder"
|
|
9951
|
+
},
|
|
9952
|
+
{
|
|
9953
|
+
"$ref": "folders.MailFolderId"
|
|
9886
9954
|
}
|
|
9887
9955
|
]
|
|
9888
9956
|
},
|
|
@@ -10037,6 +10105,7 @@
|
|
|
10037
10105
|
},
|
|
10038
10106
|
{
|
|
10039
10107
|
"namespace": "identities",
|
|
10108
|
+
"description": "The identities API allows to manage the user's identities (each account can have multiple identities).",
|
|
10040
10109
|
"permissions": [
|
|
10041
10110
|
"accountsRead"
|
|
10042
10111
|
],
|
|
@@ -10350,6 +10419,7 @@
|
|
|
10350
10419
|
"mailTabs.json": [
|
|
10351
10420
|
{
|
|
10352
10421
|
"namespace": "mailTabs",
|
|
10422
|
+
"description": "The mailTabs API allows to interact with Thunderbird's main mail tab (a.k.a 3-pane tab).",
|
|
10353
10423
|
"types": [
|
|
10354
10424
|
{
|
|
10355
10425
|
"id": "FolderMode",
|
|
@@ -10546,7 +10616,7 @@
|
|
|
10546
10616
|
},
|
|
10547
10617
|
"layout": {
|
|
10548
10618
|
"type": "string",
|
|
10549
|
-
"description": "Sets the arrangement of the folder pane, message list pane, and message display pane.
|
|
10619
|
+
"description": "Sets the arrangement of the folder pane, message list pane, and message display pane. Setting a layout will be applied to all mail tabs.",
|
|
10550
10620
|
"optional": true,
|
|
10551
10621
|
"enum": [
|
|
10552
10622
|
"standard",
|
|
@@ -10728,7 +10798,7 @@
|
|
|
10728
10798
|
{
|
|
10729
10799
|
"name": "create",
|
|
10730
10800
|
"type": "function",
|
|
10731
|
-
"description": "Creates a new mail tab. Standard tab properties can be adjusted via $(ref:tabs.update) after the mail tab has been created.
|
|
10801
|
+
"description": "Creates a new mail tab. Standard tab properties can be adjusted via $(ref:tabs.update) after the mail tab has been created. A new mail window can be created via $(ref:windows.create).",
|
|
10732
10802
|
"async": "callback",
|
|
10733
10803
|
"parameters": [
|
|
10734
10804
|
{
|
|
@@ -11089,7 +11159,7 @@
|
|
|
11089
11159
|
]
|
|
11090
11160
|
}
|
|
11091
11161
|
],
|
|
11092
|
-
"description": "The different contexts a menu can appear in. Specifying <var>all</var> is equivalent to the combination of all other contexts excluding <var>tab</var> and <var>tools_menu</var>. More information about each context can be found in the
|
|
11162
|
+
"description": "The different contexts a menu can appear in. Specifying <var>all</var> is equivalent to the combination of all other contexts excluding <var>tab</var> and <var>tools_menu</var>. More information about each context can be found in the $(url:ui-elements)[Supported UI Elements] article on developer.thunderbird.net."
|
|
11093
11163
|
},
|
|
11094
11164
|
{
|
|
11095
11165
|
"id": "ItemType",
|
|
@@ -11145,31 +11215,31 @@
|
|
|
11145
11215
|
"linkText": {
|
|
11146
11216
|
"type": "string",
|
|
11147
11217
|
"optional": true,
|
|
11148
|
-
"description": "If the element is a link, the text of that link.
|
|
11218
|
+
"description": "If the element is a link, the text of that link."
|
|
11149
11219
|
},
|
|
11150
11220
|
"linkUrl": {
|
|
11151
11221
|
"type": "string",
|
|
11152
11222
|
"optional": true,
|
|
11153
|
-
"description": "If the element is a link, the URL it points to.
|
|
11223
|
+
"description": "If the element is a link, the URL it points to."
|
|
11154
11224
|
},
|
|
11155
11225
|
"srcUrl": {
|
|
11156
11226
|
"type": "string",
|
|
11157
|
-
"description": "Will be present for elements with a <em>src</em> URL.
|
|
11227
|
+
"description": "Will be present for elements with a <em>src</em> URL.",
|
|
11158
11228
|
"optional": true
|
|
11159
11229
|
},
|
|
11160
11230
|
"pageUrl": {
|
|
11161
11231
|
"type": "string",
|
|
11162
|
-
"description": "The URL of the page where the menu item was clicked. This property is not set if the click occurred in a context where there is no current page, such as in a launcher context menu.
|
|
11232
|
+
"description": "The URL of the page where the menu item was clicked. This property is not set if the click occurred in a context where there is no current page, such as in a launcher context menu.",
|
|
11163
11233
|
"optional": true
|
|
11164
11234
|
},
|
|
11165
11235
|
"frameUrl": {
|
|
11166
11236
|
"type": "string",
|
|
11167
|
-
"description": "The URL of the frame of the element where the context menu was clicked, if it was in a frame.
|
|
11237
|
+
"description": "The URL of the frame of the element where the context menu was clicked, if it was in a frame.",
|
|
11168
11238
|
"optional": true
|
|
11169
11239
|
},
|
|
11170
11240
|
"selectionText": {
|
|
11171
11241
|
"type": "string",
|
|
11172
|
-
"description": "The text for the context selection, if any.
|
|
11242
|
+
"description": "The text for the context selection, if any.",
|
|
11173
11243
|
"optional": true
|
|
11174
11244
|
},
|
|
11175
11245
|
"targetElementId": {
|
|
@@ -11193,7 +11263,7 @@
|
|
|
11193
11263
|
"selectedMessages": {
|
|
11194
11264
|
"$ref": "messages.MessageList",
|
|
11195
11265
|
"optional": true,
|
|
11196
|
-
"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
|
|
11266
|
+
"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."
|
|
11197
11267
|
},
|
|
11198
11268
|
"displayedFolder": {
|
|
11199
11269
|
"$ref": "folders.MailFolder",
|
|
@@ -11213,7 +11283,7 @@
|
|
|
11213
11283
|
"$ref": "folders.MailFolder"
|
|
11214
11284
|
},
|
|
11215
11285
|
"optional": true,
|
|
11216
|
-
"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
|
|
11286
|
+
"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."
|
|
11217
11287
|
},
|
|
11218
11288
|
"selectedAccount": {
|
|
11219
11289
|
"$ref": "accounts.MailAccount",
|
|
@@ -11367,7 +11437,7 @@
|
|
|
11367
11437
|
"selectedMessages": {
|
|
11368
11438
|
"$ref": "messages.MessageList",
|
|
11369
11439
|
"optional": true,
|
|
11370
|
-
"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
|
|
11440
|
+
"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."
|
|
11371
11441
|
},
|
|
11372
11442
|
"displayedFolder": {
|
|
11373
11443
|
"$ref": "folders.MailFolder",
|
|
@@ -11387,7 +11457,7 @@
|
|
|
11387
11457
|
"$ref": "folders.MailFolder"
|
|
11388
11458
|
},
|
|
11389
11459
|
"optional": true,
|
|
11390
|
-
"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
|
|
11460
|
+
"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."
|
|
11391
11461
|
},
|
|
11392
11462
|
"selectedAccount": {
|
|
11393
11463
|
"$ref": "accounts.MailAccount",
|
|
@@ -11435,7 +11505,7 @@
|
|
|
11435
11505
|
"$ref": "MenuIconPath"
|
|
11436
11506
|
}
|
|
11437
11507
|
},
|
|
11438
|
-
"description": "A <em>dictionary object</em> to specify paths for multiple icons in different sizes, so the best matching icon can be used, instead of scaling a standard icon to fit the pixel density of the user's display. Each entry is a <em>name-value</em> pair, with <em>name</em> being a size and <em>value</em> being a $(ref:menus.MenuIconPath).
|
|
11508
|
+
"description": "A <em>dictionary object</em> to specify paths for multiple icons in different sizes, so the best matching icon can be used, instead of scaling a standard icon to fit the pixel density of the user's display. Each entry is a <em>name-value</em> pair, with <em>name</em> being a size and <em>value</em> being a $(ref:menus.MenuIconPath)."
|
|
11439
11509
|
},
|
|
11440
11510
|
{
|
|
11441
11511
|
"id": "MenuActionCommand",
|
|
@@ -11466,7 +11536,7 @@
|
|
|
11466
11536
|
{
|
|
11467
11537
|
"name": "create",
|
|
11468
11538
|
"type": "function",
|
|
11469
|
-
"description": "Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in
|
|
11539
|
+
"description": "Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in $(url:runtime-last-error)[runtime.lastError]).",
|
|
11470
11540
|
"returns": {
|
|
11471
11541
|
"choices": [
|
|
11472
11542
|
{
|
|
@@ -11573,7 +11643,7 @@
|
|
|
11573
11643
|
"type": "string"
|
|
11574
11644
|
},
|
|
11575
11645
|
"optional": true,
|
|
11576
|
-
"description": "Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see
|
|
11646
|
+
"description": "Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see $(url:match-patterns)[Match Patterns]."
|
|
11577
11647
|
},
|
|
11578
11648
|
"targetUrlPatterns": {
|
|
11579
11649
|
"type": "array",
|
|
@@ -11606,7 +11676,7 @@
|
|
|
11606
11676
|
"type": "function",
|
|
11607
11677
|
"name": "callback",
|
|
11608
11678
|
"optional": true,
|
|
11609
|
-
"description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in
|
|
11679
|
+
"description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in $(url:runtime-last-error)[runtime.lastError].",
|
|
11610
11680
|
"parameters": []
|
|
11611
11681
|
}
|
|
11612
11682
|
]
|
|
@@ -11689,7 +11759,7 @@
|
|
|
11689
11759
|
{
|
|
11690
11760
|
"name": "tab",
|
|
11691
11761
|
"$ref": "tabs.Tab",
|
|
11692
|
-
"description": "The details of the tab where the click took place.
|
|
11762
|
+
"description": "The details of the tab where the click took place."
|
|
11693
11763
|
}
|
|
11694
11764
|
]
|
|
11695
11765
|
},
|
|
@@ -11703,7 +11773,7 @@
|
|
|
11703
11773
|
}
|
|
11704
11774
|
],
|
|
11705
11775
|
"optional": true,
|
|
11706
|
-
"description": "
|
|
11776
|
+
"description": "The hierarchical parent of the element. Updating an element to become a child of its own descendants is not supported."
|
|
11707
11777
|
},
|
|
11708
11778
|
"documentUrlPatterns": {
|
|
11709
11779
|
"type": "array",
|
|
@@ -11782,7 +11852,7 @@
|
|
|
11782
11852
|
"menus.overrideContext"
|
|
11783
11853
|
],
|
|
11784
11854
|
"type": "function",
|
|
11785
|
-
"description": "Show the matching menu items from this extension instead of the default menu. This should be called during a
|
|
11855
|
+
"description": "Show the matching menu items from this extension instead of the default menu. This should be called during a $(url:contextmenu-event)[contextmenu] event handler, and only applies to the menu that opens after this event.",
|
|
11786
11856
|
"parameters": [
|
|
11787
11857
|
{
|
|
11788
11858
|
"name": "contextOptions",
|
|
@@ -11824,7 +11894,7 @@
|
|
|
11824
11894
|
{
|
|
11825
11895
|
"name": "onClicked",
|
|
11826
11896
|
"type": "function",
|
|
11827
|
-
"description": "Fired when a context menu item is clicked. This is a user input event handler. For asynchronous listeners some
|
|
11897
|
+
"description": "Fired when a context menu item is clicked. This is a user input event handler. For asynchronous listeners some $(url:user-input-restrictions)[restrictions] apply.",
|
|
11828
11898
|
"parameters": [
|
|
11829
11899
|
{
|
|
11830
11900
|
"name": "info",
|
|
@@ -11884,7 +11954,7 @@
|
|
|
11884
11954
|
"content",
|
|
11885
11955
|
"devtools"
|
|
11886
11956
|
],
|
|
11887
|
-
"description": "Retrieve the element that was associated with a recent
|
|
11957
|
+
"description": "Retrieve the element that was associated with a recent $(url:contextmenu-event)[contextmenu] event.",
|
|
11888
11958
|
"parameters": [
|
|
11889
11959
|
{
|
|
11890
11960
|
"type": "integer",
|
|
@@ -11907,6 +11977,7 @@
|
|
|
11907
11977
|
"messageDisplay.json": [
|
|
11908
11978
|
{
|
|
11909
11979
|
"namespace": "messageDisplay",
|
|
11980
|
+
"description": "A message can be displayed in either Thunderbird's main mail tab (a.k.a 3-pane tab), a tab of its own, or in a window of its own. All are referenced by <var>tabId</var> in this API. Display windows are considered to have exactly one tab, which has limited functionality compared to tabs from the main window.",
|
|
11910
11981
|
"permissions": [
|
|
11911
11982
|
"messagesRead"
|
|
11912
11983
|
],
|
|
@@ -12124,7 +12195,7 @@
|
|
|
12124
12195
|
"items": {
|
|
12125
12196
|
"$ref": "ThemeIcons"
|
|
12126
12197
|
},
|
|
12127
|
-
"description": "Specifies dark and light icons to be used with themes. The <var>light</var> icon is used on dark backgrounds and vice versa.
|
|
12198
|
+
"description": "Specifies dark and light icons to be used with themes. The <var>light</var> icon is used on dark backgrounds and vice versa. The default theme uses the <var>default_icon</var> for light backgrounds (if specified)."
|
|
12128
12199
|
},
|
|
12129
12200
|
"default_popup": {
|
|
12130
12201
|
"type": "string",
|
|
@@ -12136,7 +12207,7 @@
|
|
|
12136
12207
|
"browser_style": {
|
|
12137
12208
|
"type": "boolean",
|
|
12138
12209
|
"optional": true,
|
|
12139
|
-
"description": "Enable browser styles. See the
|
|
12210
|
+
"description": "Enable browser styles. See the $(url:mdn-browser-styles)[MDN documentation on browser styles] for more information.",
|
|
12140
12211
|
"default": false
|
|
12141
12212
|
},
|
|
12142
12213
|
"default_area": {
|
|
@@ -12188,12 +12259,12 @@
|
|
|
12188
12259
|
"type": "any"
|
|
12189
12260
|
},
|
|
12190
12261
|
"postprocess": "convertImageDataToURL",
|
|
12191
|
-
"description": "Pixel data for an image. Must be an
|
|
12262
|
+
"description": "Pixel data for an image. Must be an $(url:image-data)[ImageData] object (for example, from a $(url:canvas-element)[canvas] element)."
|
|
12192
12263
|
},
|
|
12193
12264
|
{
|
|
12194
12265
|
"id": "ImageDataDictionary",
|
|
12195
12266
|
"type": "object",
|
|
12196
|
-
"description": "A <em>dictionary object</em> to specify multiple
|
|
12267
|
+
"description": "A <em>dictionary object</em> to specify multiple $(url:image-data)[ImageData] objects in different sizes, so the icon does not have to be scaled for a device with a different pixel density. Each entry is a <em>name-value</em> pair with <em>value</em> being an $(url:image-data)[ImageData] object, and <em>name</em> its size.",
|
|
12197
12268
|
"patternProperties": {
|
|
12198
12269
|
"^[1-9]\\d*$": {
|
|
12199
12270
|
"$ref": "ImageDataType"
|
|
@@ -12893,7 +12964,7 @@
|
|
|
12893
12964
|
{
|
|
12894
12965
|
"name": "onClicked",
|
|
12895
12966
|
"type": "function",
|
|
12896
|
-
"description": "Fired when a messageDisplayAction button is clicked. This event will not fire if the messageDisplayAction has a popup. This is a user input event handler. For asynchronous listeners some
|
|
12967
|
+
"description": "Fired when a messageDisplayAction button is clicked. This event will not fire if the messageDisplayAction has a popup. This is a user input event handler. For asynchronous listeners some $(url:user-input-restrictions)[restrictions] apply.",
|
|
12897
12968
|
"parameters": [
|
|
12898
12969
|
{
|
|
12899
12970
|
"name": "tab",
|
|
@@ -12936,6 +13007,7 @@
|
|
|
12936
13007
|
},
|
|
12937
13008
|
{
|
|
12938
13009
|
"namespace": "messages",
|
|
13010
|
+
"description": "The messages API allows to access and manage the user's messages.",
|
|
12939
13011
|
"permissions": [
|
|
12940
13012
|
"messagesRead"
|
|
12941
13013
|
],
|
|
@@ -13061,7 +13133,7 @@
|
|
|
13061
13133
|
{
|
|
13062
13134
|
"id": "MessageList",
|
|
13063
13135
|
"type": "object",
|
|
13064
|
-
"description": "See $(doc:
|
|
13136
|
+
"description": "See $(doc:guides/messageLists) for more information.",
|
|
13065
13137
|
"properties": {
|
|
13066
13138
|
"id": {
|
|
13067
13139
|
"choices": [
|
|
@@ -13396,12 +13468,12 @@
|
|
|
13396
13468
|
{
|
|
13397
13469
|
"name": "folder",
|
|
13398
13470
|
"choices": [
|
|
13399
|
-
{
|
|
13400
|
-
"$ref": "folders.MailFolderId"
|
|
13401
|
-
},
|
|
13402
13471
|
{
|
|
13403
13472
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: messages.list() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
13404
13473
|
"$ref": "folders.MailFolder"
|
|
13474
|
+
},
|
|
13475
|
+
{
|
|
13476
|
+
"$ref": "folders.MailFolderId"
|
|
13405
13477
|
}
|
|
13406
13478
|
]
|
|
13407
13479
|
},
|
|
@@ -13420,7 +13492,7 @@
|
|
|
13420
13492
|
{
|
|
13421
13493
|
"name": "continueList",
|
|
13422
13494
|
"type": "function",
|
|
13423
|
-
"description": "Returns the next chunk of messages in a list. See $(doc:
|
|
13495
|
+
"description": "Returns the next chunk of messages in a list. See $(doc:guides/messageLists) for more information.",
|
|
13424
13496
|
"async": "callback",
|
|
13425
13497
|
"parameters": [
|
|
13426
13498
|
{
|
|
@@ -13494,7 +13566,7 @@
|
|
|
13494
13566
|
},
|
|
13495
13567
|
"decodeHeaders": {
|
|
13496
13568
|
"type": "boolean",
|
|
13497
|
-
"description": "Whether to decode RFC 2047 encoded headers of message parts. Defaults to <var>true</var>.
|
|
13569
|
+
"description": "Whether to decode RFC 2047 encoded headers of message parts. Defaults to <var>true</var>.",
|
|
13498
13570
|
"optional": true
|
|
13499
13571
|
},
|
|
13500
13572
|
"decodeContent": {
|
|
@@ -13548,7 +13620,7 @@
|
|
|
13548
13620
|
"choices": [
|
|
13549
13621
|
{
|
|
13550
13622
|
"max_manifest_version": 2,
|
|
13551
|
-
"description": "The message can either be returned as a DOM File or as a
|
|
13623
|
+
"description": "The message can either be returned as a DOM File or as a $(url:binary-string)[binary string]. The historic default is to return a binary string (kept for backward compatibility). However, it is now recommended to use the <var>File</var> format, because the DOM File object can be used as-is with the downloads API and has useful methods to access the content, like $(url:dom-file-text)[File.text()] and $(url:dom-file-array-buffer)[File.arrayBuffer()].",
|
|
13552
13624
|
"type": "string",
|
|
13553
13625
|
"enum": [
|
|
13554
13626
|
"File",
|
|
@@ -13557,7 +13629,7 @@
|
|
|
13557
13629
|
},
|
|
13558
13630
|
{
|
|
13559
13631
|
"min_manifest_version": 3,
|
|
13560
|
-
"description": "The message can either be returned as a DOM File (default) or as a
|
|
13632
|
+
"description": "The message can either be returned as a DOM File (default) or as a $(url:binary-string)[binary string]. It is recommended to use the <var>File</var> format, because the DOM File object can be used as-is with the downloads API and has useful methods to access the content, like $(url:dom-file-text)[File.text()] and $(url:dom-file-array-buffer)[File.arrayBuffer()].",
|
|
13561
13633
|
"type": "string",
|
|
13562
13634
|
"enum": [
|
|
13563
13635
|
"File",
|
|
@@ -13619,7 +13691,7 @@
|
|
|
13619
13691
|
{
|
|
13620
13692
|
"name": "listInlineTextParts",
|
|
13621
13693
|
"type": "function",
|
|
13622
|
-
"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.
|
|
13694
|
+
"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.",
|
|
13623
13695
|
"async": "callback",
|
|
13624
13696
|
"parameters": [
|
|
13625
13697
|
{
|
|
@@ -13644,7 +13716,7 @@
|
|
|
13644
13716
|
{
|
|
13645
13717
|
"name": "getAttachmentFile",
|
|
13646
13718
|
"type": "function",
|
|
13647
|
-
"description": "Gets the content of a $(ref:messages.MessageAttachment) as a
|
|
13719
|
+
"description": "Gets the content of a $(ref:messages.MessageAttachment) as a $(url:dom-file)[File] object.",
|
|
13648
13720
|
"async": "callback",
|
|
13649
13721
|
"parameters": [
|
|
13650
13722
|
{
|
|
@@ -13821,7 +13893,7 @@
|
|
|
13821
13893
|
"online": {
|
|
13822
13894
|
"type": "boolean",
|
|
13823
13895
|
"optional": true,
|
|
13824
|
-
"description": "Query the server directly instead of the local message database. Online queries currently only support querying the
|
|
13896
|
+
"description": "Query the server directly instead of the local message database. Online queries currently only support querying the <var>headerMessageId</var> property. Currently only supported for NNTP accounts."
|
|
13825
13897
|
},
|
|
13826
13898
|
"recipients": {
|
|
13827
13899
|
"type": "string",
|
|
@@ -13957,12 +14029,12 @@
|
|
|
13957
14029
|
{
|
|
13958
14030
|
"name": "destination",
|
|
13959
14031
|
"choices": [
|
|
13960
|
-
{
|
|
13961
|
-
"$ref": "folders.MailFolderId"
|
|
13962
|
-
},
|
|
13963
14032
|
{
|
|
13964
14033
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: messages.move() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
13965
14034
|
"$ref": "folders.MailFolder"
|
|
14035
|
+
},
|
|
14036
|
+
{
|
|
14037
|
+
"$ref": "folders.MailFolderId"
|
|
13966
14038
|
}
|
|
13967
14039
|
],
|
|
13968
14040
|
"description": "The folder to move the messages to."
|
|
@@ -14041,12 +14113,12 @@
|
|
|
14041
14113
|
{
|
|
14042
14114
|
"name": "destination",
|
|
14043
14115
|
"choices": [
|
|
14044
|
-
{
|
|
14045
|
-
"$ref": "folders.MailFolderId"
|
|
14046
|
-
},
|
|
14047
14116
|
{
|
|
14048
14117
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: messages.copy() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
14049
14118
|
"$ref": "folders.MailFolder"
|
|
14119
|
+
},
|
|
14120
|
+
{
|
|
14121
|
+
"$ref": "folders.MailFolderId"
|
|
14050
14122
|
}
|
|
14051
14123
|
],
|
|
14052
14124
|
"description": "The folder to copy the messages to."
|
|
@@ -14135,12 +14207,12 @@
|
|
|
14135
14207
|
"deletePermanently": {
|
|
14136
14208
|
"type": "boolean",
|
|
14137
14209
|
"optional": true,
|
|
14138
|
-
"description": "Whether the message will be deleted permanently, regardless of the account's deletion behavior settings. Use this with care!"
|
|
14210
|
+
"description": "Whether the message will be deleted permanently, regardless of the account's deletion behavior settings. A permanently deleted message cannot be restored, even if the action is defined as a user action. Use this with care!"
|
|
14139
14211
|
},
|
|
14140
14212
|
"isUserAction": {
|
|
14141
14213
|
"type": "boolean",
|
|
14142
14214
|
"optional": true,
|
|
14143
|
-
"description": "Whether this copy operation should be treated as a user action, for example allowing undo.
|
|
14215
|
+
"description": "Whether this copy operation should be treated as a user action, for example allowing undo."
|
|
14144
14216
|
}
|
|
14145
14217
|
}
|
|
14146
14218
|
}
|
|
@@ -14168,12 +14240,12 @@
|
|
|
14168
14240
|
{
|
|
14169
14241
|
"name": "destination",
|
|
14170
14242
|
"choices": [
|
|
14171
|
-
{
|
|
14172
|
-
"$ref": "folders.MailFolderId"
|
|
14173
|
-
},
|
|
14174
14243
|
{
|
|
14175
14244
|
"deprecated": "Support deprecated since Thunderbird 121 and removed in Manifest V3: messages.import() requires to specify a MailFolderId instead of a full MailFolder object.",
|
|
14176
14245
|
"$ref": "folders.MailFolder"
|
|
14246
|
+
},
|
|
14247
|
+
{
|
|
14248
|
+
"$ref": "folders.MailFolderId"
|
|
14177
14249
|
}
|
|
14178
14250
|
],
|
|
14179
14251
|
"description": "The folder to import the messages into."
|
|
@@ -14365,6 +14437,7 @@
|
|
|
14365
14437
|
},
|
|
14366
14438
|
{
|
|
14367
14439
|
"namespace": "messages.tags",
|
|
14440
|
+
"description": "The messages.tags API allows to manage the user's message tags.",
|
|
14368
14441
|
"types": [
|
|
14369
14442
|
{
|
|
14370
14443
|
"id": "MessageTag",
|
|
@@ -14635,6 +14708,7 @@
|
|
|
14635
14708
|
"messenger_utilities.json": [
|
|
14636
14709
|
{
|
|
14637
14710
|
"namespace": "messengerUtilities",
|
|
14711
|
+
"description": "The messengerUtilities API provides helpful methods for working with messages and emails.",
|
|
14638
14712
|
"types": [
|
|
14639
14713
|
{
|
|
14640
14714
|
"id": "ParsedMailbox",
|
|
@@ -14761,7 +14835,7 @@
|
|
|
14761
14835
|
"type": "boolean",
|
|
14762
14836
|
"name": "preserveGroups",
|
|
14763
14837
|
"optional": true,
|
|
14764
|
-
"description": "Keep grouped
|
|
14838
|
+
"description": "Keep grouped hierarchies. Groups may be specified in a mailbox string as follows: <var>GroupName : user1 <user1@example.com>, user2@example,com ;</var>."
|
|
14765
14839
|
},
|
|
14766
14840
|
{
|
|
14767
14841
|
"type": "function",
|
|
@@ -14954,6 +15028,7 @@
|
|
|
14954
15028
|
},
|
|
14955
15029
|
{
|
|
14956
15030
|
"namespace": "sessions",
|
|
15031
|
+
"description": "The sessions API allows to add tab related session data to Thunderbird's tabs, which will be restored on app restart.",
|
|
14957
15032
|
"functions": [
|
|
14958
15033
|
{
|
|
14959
15034
|
"name": "setTabValue",
|
|
@@ -15030,6 +15105,7 @@
|
|
|
15030
15105
|
"spaces.json": [
|
|
15031
15106
|
{
|
|
15032
15107
|
"namespace": "spaces",
|
|
15108
|
+
"description": "The spaces API allows to manage built-in and custom spaces, and to add buttons for custom spaces to Thunderbird's spaces toolbar.",
|
|
15033
15109
|
"types": [
|
|
15034
15110
|
{
|
|
15035
15111
|
"id": "SpaceTabProperties",
|
|
@@ -15044,7 +15120,7 @@
|
|
|
15044
15120
|
"cookieStoreId": {
|
|
15045
15121
|
"type": "string",
|
|
15046
15122
|
"optional": true,
|
|
15047
|
-
"description": "The
|
|
15123
|
+
"description": "The $(url:cookieStore)[CookieStore] id used by the tab. Either a custom id created using the $(url:contextualIdentity)[contextualIdentities API], or a built-in one: <var>firefox-default</var>, <var>firefox-container-1</var>, <var>firefox-container-2</var>, <var>firefox-container-3</var>, <var>firefox-container-4</var>, <var>firefox-container-5</var>."
|
|
15048
15124
|
},
|
|
15049
15125
|
"linkHandler": {
|
|
15050
15126
|
"type": "string",
|
|
@@ -15212,13 +15288,13 @@
|
|
|
15212
15288
|
"name": "tabProperties",
|
|
15213
15289
|
"choices": [
|
|
15214
15290
|
{
|
|
15215
|
-
"
|
|
15291
|
+
"type": "string"
|
|
15216
15292
|
},
|
|
15217
15293
|
{
|
|
15218
|
-
"
|
|
15294
|
+
"$ref": "spaces.SpaceTabProperties"
|
|
15219
15295
|
}
|
|
15220
15296
|
],
|
|
15221
|
-
"description": "The properties for the new tab being opened, when the associated button in the spaces toolbar is clicked. Either a <em>string</em>
|
|
15297
|
+
"description": "The properties for the new tab being opened, when the associated button in the spaces toolbar is clicked. Either a <em>string</em> specifying the default URL, or a $(ref:spaces.SpaceTabProperties) object. The URL may point to a WebExtension page or a web page."
|
|
15222
15298
|
},
|
|
15223
15299
|
{
|
|
15224
15300
|
"name": "buttonProperties",
|
|
@@ -15369,7 +15445,7 @@
|
|
|
15369
15445
|
"$ref": "spaces.SpaceButtonProperties"
|
|
15370
15446
|
}
|
|
15371
15447
|
],
|
|
15372
|
-
"description": "The properties for the new tab being opened, when the associated button in the spaces toolbar is clicked. Either a <em>string</em>
|
|
15448
|
+
"description": "The properties for the new tab being opened, when the associated button in the spaces toolbar is clicked. Either a <em>string</em> specifying the default URL, or a $(ref:spaces.SpaceTabProperties) object. The URL may point to a WebExtension page or a web page."
|
|
15373
15449
|
},
|
|
15374
15450
|
{
|
|
15375
15451
|
"name": "buttonProperties",
|
|
@@ -15418,6 +15494,7 @@
|
|
|
15418
15494
|
"spacesToolbar.json": [
|
|
15419
15495
|
{
|
|
15420
15496
|
"namespace": "spacesToolbar",
|
|
15497
|
+
"description": "The spacesToolbar API allows to manage built-in and custom spaces, and to add buttons for custom spaces to Thunderbird's spaces toolbar.",
|
|
15421
15498
|
"max_manifest_version": 2,
|
|
15422
15499
|
"types": [
|
|
15423
15500
|
{
|
|
@@ -15697,7 +15774,7 @@
|
|
|
15697
15774
|
"cookieStoreId": {
|
|
15698
15775
|
"type": "string",
|
|
15699
15776
|
"optional": true,
|
|
15700
|
-
"description": "The
|
|
15777
|
+
"description": "The $(url:cookieStore)[CookieStore] id used by the tab. Either a custom id created using the $(url:contextualIdentity)[contextualIdentities API], or a built-in one: <var>firefox-default</var>, <var>firefox-container-1</var>, <var>firefox-container-2</var>, <var>firefox-container-3</var>, <var>firefox-container-4</var>, <var>firefox-container-5</var>."
|
|
15701
15778
|
},
|
|
15702
15779
|
"type": {
|
|
15703
15780
|
"$ref": "TabType",
|
|
@@ -15772,12 +15849,12 @@
|
|
|
15772
15849
|
"status",
|
|
15773
15850
|
"title"
|
|
15774
15851
|
],
|
|
15775
|
-
"description": "Event names supported in onUpdated."
|
|
15852
|
+
"description": "Event names supported in $(ref:tabs.onUpdated)."
|
|
15776
15853
|
},
|
|
15777
15854
|
{
|
|
15778
15855
|
"id": "UpdateFilter",
|
|
15779
15856
|
"type": "object",
|
|
15780
|
-
"description": "An object describing filters to apply to tabs.onUpdated events.",
|
|
15857
|
+
"description": "An object describing filters to apply to $(ref:tabs.onUpdated) events.",
|
|
15781
15858
|
"properties": {
|
|
15782
15859
|
"urls": {
|
|
15783
15860
|
"type": "array",
|
|
@@ -15862,7 +15939,7 @@
|
|
|
15862
15939
|
{
|
|
15863
15940
|
"name": "connect",
|
|
15864
15941
|
"type": "function",
|
|
15865
|
-
"description": "Connects to the content script(s) in the specified tab. The
|
|
15942
|
+
"description": "Connects to the content script(s) in the specified tab. The $(url:runtime-on-connect)[runtime.onConnect] event is fired in each content script running in the specified tab for the current extension. For more details, see $(url:content-scripts)[Content Script Messaging].",
|
|
15866
15943
|
"parameters": [
|
|
15867
15944
|
{
|
|
15868
15945
|
"type": "integer",
|
|
@@ -15896,7 +15973,7 @@
|
|
|
15896
15973
|
{
|
|
15897
15974
|
"name": "sendMessage",
|
|
15898
15975
|
"type": "function",
|
|
15899
|
-
"description": "Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The
|
|
15976
|
+
"description": "Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The $(url:runtime-on-message)[runtime.onMessage] event is fired in each content script running in the specified tab for the current extension.",
|
|
15900
15977
|
"async": "responseCallback",
|
|
15901
15978
|
"parameters": [
|
|
15902
15979
|
{
|
|
@@ -15929,7 +16006,7 @@
|
|
|
15929
16006
|
{
|
|
15930
16007
|
"name": "response",
|
|
15931
16008
|
"type": "any",
|
|
15932
|
-
"description": "The JSON response object sent by the handler of the message. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and
|
|
16009
|
+
"description": "The JSON response object sent by the handler of the message. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and $(url:runtime-last-error)[runtime.lastError] will be set to the error message."
|
|
15933
16010
|
}
|
|
15934
16011
|
]
|
|
15935
16012
|
}
|
|
@@ -15938,7 +16015,7 @@
|
|
|
15938
16015
|
{
|
|
15939
16016
|
"name": "create",
|
|
15940
16017
|
"type": "function",
|
|
15941
|
-
"description": "Creates a new content tab. To create message tabs, use the $(ref:messageDisplay.open). Only supported in <var>normal</var> windows. Same-site links in the loaded page are opened within Thunderbird, all other links are opened in the user's default browser. To override this behavior, add-ons have to register a
|
|
16018
|
+
"description": "Creates a new content tab. To create message tabs, use the $(ref:messageDisplay.open). Only supported in <var>normal</var> windows. Same-site links in the loaded page are opened within Thunderbird, all other links are opened in the user's default browser. To override this behavior, add-ons have to register a $(url:content-script-click-capture)[content script] , capture click events and handle them manually.",
|
|
15942
16019
|
"async": "callback",
|
|
15943
16020
|
"parameters": [
|
|
15944
16021
|
{
|
|
@@ -15971,7 +16048,7 @@
|
|
|
15971
16048
|
"cookieStoreId": {
|
|
15972
16049
|
"type": "string",
|
|
15973
16050
|
"optional": true,
|
|
15974
|
-
"description": "The
|
|
16051
|
+
"description": "The $(url:cookieStore)[CookieStore] id the new tab should use. Either a custom id created using the $(url:contextualIdentity)[contextualIdentities API], or a built-in one: <var>firefox-default</var>, <var>firefox-container-1</var>, <var>firefox-container-2</var>, <var>firefox-container-3</var>, <var>firefox-container-4</var>, <var>firefox-container-5</var>."
|
|
15975
16052
|
},
|
|
15976
16053
|
"linkHandler": {
|
|
15977
16054
|
"type": "string",
|
|
@@ -16114,7 +16191,7 @@
|
|
|
16114
16191
|
}
|
|
16115
16192
|
],
|
|
16116
16193
|
"optional": true,
|
|
16117
|
-
"description": "Match tabs against one or more
|
|
16194
|
+
"description": "Match tabs against one or more $(url:match-patterns)[URL Patterns]. Fragment identifiers are not matched."
|
|
16118
16195
|
},
|
|
16119
16196
|
"windowId": {
|
|
16120
16197
|
"type": "integer",
|
|
@@ -16146,7 +16223,7 @@
|
|
|
16146
16223
|
}
|
|
16147
16224
|
],
|
|
16148
16225
|
"optional": true,
|
|
16149
|
-
"description": "The
|
|
16226
|
+
"description": "The $(url:cookieStore)[CookieStore] id(s) used by the tabs. Either custom ids created using the $(url:contextualIdentity)[contextualIdentities API], or built-in ones: <var>firefox-default</var>, <var>firefox-container-1</var>, <var>firefox-container-2</var>, <var>firefox-container-3</var>, <var>firefox-container-4</var>, <var>firefox-container-5</var>."
|
|
16150
16227
|
}
|
|
16151
16228
|
}
|
|
16152
16229
|
},
|
|
@@ -16187,7 +16264,7 @@
|
|
|
16187
16264
|
"url": {
|
|
16188
16265
|
"type": "string",
|
|
16189
16266
|
"optional": true,
|
|
16190
|
-
"description": "A URL of a page to load. If the URL points to a content page (a web page, an extension page or a registered WebExtension protocol handler page), the tab will navigate to the requested page. All other URLs will be opened externally without changing the tab.
|
|
16267
|
+
"description": "A URL of a page to load. If the URL points to a content page (a web page, an extension page or a registered WebExtension protocol handler page), the tab will navigate to the requested page. All other URLs will be opened externally without changing the tab."
|
|
16191
16268
|
},
|
|
16192
16269
|
"active": {
|
|
16193
16270
|
"type": "boolean",
|
|
@@ -16213,7 +16290,7 @@
|
|
|
16213
16290
|
{
|
|
16214
16291
|
"name": "move",
|
|
16215
16292
|
"type": "function",
|
|
16216
|
-
"description": "Moves one or more tabs to a new position within its current window, or to a different window.
|
|
16293
|
+
"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>.",
|
|
16217
16294
|
"async": "callback",
|
|
16218
16295
|
"parameters": [
|
|
16219
16296
|
{
|
|
@@ -16335,7 +16412,7 @@
|
|
|
16335
16412
|
"name": "executeScript",
|
|
16336
16413
|
"type": "function",
|
|
16337
16414
|
"max_manifest_version": 2,
|
|
16338
|
-
"description": "Injects JavaScript code into a page. For details, see the
|
|
16415
|
+
"description": "Injects JavaScript code into a page. For details, see the $(url:content-scripts)[programmatic injection] section of the content scripts doc.",
|
|
16339
16416
|
"async": "callback",
|
|
16340
16417
|
"parameters": [
|
|
16341
16418
|
{
|
|
@@ -16373,7 +16450,7 @@
|
|
|
16373
16450
|
"name": "insertCSS",
|
|
16374
16451
|
"type": "function",
|
|
16375
16452
|
"max_manifest_version": 2,
|
|
16376
|
-
"description": "Injects CSS into a page. For details, see the
|
|
16453
|
+
"description": "Injects CSS into a page. For details, see the $(url:content-scripts)[programmatic injection] section of the content scripts doc.",
|
|
16377
16454
|
"async": "callback",
|
|
16378
16455
|
"parameters": [
|
|
16379
16456
|
{
|
|
@@ -16401,7 +16478,7 @@
|
|
|
16401
16478
|
"name": "removeCSS",
|
|
16402
16479
|
"type": "function",
|
|
16403
16480
|
"max_manifest_version": 2,
|
|
16404
|
-
"description": "Removes injected CSS from a page. For details, see the
|
|
16481
|
+
"description": "Removes injected CSS from a page. For details, see the $(url:content-scripts)[programmatic injection] section of the content scripts doc.",
|
|
16405
16482
|
"async": "callback",
|
|
16406
16483
|
"parameters": [
|
|
16407
16484
|
{
|
|
@@ -16519,7 +16596,7 @@
|
|
|
16519
16596
|
{
|
|
16520
16597
|
"name": "onActivated",
|
|
16521
16598
|
"type": "function",
|
|
16522
|
-
"description": "Fires when the active tab in a window changes.
|
|
16599
|
+
"description": "Fires when the active tab in a window changes. The tab's URL may not be set at the time this event fired, listen to the $(ref:tabs.onUpdated) event instead to be notified when a URL is set.",
|
|
16523
16600
|
"parameters": [
|
|
16524
16601
|
{
|
|
16525
16602
|
"type": "object",
|
|
@@ -16872,7 +16949,7 @@
|
|
|
16872
16949
|
{
|
|
16873
16950
|
"name": "create",
|
|
16874
16951
|
"type": "function",
|
|
16875
|
-
"description": "Creates (opens) a new window with any optional sizing, position or default URL provided. When loading a page into a popup window, same-site links are opened within the same window, all other links are opened in the user's default browser. To override this behavior, add-ons have to register a
|
|
16952
|
+
"description": "Creates (opens) a new window with any optional sizing, position or default URL provided. When loading a page into a popup window, same-site links are opened within the same window, all other links are opened in the user's default browser. To override this behavior, add-ons have to register a $(url:content-script-click-capture)[content script] , capture click events and handle them manually. Same-site links with targets other than <var>_self</var> are opened in a new tab in the most recent <var>normal</var> Thunderbird window.",
|
|
16876
16953
|
"async": "callback",
|
|
16877
16954
|
"parameters": [
|
|
16878
16955
|
{
|
|
@@ -16955,7 +17032,7 @@
|
|
|
16955
17032
|
"cookieStoreId": {
|
|
16956
17033
|
"type": "string",
|
|
16957
17034
|
"optional": true,
|
|
16958
|
-
"description": "The
|
|
17035
|
+
"description": "The $(url:cookieStore)[CookieStore] id which all initially opened tabs should use. Either a custom id created using the $(url:contextualIdentity)[contextualIdentities API], or a built-in one: <var>firefox-default</var>, <var>firefox-container-1</var>, <var>firefox-container-2</var>, <var>firefox-container-3</var>, <var>firefox-container-4</var>, <var>firefox-container-5</var>."
|
|
16959
17036
|
},
|
|
16960
17037
|
"linkHandler": {
|
|
16961
17038
|
"type": "string",
|
|
@@ -17141,7 +17218,7 @@
|
|
|
17141
17218
|
{
|
|
17142
17219
|
"name": "onFocusChanged",
|
|
17143
17220
|
"type": "function",
|
|
17144
|
-
"description": "Fired when the currently focused window changes. Will be $(ref:windows.WINDOW_ID_NONE), if all windows have lost focus.
|
|
17221
|
+
"description": "Fired when the currently focused window changes. Will be $(ref:windows.WINDOW_ID_NONE), if all windows have lost focus.",
|
|
17145
17222
|
"filters": [
|
|
17146
17223
|
{
|
|
17147
17224
|
"name": "windowTypes",
|