webext-schema 5.0.5 → 5.0.7
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/package.json +7 -7
- package/schemas/beta/webext.json +2 -8
- package/schemas/central/webext.json +88 -48
- package/schemas/mail/mailext.json +870 -460
- package/schemas/release/webext.json +2 -8
|
@@ -2281,11 +2281,11 @@
|
|
|
2281
2281
|
"choices": [
|
|
2282
2282
|
{
|
|
2283
2283
|
"type": "string",
|
|
2284
|
-
"description": "A string containing a valid `CSS color string
|
|
2284
|
+
"description": "A string containing a valid `CSS color string <|link-css-color-string|>`__, including hexadecimal or functional representations. For example the color *crimson* can be specified as: <li><value>crimson</value> <li><value>#dc143c</value> <li><value>rgb(220, 20, 60)</value> (or <value>rgba(220, 20, 60, 0.5)</value> to set 50% opacity) <li><value>hsl(348, 83%, 47%)</value> (or <value>hsla(348, 83%, 47%, 0.5)</value> to set 50% opacity)"
|
|
2285
2285
|
},
|
|
2286
2286
|
{
|
|
2287
2287
|
"type": "array",
|
|
2288
|
-
"description": "An RGB array of 3 integers. For example
|
|
2288
|
+
"description": "An RGB array of 3 integers. For example <value>[220, 20, 60]</value> for the color *crimson*.",
|
|
2289
2289
|
"minItems": 3,
|
|
2290
2290
|
"maxItems": 3,
|
|
2291
2291
|
"items": {
|
|
@@ -2296,7 +2296,7 @@
|
|
|
2296
2296
|
},
|
|
2297
2297
|
{
|
|
2298
2298
|
"type": "array",
|
|
2299
|
-
"description": "An RGBA array of 3 integers and a fractional (a float between 0 and 1). For example
|
|
2299
|
+
"description": "An RGBA array of 3 integers and a fractional (a float between 0 and 1). For example <value>[220, 20, 60, 0.5]<value> for the color *crimson* with 50% opacity.",
|
|
2300
2300
|
"minItems": 4,
|
|
2301
2301
|
"maxItems": 4,
|
|
2302
2302
|
"items": {
|
|
@@ -2312,11 +2312,13 @@
|
|
|
2312
2312
|
"properties": {
|
|
2313
2313
|
"stylesheet": {
|
|
2314
2314
|
"optional": true,
|
|
2315
|
+
"description": "URL to a stylesheet introducing additional CSS variables, extending the theme-able areas of Thunderbird. The `theme_experiment add-on in our example repository <https://github.com/thundernest/sample-extensions/tree/master/theme_experiment>`__ is using the stylesheet shown below, to add the <value>--chat-button-color</value> CSS color variable: <literalinclude>includes/theme/theme_experiment_style.css<lang>CSS</lang></literalinclude>The following <em>manifest.json</em> file maps the </value>--chat-button-color</value> CSS color variable to the theme color key <value>exp_chat_button</value> and uses it to set a color for the chat button: <literalinclude>includes/theme/theme_experiment_manifest.json<lang>JSON</lang></literalinclude>",
|
|
2315
2316
|
"$ref": "ExtensionURL"
|
|
2316
2317
|
},
|
|
2317
2318
|
"images": {
|
|
2318
2319
|
"type": "object",
|
|
2319
2320
|
"optional": true,
|
|
2321
|
+
"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`. Example: <literalinclude>includes/theme/theme_experiment_image.json<lang>JSON</lang></literalinclude>",
|
|
2320
2322
|
"additionalProperties": {
|
|
2321
2323
|
"type": "string"
|
|
2322
2324
|
}
|
|
@@ -2324,6 +2326,7 @@
|
|
|
2324
2326
|
"colors": {
|
|
2325
2327
|
"type": "object",
|
|
2326
2328
|
"optional": true,
|
|
2329
|
+
"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 example shown below maps the theme color key <value>popup_affordance</value> to the CSS color variable </value>--arrowpanel-dimmed</value>. The new color key is usable as a color reference in :ref:`theme.ThemeType`. <literalinclude>includes/theme/theme_experiment_color.json<lang>JSON</lang></literalinclude>",
|
|
2327
2330
|
"additionalProperties": {
|
|
2328
2331
|
"type": "string"
|
|
2329
2332
|
}
|
|
@@ -2331,6 +2334,7 @@
|
|
|
2331
2334
|
"properties": {
|
|
2332
2335
|
"type": "object",
|
|
2333
2336
|
"optional": true,
|
|
2337
|
+
"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`. Example: <literalinclude>includes/theme/theme_experiment_property.json<lang>JSON</lang></literalinclude>",
|
|
2334
2338
|
"additionalProperties": {
|
|
2335
2339
|
"type": "string"
|
|
2336
2340
|
}
|
|
@@ -2343,7 +2347,7 @@
|
|
|
2343
2347
|
"type": "object",
|
|
2344
2348
|
"properties": {
|
|
2345
2349
|
"images": {
|
|
2346
|
-
"description": "
|
|
2350
|
+
"description": "A <em>dictionary object</em> with one or more <em>key-value</em> pairs to map images to theme image keys. The following built-in theme image keys are supported:",
|
|
2347
2351
|
"type": "object",
|
|
2348
2352
|
"optional": true,
|
|
2349
2353
|
"properties": {
|
|
@@ -2354,12 +2358,12 @@
|
|
|
2354
2358
|
},
|
|
2355
2359
|
"maxItems": 15,
|
|
2356
2360
|
"optional": true,
|
|
2357
|
-
"description": "Additional images added to the header area and displayed behind the
|
|
2361
|
+
"description": "Additional images added to the header area and displayed behind the ``theme_frame`` image."
|
|
2358
2362
|
},
|
|
2359
2363
|
"headerURL": {
|
|
2360
2364
|
"$ref": "ImageDataOrExtensionURL",
|
|
2361
2365
|
"optional": true,
|
|
2362
|
-
"deprecated": "Unsupported images property, use
|
|
2366
|
+
"deprecated": "Unsupported images property, use ``theme.images.theme_frame``, this alias is ignored in Thunderbird >= 70."
|
|
2363
2367
|
},
|
|
2364
2368
|
"theme_frame": {
|
|
2365
2369
|
"$ref": "ImageDataOrExtensionURL",
|
|
@@ -2372,7 +2376,7 @@
|
|
|
2372
2376
|
}
|
|
2373
2377
|
},
|
|
2374
2378
|
"colors": {
|
|
2375
|
-
"description": "
|
|
2379
|
+
"description": "A <em>dictionary object</em> with one or more <em>key-value</em> pairs to map color values to theme color keys. The following built-in theme color keys are supported:",
|
|
2376
2380
|
"type": "object",
|
|
2377
2381
|
"optional": true,
|
|
2378
2382
|
"properties": {
|
|
@@ -2384,7 +2388,7 @@
|
|
|
2384
2388
|
"accentcolor": {
|
|
2385
2389
|
"$ref": "ThemeColor",
|
|
2386
2390
|
"optional": true,
|
|
2387
|
-
"deprecated": "Unsupported colors property, use
|
|
2391
|
+
"deprecated": "Unsupported colors property, use ``theme.colors.frame``, this alias is ignored in Thunderbird >= 70."
|
|
2388
2392
|
},
|
|
2389
2393
|
"frame": {
|
|
2390
2394
|
"$ref": "ThemeColor",
|
|
@@ -2399,7 +2403,7 @@
|
|
|
2399
2403
|
"textcolor": {
|
|
2400
2404
|
"$ref": "ThemeColor",
|
|
2401
2405
|
"optional": true,
|
|
2402
|
-
"deprecated": "Unsupported color property, use
|
|
2406
|
+
"deprecated": "Unsupported color property, use ``theme.colors.tab_background_text``, this alias is ignored in Thunderbird >= 70."
|
|
2403
2407
|
},
|
|
2404
2408
|
"tab_background_text": {
|
|
2405
2409
|
"$ref": "ThemeColor",
|
|
@@ -2419,7 +2423,7 @@
|
|
|
2419
2423
|
"tab_text": {
|
|
2420
2424
|
"$ref": "ThemeColor",
|
|
2421
2425
|
"optional": true,
|
|
2422
|
-
"description": "The text color for the selected tab.
|
|
2426
|
+
"description": "The text color for the selected tab. Defaults to the color specified by ``toolbar_text``."
|
|
2423
2427
|
},
|
|
2424
2428
|
"tab_line": {
|
|
2425
2429
|
"$ref": "ThemeColor",
|
|
@@ -2593,7 +2597,7 @@
|
|
|
2593
2597
|
}
|
|
2594
2598
|
},
|
|
2595
2599
|
"properties": {
|
|
2596
|
-
"description": "
|
|
2600
|
+
"description": "A <em>dictionary object</em> with one or more <em>key-value</em> pairs to map property values to theme property keys. The following built-in theme property keys are supported:",
|
|
2597
2601
|
"type": "object",
|
|
2598
2602
|
"optional": true,
|
|
2599
2603
|
"properties": {
|
|
@@ -2636,7 +2640,7 @@
|
|
|
2636
2640
|
"optional": true
|
|
2637
2641
|
},
|
|
2638
2642
|
"color_scheme": {
|
|
2639
|
-
"description": "If set, overrides the general
|
|
2643
|
+
"description": "If set, overrides the general theme (context menus, toolbars, content area).",
|
|
2640
2644
|
"optional": true,
|
|
2641
2645
|
"type": "string",
|
|
2642
2646
|
"enum": [
|
|
@@ -2705,7 +2709,8 @@
|
|
|
2705
2709
|
"properties": {
|
|
2706
2710
|
"theme_experiment": {
|
|
2707
2711
|
"$ref": "ThemeExperiment",
|
|
2708
|
-
"optional": true
|
|
2712
|
+
"optional": true,
|
|
2713
|
+
"description": "A theme experiment allows modifying the user interface of Thunderbird beyond what is currently possible using the built-in color, image and property keys of :ref:`theme.ThemeType`. These experiments are a precursor to proposing new theme features for inclusion in Thunderbird. Experimentation is done by mapping internal CSS color, image and property variables to new theme keys and using them in :ref:`theme.ThemeType` and by loading additional style sheets to add new CSS variables, extending the theme-able areas of Thunderbird. Can be used in static and dynamic themes."
|
|
2709
2714
|
}
|
|
2710
2715
|
}
|
|
2711
2716
|
}
|
|
@@ -2713,7 +2718,7 @@
|
|
|
2713
2718
|
},
|
|
2714
2719
|
{
|
|
2715
2720
|
"namespace": "theme",
|
|
2716
|
-
"description": "The theme API allows
|
|
2721
|
+
"description": "The theme API allows for customization of Thunderbird's visual elements.",
|
|
2717
2722
|
"types": [
|
|
2718
2723
|
{
|
|
2719
2724
|
"id": "ThemeUpdateInfo",
|
|
@@ -2721,7 +2726,7 @@
|
|
|
2721
2726
|
"description": "Info provided in the onUpdated listener.",
|
|
2722
2727
|
"properties": {
|
|
2723
2728
|
"theme": {
|
|
2724
|
-
"
|
|
2729
|
+
"$ref": "ThemeType",
|
|
2725
2730
|
"description": "The new theme after update"
|
|
2726
2731
|
},
|
|
2727
2732
|
"windowId": {
|
|
@@ -2851,7 +2856,7 @@
|
|
|
2851
2856
|
},
|
|
2852
2857
|
"type": {
|
|
2853
2858
|
"type": "string",
|
|
2854
|
-
"description": "What sort of account this is, e.g.
|
|
2859
|
+
"description": "What sort of account this is, e.g. <value>imap</value>, <value>nntp</value>, or <value>pop3</value>."
|
|
2855
2860
|
},
|
|
2856
2861
|
"folders": {
|
|
2857
2862
|
"type": "array",
|
|
@@ -2880,7 +2885,7 @@
|
|
|
2880
2885
|
"parameters": [
|
|
2881
2886
|
{
|
|
2882
2887
|
"name": "includeFolders",
|
|
2883
|
-
"description": "Specifies whether the returned :ref:`accounts.MailAccount` objects should included their account's folders. Defaults to
|
|
2888
|
+
"description": "Specifies whether the returned :ref:`accounts.MailAccount` objects should included their account's folders. Defaults to <value>true</value>.",
|
|
2884
2889
|
"optional": true,
|
|
2885
2890
|
"default": true,
|
|
2886
2891
|
"type": "boolean"
|
|
@@ -2903,7 +2908,7 @@
|
|
|
2903
2908
|
{
|
|
2904
2909
|
"name": "get",
|
|
2905
2910
|
"type": "function",
|
|
2906
|
-
"description": "Returns details of the requested account, or null if it doesn't exist.",
|
|
2911
|
+
"description": "Returns details of the requested account, or <value>null</value> if it doesn't exist.",
|
|
2907
2912
|
"async": "callback",
|
|
2908
2913
|
"parameters": [
|
|
2909
2914
|
{
|
|
@@ -2912,7 +2917,7 @@
|
|
|
2912
2917
|
},
|
|
2913
2918
|
{
|
|
2914
2919
|
"name": "includeFolders",
|
|
2915
|
-
"description": "Specifies whether the returned :ref:`accounts.MailAccount` object should included the account's folders. Defaults to
|
|
2920
|
+
"description": "Specifies whether the returned :ref:`accounts.MailAccount` object should included the account's folders. Defaults to <value>true</value>.",
|
|
2916
2921
|
"optional": true,
|
|
2917
2922
|
"default": true,
|
|
2918
2923
|
"type": "boolean"
|
|
@@ -2933,12 +2938,12 @@
|
|
|
2933
2938
|
{
|
|
2934
2939
|
"name": "getDefault",
|
|
2935
2940
|
"type": "function",
|
|
2936
|
-
"description": "Returns the default account, or null if it is not defined.",
|
|
2941
|
+
"description": "Returns the default account, or <value>null</value> if it is not defined.",
|
|
2937
2942
|
"async": "callback",
|
|
2938
2943
|
"parameters": [
|
|
2939
2944
|
{
|
|
2940
2945
|
"name": "includeFolders",
|
|
2941
|
-
"description": "Specifies whether the returned :ref:`accounts.MailAccount` object should included the account's folders. Defaults to
|
|
2946
|
+
"description": "Specifies whether the returned :ref:`accounts.MailAccount` object should included the account's folders. Defaults to <value>true</value>.",
|
|
2942
2947
|
"optional": true,
|
|
2943
2948
|
"default": true,
|
|
2944
2949
|
"type": "boolean"
|
|
@@ -2976,7 +2981,7 @@
|
|
|
2976
2981
|
{
|
|
2977
2982
|
"name": "getDefaultIdentity",
|
|
2978
2983
|
"type": "function",
|
|
2979
|
-
"description": "Returns the default identity for an account, or null if it is not defined.",
|
|
2984
|
+
"description": "Returns the default identity for an account, or <value>null</value> if it is not defined.",
|
|
2980
2985
|
"async": "callback",
|
|
2981
2986
|
"deprecated": "This will be removed. Use :ref:`identities.getDefault` instead.",
|
|
2982
2987
|
"parameters": [
|
|
@@ -3083,7 +3088,7 @@
|
|
|
3083
3088
|
"contact",
|
|
3084
3089
|
"mailingList"
|
|
3085
3090
|
],
|
|
3086
|
-
"description": "Indicates the type of a Node
|
|
3091
|
+
"description": "Indicates the type of a Node."
|
|
3087
3092
|
},
|
|
3088
3093
|
{
|
|
3089
3094
|
"id": "AddressBookNode",
|
|
@@ -3097,11 +3102,11 @@
|
|
|
3097
3102
|
"parentId": {
|
|
3098
3103
|
"type": "string",
|
|
3099
3104
|
"optional": true,
|
|
3100
|
-
"description": "The
|
|
3105
|
+
"description": "The ``id`` of the parent object."
|
|
3101
3106
|
},
|
|
3102
3107
|
"type": {
|
|
3103
3108
|
"$ref": "NodeType",
|
|
3104
|
-
"description": "Always set to <
|
|
3109
|
+
"description": "Always set to <value>addressBook</value>."
|
|
3105
3110
|
},
|
|
3106
3111
|
"readOnly": {
|
|
3107
3112
|
"type": "boolean",
|
|
@@ -3314,7 +3319,7 @@
|
|
|
3314
3319
|
{
|
|
3315
3320
|
"name": "onSearchRequest",
|
|
3316
3321
|
"type": "function",
|
|
3317
|
-
"description": "Registering this listener will create and list a read-only address book in Thunderbird's address book window, similar to LDAP address books. When selecting this address book, users will first see no contacts, but they can search for them, 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.\n\nThe event also fires for each registered listener (for each created read-only address book), when users type something into the mail composer's <
|
|
3322
|
+
"description": "Registering this listener will create and list a read-only address book in Thunderbird's address book window, similar to LDAP address books. When selecting this address book, users will first see no contacts, but they can search for them, 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.\n\nThe event also fires for each registered listener (for each created read-only address book), when users type something into the mail composer's <em>To:</em> field, or into similar fields like the calendar meeting attendees field. Contacts returned by the listener callback will be added to the autocomplete results in the dropdown of that field.\n\nExample: <literalinclude>includes/addressBooks/onSearchRequest.js<lang>JavaScript</lang></literalinclude>",
|
|
3318
3323
|
"parameters": [
|
|
3319
3324
|
{
|
|
3320
3325
|
"name": "node",
|
|
@@ -3366,6 +3371,42 @@
|
|
|
3366
3371
|
"addressBooks"
|
|
3367
3372
|
],
|
|
3368
3373
|
"types": [
|
|
3374
|
+
{
|
|
3375
|
+
"id": "QueryInfo",
|
|
3376
|
+
"description": "Object defining a query for :ref:`contacts.quickSearch`.",
|
|
3377
|
+
"type": "object",
|
|
3378
|
+
"properties": {
|
|
3379
|
+
"searchString": {
|
|
3380
|
+
"type": "string",
|
|
3381
|
+
"optional": true,
|
|
3382
|
+
"description": "One or more space-separated terms to search for."
|
|
3383
|
+
},
|
|
3384
|
+
"includeLocal": {
|
|
3385
|
+
"type": "boolean",
|
|
3386
|
+
"optional": true,
|
|
3387
|
+
"default": true,
|
|
3388
|
+
"description": "Whether to include results from local address books. Defaults to true."
|
|
3389
|
+
},
|
|
3390
|
+
"includeRemote": {
|
|
3391
|
+
"type": "boolean",
|
|
3392
|
+
"optional": true,
|
|
3393
|
+
"default": true,
|
|
3394
|
+
"description": "Whether to include results from remote address books. Defaults to true."
|
|
3395
|
+
},
|
|
3396
|
+
"includeReadOnly": {
|
|
3397
|
+
"type": "boolean",
|
|
3398
|
+
"optional": true,
|
|
3399
|
+
"default": true,
|
|
3400
|
+
"description": "Whether to include results from read-only address books. Defaults to true."
|
|
3401
|
+
},
|
|
3402
|
+
"includeReadWrite": {
|
|
3403
|
+
"type": "boolean",
|
|
3404
|
+
"optional": true,
|
|
3405
|
+
"default": true,
|
|
3406
|
+
"description": "Whether to include results from read-write address books. Defaults to true."
|
|
3407
|
+
}
|
|
3408
|
+
}
|
|
3409
|
+
},
|
|
3369
3410
|
{
|
|
3370
3411
|
"id": "ContactNode",
|
|
3371
3412
|
"type": "object",
|
|
@@ -3378,11 +3419,11 @@
|
|
|
3378
3419
|
"parentId": {
|
|
3379
3420
|
"type": "string",
|
|
3380
3421
|
"optional": true,
|
|
3381
|
-
"description": "The
|
|
3422
|
+
"description": "The ``id`` of the parent object."
|
|
3382
3423
|
},
|
|
3383
3424
|
"type": {
|
|
3384
3425
|
"$ref": "addressBooks.NodeType",
|
|
3385
|
-
"description": "Always set to <
|
|
3426
|
+
"description": "Always set to <value>contact</value>."
|
|
3386
3427
|
},
|
|
3387
3428
|
"readOnly": {
|
|
3388
3429
|
"type": "boolean",
|
|
@@ -3419,7 +3460,7 @@
|
|
|
3419
3460
|
{
|
|
3420
3461
|
"id": "PropertyChange",
|
|
3421
3462
|
"type": "object",
|
|
3422
|
-
"description": "A dictionary of changed properties. Keys are the property name that changed, values are an object containing ``oldValue`` and ``newValue``. Values can be either a string or null
|
|
3463
|
+
"description": "A dictionary of changed properties. Keys are the property name that changed, values are an object containing ``oldValue`` and ``newValue``. Values can be either a string or <value>null</value>.",
|
|
3423
3464
|
"patternProperties": {
|
|
3424
3465
|
"^\\w+$": {
|
|
3425
3466
|
"type": "object",
|
|
@@ -3473,7 +3514,7 @@
|
|
|
3473
3514
|
]
|
|
3474
3515
|
}
|
|
3475
3516
|
],
|
|
3476
|
-
"description": "Gets all the contacts in the address book with the id
|
|
3517
|
+
"description": "Gets all the contacts in the address book with the id ``parentId``."
|
|
3477
3518
|
},
|
|
3478
3519
|
{
|
|
3479
3520
|
"name": "quickSearch",
|
|
@@ -3488,44 +3529,13 @@
|
|
|
3488
3529
|
},
|
|
3489
3530
|
{
|
|
3490
3531
|
"name": "queryInfo",
|
|
3532
|
+
"description": "Either a <em>string</em> with one or more space-separated terms to search for, or a complex :ref:`contacts.QueryInfo` search query.",
|
|
3491
3533
|
"choices": [
|
|
3492
3534
|
{
|
|
3493
|
-
"type": "string"
|
|
3494
|
-
"description": "One or more space-separated terms to search for."
|
|
3535
|
+
"type": "string"
|
|
3495
3536
|
},
|
|
3496
3537
|
{
|
|
3497
|
-
"
|
|
3498
|
-
"properties": {
|
|
3499
|
-
"searchString": {
|
|
3500
|
-
"type": "string",
|
|
3501
|
-
"optional": true,
|
|
3502
|
-
"description": "One or more space-separated terms to search for."
|
|
3503
|
-
},
|
|
3504
|
-
"includeLocal": {
|
|
3505
|
-
"type": "boolean",
|
|
3506
|
-
"optional": true,
|
|
3507
|
-
"default": true,
|
|
3508
|
-
"description": "Whether to include results from local address books. Defaults to true."
|
|
3509
|
-
},
|
|
3510
|
-
"includeRemote": {
|
|
3511
|
-
"type": "boolean",
|
|
3512
|
-
"optional": true,
|
|
3513
|
-
"default": true,
|
|
3514
|
-
"description": "Whether to include results from remote address books. Defaults to true."
|
|
3515
|
-
},
|
|
3516
|
-
"includeReadOnly": {
|
|
3517
|
-
"type": "boolean",
|
|
3518
|
-
"optional": true,
|
|
3519
|
-
"default": true,
|
|
3520
|
-
"description": "Whether to include results from read-only address books. Defaults to true."
|
|
3521
|
-
},
|
|
3522
|
-
"includeReadWrite": {
|
|
3523
|
-
"type": "boolean",
|
|
3524
|
-
"optional": true,
|
|
3525
|
-
"default": true,
|
|
3526
|
-
"description": "Whether to include results from read-write address books. Defaults to true."
|
|
3527
|
-
}
|
|
3528
|
-
}
|
|
3538
|
+
"$ref": "QueryInfo"
|
|
3529
3539
|
}
|
|
3530
3540
|
]
|
|
3531
3541
|
},
|
|
@@ -3602,6 +3612,7 @@
|
|
|
3602
3612
|
"type": "string"
|
|
3603
3613
|
},
|
|
3604
3614
|
{
|
|
3615
|
+
"name": "file",
|
|
3605
3616
|
"type": "object",
|
|
3606
3617
|
"isInstanceOf": "File",
|
|
3607
3618
|
"additionalProperties": true
|
|
@@ -3627,7 +3638,7 @@
|
|
|
3627
3638
|
{
|
|
3628
3639
|
"name": "properties",
|
|
3629
3640
|
"$ref": "ContactProperties",
|
|
3630
|
-
"description": "The properties object for the new contact. If it includes a
|
|
3641
|
+
"description": "The properties object for the new contact. If it includes a ``vCard`` member, all specified `legacy properties <|link-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. **Note:** Using individual properties is deprecated, use the ``vCard`` member instead."
|
|
3631
3642
|
},
|
|
3632
3643
|
{
|
|
3633
3644
|
"type": "function",
|
|
@@ -3641,7 +3652,7 @@
|
|
|
3641
3652
|
]
|
|
3642
3653
|
}
|
|
3643
3654
|
],
|
|
3644
|
-
"description": "Adds a new contact to the address book with the id
|
|
3655
|
+
"description": "Adds a new contact to the address book with the id ``parentId``."
|
|
3645
3656
|
},
|
|
3646
3657
|
{
|
|
3647
3658
|
"name": "update",
|
|
@@ -3655,7 +3666,7 @@
|
|
|
3655
3666
|
{
|
|
3656
3667
|
"name": "properties",
|
|
3657
3668
|
"$ref": "ContactProperties",
|
|
3658
|
-
"description": "An object with properties to update the specified contact. Individual properties are removed, if they are set to <
|
|
3669
|
+
"description": "An object with properties to update the specified contact. Individual properties are removed, if they are set to <value>null</value>. If the provided object includes a ``vCard`` member, all specified `legacy properties <|link-legacy-properties|>`__ are ignored and the details of the contact will be replaced by the provided vCard. Changes to the UID will be ignored. **Note:** Using individual properties is deprecated, use the ``vCard`` member instead. "
|
|
3659
3670
|
}
|
|
3660
3671
|
],
|
|
3661
3672
|
"description": "Updates a contact."
|
|
@@ -3739,11 +3750,11 @@
|
|
|
3739
3750
|
"parentId": {
|
|
3740
3751
|
"type": "string",
|
|
3741
3752
|
"optional": true,
|
|
3742
|
-
"description": "The
|
|
3753
|
+
"description": "The ``id`` of the parent object."
|
|
3743
3754
|
},
|
|
3744
3755
|
"type": {
|
|
3745
3756
|
"$ref": "addressBooks.NodeType",
|
|
3746
|
-
"description": "Always set to <
|
|
3757
|
+
"description": "Always set to <value>mailingList</value>."
|
|
3747
3758
|
},
|
|
3748
3759
|
"readOnly": {
|
|
3749
3760
|
"type": "boolean",
|
|
@@ -3799,7 +3810,7 @@
|
|
|
3799
3810
|
]
|
|
3800
3811
|
}
|
|
3801
3812
|
],
|
|
3802
|
-
"description": "Gets all the mailing lists in the address book with id
|
|
3813
|
+
"description": "Gets all the mailing lists in the address book with id ``parentId``."
|
|
3803
3814
|
},
|
|
3804
3815
|
{
|
|
3805
3816
|
"name": "get",
|
|
@@ -3861,7 +3872,7 @@
|
|
|
3861
3872
|
]
|
|
3862
3873
|
}
|
|
3863
3874
|
],
|
|
3864
|
-
"description": "Creates a new mailing list in the address book with id
|
|
3875
|
+
"description": "Creates a new mailing list in the address book with id ``parentId``."
|
|
3865
3876
|
},
|
|
3866
3877
|
{
|
|
3867
3878
|
"name": "update",
|
|
@@ -3918,7 +3929,7 @@
|
|
|
3918
3929
|
"type": "string"
|
|
3919
3930
|
}
|
|
3920
3931
|
],
|
|
3921
|
-
"description": "Adds a contact to the mailing list with id
|
|
3932
|
+
"description": "Adds a contact to the mailing list with id ``id``. If the contact and mailing list are in different address books, the contact will also be copied to the list's address book."
|
|
3922
3933
|
},
|
|
3923
3934
|
{
|
|
3924
3935
|
"name": "listMembers",
|
|
@@ -3943,7 +3954,7 @@
|
|
|
3943
3954
|
]
|
|
3944
3955
|
}
|
|
3945
3956
|
],
|
|
3946
|
-
"description": "Gets all contacts that are members of the mailing list with id
|
|
3957
|
+
"description": "Gets all contacts that are members of the mailing list with id ``id``."
|
|
3947
3958
|
},
|
|
3948
3959
|
{
|
|
3949
3960
|
"name": "removeMember",
|
|
@@ -3959,7 +3970,7 @@
|
|
|
3959
3970
|
"type": "string"
|
|
3960
3971
|
}
|
|
3961
3972
|
],
|
|
3962
|
-
"description": "Removes a contact from the mailing list with id
|
|
3973
|
+
"description": "Removes a contact from the mailing list with id ``id``. This does not delete the contact from the address book."
|
|
3963
3974
|
}
|
|
3964
3975
|
],
|
|
3965
3976
|
"events": [
|
|
@@ -4042,19 +4053,19 @@
|
|
|
4042
4053
|
"properties": {
|
|
4043
4054
|
"default_label": {
|
|
4044
4055
|
"type": "string",
|
|
4045
|
-
"description": "The label of the action, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
|
|
4056
|
+
"description": "The label of the action button, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
|
|
4046
4057
|
"optional": true,
|
|
4047
4058
|
"preprocess": "localize"
|
|
4048
4059
|
},
|
|
4049
4060
|
"default_title": {
|
|
4050
4061
|
"type": "string",
|
|
4051
|
-
"description": "The title of the action. This shows up in the tooltip and the label. Defaults to the add-on name.",
|
|
4062
|
+
"description": "The title of the action button. This shows up in the tooltip and the label. Defaults to the add-on name.",
|
|
4052
4063
|
"optional": true,
|
|
4053
4064
|
"preprocess": "localize"
|
|
4054
4065
|
},
|
|
4055
4066
|
"default_icon": {
|
|
4056
4067
|
"$ref": "IconPath",
|
|
4057
|
-
"description": "The
|
|
4068
|
+
"description": "The paths to one or more icons for the action button.",
|
|
4058
4069
|
"optional": true
|
|
4059
4070
|
},
|
|
4060
4071
|
"theme_icons": {
|
|
@@ -4070,17 +4081,17 @@
|
|
|
4070
4081
|
"type": "string",
|
|
4071
4082
|
"format": "relativeUrl",
|
|
4072
4083
|
"optional": true,
|
|
4073
|
-
"description": "The html document to be opened as a popup when the user clicks on the action
|
|
4084
|
+
"description": "The html document to be opened as a popup when the user clicks on the action button.",
|
|
4074
4085
|
"preprocess": "localize"
|
|
4075
4086
|
},
|
|
4076
4087
|
"browser_style": {
|
|
4077
4088
|
"type": "boolean",
|
|
4078
4089
|
"optional": true,
|
|
4079
|
-
"description": "Enable browser styles. See the `MDN documentation on browser styles
|
|
4090
|
+
"description": "Enable browser styles. See the `MDN documentation on browser styles <|link-mdn-browser-styles|>`__ for more information.",
|
|
4080
4091
|
"default": false
|
|
4081
4092
|
},
|
|
4082
4093
|
"default_area": {
|
|
4083
|
-
"description": "Defines the location the action will appear. The default location is
|
|
4094
|
+
"description": "Defines the location the action button will appear. The default location is <value>maintoolbar</value>.",
|
|
4084
4095
|
"type": "string",
|
|
4085
4096
|
"enum": [
|
|
4086
4097
|
"maintoolbar",
|
|
@@ -4089,7 +4100,7 @@
|
|
|
4089
4100
|
"optional": true
|
|
4090
4101
|
},
|
|
4091
4102
|
"default_windows": {
|
|
4092
|
-
"description": "Defines the windows, the action should appear in. Defaults to showing it only in the
|
|
4103
|
+
"description": "Defines the windows, the action button should appear in. Defaults to showing it only in the <value>normal</value> Thunderbird window, but can also be shown in the <value>messageDisplay</value> window.",
|
|
4093
4104
|
"type": "array",
|
|
4094
4105
|
"items": {
|
|
4095
4106
|
"type": "string",
|
|
@@ -4129,35 +4140,16 @@
|
|
|
4129
4140
|
},
|
|
4130
4141
|
{
|
|
4131
4142
|
"namespace": "action",
|
|
4132
|
-
"description": "Use an action to put
|
|
4143
|
+
"description": "Use an action to put a button in the mail window toolbar. In addition to its icon, an action button can also have a tooltip, a badge, and a popup.",
|
|
4133
4144
|
"permissions": [
|
|
4134
4145
|
"manifest:action",
|
|
4135
4146
|
"manifest:browser_action"
|
|
4136
4147
|
],
|
|
4137
4148
|
"min_manifest_version": 3,
|
|
4138
4149
|
"types": [
|
|
4139
|
-
{
|
|
4140
|
-
"id": "Details",
|
|
4141
|
-
"type": "object",
|
|
4142
|
-
"description": "Specifies to which tab or window the value should be set, or from which one it should be retrieved. If no tab nor window is specified, the global value is set or retrieved.",
|
|
4143
|
-
"properties": {
|
|
4144
|
-
"tabId": {
|
|
4145
|
-
"type": "integer",
|
|
4146
|
-
"optional": true,
|
|
4147
|
-
"minimum": 0,
|
|
4148
|
-
"description": "When setting a value, it will be specific to the specified tab, and will automatically reset when the tab navigates. When getting, specifies the tab to get the value from; if there is no tab-specific value, the window one will be inherited."
|
|
4149
|
-
},
|
|
4150
|
-
"windowId": {
|
|
4151
|
-
"type": "integer",
|
|
4152
|
-
"optional": true,
|
|
4153
|
-
"minimum": -2,
|
|
4154
|
-
"description": "When setting a value, it will be specific to the specified window. When getting, specifies the window to get the value from; if there is no window-specific value, the global one will be inherited."
|
|
4155
|
-
}
|
|
4156
|
-
}
|
|
4157
|
-
},
|
|
4158
4150
|
{
|
|
4159
4151
|
"id": "ColorArray",
|
|
4160
|
-
"description": "An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is <
|
|
4152
|
+
"description": "An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is <value>[255, 0, 0, 255]</value>.",
|
|
4161
4153
|
"type": "array",
|
|
4162
4154
|
"items": {
|
|
4163
4155
|
"type": "integer",
|
|
@@ -4175,12 +4167,12 @@
|
|
|
4175
4167
|
"type": "any"
|
|
4176
4168
|
},
|
|
4177
4169
|
"postprocess": "convertImageDataToURL",
|
|
4178
|
-
"description": "Pixel data for an image. Must be an ImageData object (for example, from a
|
|
4170
|
+
"description": "Pixel data for an image. Must be an |ImageData| object (for example, from a |Canvas| element)."
|
|
4179
4171
|
},
|
|
4180
4172
|
{
|
|
4181
4173
|
"id": "ImageDataDictionary",
|
|
4182
4174
|
"type": "object",
|
|
4183
|
-
"description": "A
|
|
4175
|
+
"description": "A <em>dictionary object</em> to specify multiple |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 |ImageData| object, and <em>name</em> its size. Example: <literalinclude>includes/ImageDataDictionary.json<lang>JavaScript</lang></literalinclude>See the `MDN documentation about choosing icon sizes <|link-mdn-icon-size|>`__ for more information on this.",
|
|
4184
4176
|
"patternProperties": {
|
|
4185
4177
|
"^[1-9]\\d*$": {
|
|
4186
4178
|
"$ref": "ImageDataType"
|
|
@@ -4190,7 +4182,7 @@
|
|
|
4190
4182
|
{
|
|
4191
4183
|
"id": "OnClickData",
|
|
4192
4184
|
"type": "object",
|
|
4193
|
-
"description": "Information sent when
|
|
4185
|
+
"description": "Information sent when an action button is clicked.",
|
|
4194
4186
|
"properties": {
|
|
4195
4187
|
"modifiers": {
|
|
4196
4188
|
"type": "array",
|
|
@@ -4218,13 +4210,12 @@
|
|
|
4218
4210
|
{
|
|
4219
4211
|
"name": "setTitle",
|
|
4220
4212
|
"type": "function",
|
|
4221
|
-
"description": "Sets the title of the action.
|
|
4213
|
+
"description": "Sets the title of the action button. Is used as tooltip and as the label.",
|
|
4222
4214
|
"async": "callback",
|
|
4223
4215
|
"parameters": [
|
|
4224
4216
|
{
|
|
4225
4217
|
"name": "details",
|
|
4226
4218
|
"type": "object",
|
|
4227
|
-
"$import": "Details",
|
|
4228
4219
|
"properties": {
|
|
4229
4220
|
"title": {
|
|
4230
4221
|
"choices": [
|
|
@@ -4235,7 +4226,20 @@
|
|
|
4235
4226
|
"type": "null"
|
|
4236
4227
|
}
|
|
4237
4228
|
],
|
|
4238
|
-
"description": "
|
|
4229
|
+
"description": "A string the action button should display as its label and when moused over. Cleared by setting it to <value>null</value> or an empty string (title defined the manifest will be used)."
|
|
4230
|
+
},
|
|
4231
|
+
"tabId": {
|
|
4232
|
+
"type": "integer",
|
|
4233
|
+
"optional": true,
|
|
4234
|
+
"minimum": 0,
|
|
4235
|
+
"description": "Sets the title only for the given tab."
|
|
4236
|
+
},
|
|
4237
|
+
"windowId": {
|
|
4238
|
+
"type": "integer",
|
|
4239
|
+
"optional": true,
|
|
4240
|
+
"minimum": -2,
|
|
4241
|
+
"unsupported": true,
|
|
4242
|
+
"description": "Will throw an error if used."
|
|
4239
4243
|
}
|
|
4240
4244
|
}
|
|
4241
4245
|
},
|
|
@@ -4250,12 +4254,27 @@
|
|
|
4250
4254
|
{
|
|
4251
4255
|
"name": "getTitle",
|
|
4252
4256
|
"type": "function",
|
|
4253
|
-
"description": "Gets the title of the action.",
|
|
4257
|
+
"description": "Gets the title of the action button.",
|
|
4254
4258
|
"async": "callback",
|
|
4255
4259
|
"parameters": [
|
|
4256
4260
|
{
|
|
4257
4261
|
"name": "details",
|
|
4258
|
-
"
|
|
4262
|
+
"type": "object",
|
|
4263
|
+
"properties": {
|
|
4264
|
+
"tabId": {
|
|
4265
|
+
"type": "integer",
|
|
4266
|
+
"optional": true,
|
|
4267
|
+
"minimum": 0,
|
|
4268
|
+
"description": "Specifies for which tab the title should be retrieved. If no tab is specified, the global value is retrieved."
|
|
4269
|
+
},
|
|
4270
|
+
"windowId": {
|
|
4271
|
+
"type": "integer",
|
|
4272
|
+
"optional": true,
|
|
4273
|
+
"minimum": -2,
|
|
4274
|
+
"unsupported": true,
|
|
4275
|
+
"description": "Will throw an error if used."
|
|
4276
|
+
}
|
|
4277
|
+
}
|
|
4259
4278
|
},
|
|
4260
4279
|
{
|
|
4261
4280
|
"type": "function",
|
|
@@ -4272,13 +4291,12 @@
|
|
|
4272
4291
|
{
|
|
4273
4292
|
"name": "setLabel",
|
|
4274
4293
|
"type": "function",
|
|
4275
|
-
"description": "Sets the label of the action
|
|
4294
|
+
"description": "Sets the label of the action button. Can be used to set different values for the tooltip (defined by the title) and the label. Additionally, the label can be set to an empty string, not showing any label at all.",
|
|
4276
4295
|
"async": "callback",
|
|
4277
4296
|
"parameters": [
|
|
4278
4297
|
{
|
|
4279
4298
|
"name": "details",
|
|
4280
4299
|
"type": "object",
|
|
4281
|
-
"$import": "Details",
|
|
4282
4300
|
"properties": {
|
|
4283
4301
|
"label": {
|
|
4284
4302
|
"choices": [
|
|
@@ -4289,7 +4307,20 @@
|
|
|
4289
4307
|
"type": "null"
|
|
4290
4308
|
}
|
|
4291
4309
|
],
|
|
4292
|
-
"description": "
|
|
4310
|
+
"description": "A string the action button should use as its label, overriding the defined title. Can be set to an empty string to not display any label at all. If the containing toolbar is configured to display text only, its title will be used. Cleared by setting it to <value>null</value>."
|
|
4311
|
+
},
|
|
4312
|
+
"tabId": {
|
|
4313
|
+
"type": "integer",
|
|
4314
|
+
"optional": true,
|
|
4315
|
+
"minimum": 0,
|
|
4316
|
+
"description": "Sets the label only for the given tab."
|
|
4317
|
+
},
|
|
4318
|
+
"windowId": {
|
|
4319
|
+
"type": "integer",
|
|
4320
|
+
"optional": true,
|
|
4321
|
+
"minimum": -2,
|
|
4322
|
+
"unsupported": true,
|
|
4323
|
+
"description": "Will throw an error if used."
|
|
4293
4324
|
}
|
|
4294
4325
|
}
|
|
4295
4326
|
},
|
|
@@ -4304,12 +4335,27 @@
|
|
|
4304
4335
|
{
|
|
4305
4336
|
"name": "getLabel",
|
|
4306
4337
|
"type": "function",
|
|
4307
|
-
"description": "Gets the label of the action.",
|
|
4338
|
+
"description": "Gets the label of the action button.",
|
|
4308
4339
|
"async": "callback",
|
|
4309
4340
|
"parameters": [
|
|
4310
4341
|
{
|
|
4311
4342
|
"name": "details",
|
|
4312
|
-
"
|
|
4343
|
+
"type": "object",
|
|
4344
|
+
"properties": {
|
|
4345
|
+
"tabId": {
|
|
4346
|
+
"type": "integer",
|
|
4347
|
+
"optional": true,
|
|
4348
|
+
"minimum": 0,
|
|
4349
|
+
"description": "Specifies for which tab the label should be retrieved. If no tab is specified, the global label is retrieved."
|
|
4350
|
+
},
|
|
4351
|
+
"windowId": {
|
|
4352
|
+
"type": "integer",
|
|
4353
|
+
"optional": true,
|
|
4354
|
+
"minimum": -2,
|
|
4355
|
+
"unsupported": true,
|
|
4356
|
+
"description": "Will throw an error if used."
|
|
4357
|
+
}
|
|
4358
|
+
}
|
|
4313
4359
|
},
|
|
4314
4360
|
{
|
|
4315
4361
|
"type": "function",
|
|
@@ -4326,13 +4372,12 @@
|
|
|
4326
4372
|
{
|
|
4327
4373
|
"name": "setIcon",
|
|
4328
4374
|
"type": "function",
|
|
4329
|
-
"description": "Sets the icon for the action
|
|
4375
|
+
"description": "Sets the icon for the action button. Either the ``path`` or the ``imageData`` property must be specified.",
|
|
4330
4376
|
"async": "callback",
|
|
4331
4377
|
"parameters": [
|
|
4332
4378
|
{
|
|
4333
4379
|
"name": "details",
|
|
4334
4380
|
"type": "object",
|
|
4335
|
-
"$import": "Details",
|
|
4336
4381
|
"properties": {
|
|
4337
4382
|
"imageData": {
|
|
4338
4383
|
"choices": [
|
|
@@ -4344,19 +4389,25 @@
|
|
|
4344
4389
|
}
|
|
4345
4390
|
],
|
|
4346
4391
|
"optional": true,
|
|
4347
|
-
"description": "
|
|
4392
|
+
"description": "The image data for one or more icons for the action button."
|
|
4348
4393
|
},
|
|
4349
4394
|
"path": {
|
|
4350
|
-
"
|
|
4351
|
-
{
|
|
4352
|
-
"type": "string"
|
|
4353
|
-
},
|
|
4354
|
-
{
|
|
4355
|
-
"$ref": "manifest.IconPath"
|
|
4356
|
-
}
|
|
4357
|
-
],
|
|
4395
|
+
"$ref": "manifest.IconPath",
|
|
4358
4396
|
"optional": true,
|
|
4359
|
-
"description": "
|
|
4397
|
+
"description": "The paths to one or more icons for the action button."
|
|
4398
|
+
},
|
|
4399
|
+
"tabId": {
|
|
4400
|
+
"type": "integer",
|
|
4401
|
+
"optional": true,
|
|
4402
|
+
"minimum": 0,
|
|
4403
|
+
"description": "Sets the icon only for the given tab."
|
|
4404
|
+
},
|
|
4405
|
+
"windowId": {
|
|
4406
|
+
"type": "integer",
|
|
4407
|
+
"optional": true,
|
|
4408
|
+
"minimum": -2,
|
|
4409
|
+
"unsupported": true,
|
|
4410
|
+
"description": "Will throw an error if used."
|
|
4360
4411
|
}
|
|
4361
4412
|
}
|
|
4362
4413
|
},
|
|
@@ -4371,13 +4422,12 @@
|
|
|
4371
4422
|
{
|
|
4372
4423
|
"name": "setPopup",
|
|
4373
4424
|
"type": "function",
|
|
4374
|
-
"description": "Sets the html document to be opened as a popup when the user clicks on the action
|
|
4425
|
+
"description": "Sets the html document to be opened as a popup when the user clicks on the action button.",
|
|
4375
4426
|
"async": "callback",
|
|
4376
4427
|
"parameters": [
|
|
4377
4428
|
{
|
|
4378
4429
|
"name": "details",
|
|
4379
4430
|
"type": "object",
|
|
4380
|
-
"$import": "Details",
|
|
4381
4431
|
"properties": {
|
|
4382
4432
|
"popup": {
|
|
4383
4433
|
"choices": [
|
|
@@ -4388,7 +4438,20 @@
|
|
|
4388
4438
|
"type": "null"
|
|
4389
4439
|
}
|
|
4390
4440
|
],
|
|
4391
|
-
"description": "The html file to show in a popup.
|
|
4441
|
+
"description": "The html file to show in a popup. Can be set to an empty string to not open a popup. Cleared by setting it to <value>null</value> (popup value defined the manifest will be used)."
|
|
4442
|
+
},
|
|
4443
|
+
"tabId": {
|
|
4444
|
+
"type": "integer",
|
|
4445
|
+
"optional": true,
|
|
4446
|
+
"minimum": 0,
|
|
4447
|
+
"description": "Sets the popup only for the given tab."
|
|
4448
|
+
},
|
|
4449
|
+
"windowId": {
|
|
4450
|
+
"type": "integer",
|
|
4451
|
+
"optional": true,
|
|
4452
|
+
"minimum": -2,
|
|
4453
|
+
"unsupported": true,
|
|
4454
|
+
"description": "Will throw an error if used."
|
|
4392
4455
|
}
|
|
4393
4456
|
}
|
|
4394
4457
|
},
|
|
@@ -4403,12 +4466,27 @@
|
|
|
4403
4466
|
{
|
|
4404
4467
|
"name": "getPopup",
|
|
4405
4468
|
"type": "function",
|
|
4406
|
-
"description": "Gets the html document set as the popup for this action.",
|
|
4469
|
+
"description": "Gets the html document set as the popup for this action button.",
|
|
4407
4470
|
"async": "callback",
|
|
4408
4471
|
"parameters": [
|
|
4409
4472
|
{
|
|
4410
4473
|
"name": "details",
|
|
4411
|
-
"
|
|
4474
|
+
"type": "object",
|
|
4475
|
+
"properties": {
|
|
4476
|
+
"tabId": {
|
|
4477
|
+
"type": "integer",
|
|
4478
|
+
"optional": true,
|
|
4479
|
+
"minimum": 0,
|
|
4480
|
+
"description": "Specifies for which tab the popup document should be retrieved. If no tab is specified, the global value is retrieved."
|
|
4481
|
+
},
|
|
4482
|
+
"windowId": {
|
|
4483
|
+
"type": "integer",
|
|
4484
|
+
"optional": true,
|
|
4485
|
+
"minimum": -2,
|
|
4486
|
+
"unsupported": true,
|
|
4487
|
+
"description": "Will throw an error if used."
|
|
4488
|
+
}
|
|
4489
|
+
}
|
|
4412
4490
|
},
|
|
4413
4491
|
{
|
|
4414
4492
|
"type": "function",
|
|
@@ -4425,13 +4503,12 @@
|
|
|
4425
4503
|
{
|
|
4426
4504
|
"name": "setBadgeText",
|
|
4427
4505
|
"type": "function",
|
|
4428
|
-
"description": "Sets the badge text for the action. The badge is displayed on top of the icon.",
|
|
4506
|
+
"description": "Sets the badge text for the action button. The badge is displayed on top of the icon.",
|
|
4429
4507
|
"async": "callback",
|
|
4430
4508
|
"parameters": [
|
|
4431
4509
|
{
|
|
4432
4510
|
"name": "details",
|
|
4433
4511
|
"type": "object",
|
|
4434
|
-
"$import": "Details",
|
|
4435
4512
|
"properties": {
|
|
4436
4513
|
"text": {
|
|
4437
4514
|
"choices": [
|
|
@@ -4442,7 +4519,20 @@
|
|
|
4442
4519
|
"type": "null"
|
|
4443
4520
|
}
|
|
4444
4521
|
],
|
|
4445
|
-
"description": "Any number of characters can be passed, but only about four can fit in the space."
|
|
4522
|
+
"description": "Any number of characters can be passed, but only about four can fit in the space. Cleared by setting it to <value>null</value> or an empty string."
|
|
4523
|
+
},
|
|
4524
|
+
"tabId": {
|
|
4525
|
+
"type": "integer",
|
|
4526
|
+
"optional": true,
|
|
4527
|
+
"minimum": 0,
|
|
4528
|
+
"description": "Sets the badge text only for the given tab."
|
|
4529
|
+
},
|
|
4530
|
+
"windowId": {
|
|
4531
|
+
"type": "integer",
|
|
4532
|
+
"optional": true,
|
|
4533
|
+
"minimum": -2,
|
|
4534
|
+
"unsupported": true,
|
|
4535
|
+
"description": "Will throw an error if used."
|
|
4446
4536
|
}
|
|
4447
4537
|
}
|
|
4448
4538
|
},
|
|
@@ -4457,12 +4547,27 @@
|
|
|
4457
4547
|
{
|
|
4458
4548
|
"name": "getBadgeText",
|
|
4459
4549
|
"type": "function",
|
|
4460
|
-
"description": "Gets the badge text of the action
|
|
4550
|
+
"description": "Gets the badge text of the action button.",
|
|
4461
4551
|
"async": "callback",
|
|
4462
4552
|
"parameters": [
|
|
4463
4553
|
{
|
|
4464
4554
|
"name": "details",
|
|
4465
|
-
"
|
|
4555
|
+
"type": "object",
|
|
4556
|
+
"properties": {
|
|
4557
|
+
"tabId": {
|
|
4558
|
+
"type": "integer",
|
|
4559
|
+
"optional": true,
|
|
4560
|
+
"minimum": 0,
|
|
4561
|
+
"description": "Specifies for which tab the badge text should be retrieved. If no tab is specified, the global label is retrieved."
|
|
4562
|
+
},
|
|
4563
|
+
"windowId": {
|
|
4564
|
+
"type": "integer",
|
|
4565
|
+
"optional": true,
|
|
4566
|
+
"minimum": -2,
|
|
4567
|
+
"unsupported": true,
|
|
4568
|
+
"description": "Will throw an error if used."
|
|
4569
|
+
}
|
|
4570
|
+
}
|
|
4466
4571
|
},
|
|
4467
4572
|
{
|
|
4468
4573
|
"type": "function",
|
|
@@ -4485,10 +4590,8 @@
|
|
|
4485
4590
|
{
|
|
4486
4591
|
"name": "details",
|
|
4487
4592
|
"type": "object",
|
|
4488
|
-
"$import": "Details",
|
|
4489
4593
|
"properties": {
|
|
4490
4594
|
"color": {
|
|
4491
|
-
"description": "An array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is <code>[255, 0, 0, 255]</code>. Can also be a string with a CSS value, with opaque red being <code>#FF0000</code> or <code>#F00</code>.",
|
|
4492
4595
|
"choices": [
|
|
4493
4596
|
{
|
|
4494
4597
|
"type": "string"
|
|
@@ -4499,7 +4602,21 @@
|
|
|
4499
4602
|
{
|
|
4500
4603
|
"type": "null"
|
|
4501
4604
|
}
|
|
4502
|
-
]
|
|
4605
|
+
],
|
|
4606
|
+
"description": "The color to use as background in the badge. Cleared by setting it to <value>null</value> or an empty string."
|
|
4607
|
+
},
|
|
4608
|
+
"tabId": {
|
|
4609
|
+
"type": "integer",
|
|
4610
|
+
"optional": true,
|
|
4611
|
+
"minimum": 0,
|
|
4612
|
+
"description": "Sets the background color for the badge only for the given tab."
|
|
4613
|
+
},
|
|
4614
|
+
"windowId": {
|
|
4615
|
+
"type": "integer",
|
|
4616
|
+
"optional": true,
|
|
4617
|
+
"minimum": -2,
|
|
4618
|
+
"unsupported": true,
|
|
4619
|
+
"description": "Will throw an error if used."
|
|
4503
4620
|
}
|
|
4504
4621
|
}
|
|
4505
4622
|
},
|
|
@@ -4514,12 +4631,27 @@
|
|
|
4514
4631
|
{
|
|
4515
4632
|
"name": "getBadgeBackgroundColor",
|
|
4516
4633
|
"type": "function",
|
|
4517
|
-
"description": "Gets the background color of the action.",
|
|
4634
|
+
"description": "Gets the badge background color of the action button.",
|
|
4518
4635
|
"async": "callback",
|
|
4519
4636
|
"parameters": [
|
|
4520
4637
|
{
|
|
4521
4638
|
"name": "details",
|
|
4522
|
-
"
|
|
4639
|
+
"type": "object",
|
|
4640
|
+
"properties": {
|
|
4641
|
+
"tabId": {
|
|
4642
|
+
"type": "integer",
|
|
4643
|
+
"optional": true,
|
|
4644
|
+
"minimum": 0,
|
|
4645
|
+
"description": "Specifies for which tab the badge background color should be retrieved. If no tab is specified, the global label is retrieved."
|
|
4646
|
+
},
|
|
4647
|
+
"windowId": {
|
|
4648
|
+
"type": "integer",
|
|
4649
|
+
"optional": true,
|
|
4650
|
+
"minimum": -2,
|
|
4651
|
+
"unsupported": true,
|
|
4652
|
+
"description": "Will throw an error if used."
|
|
4653
|
+
}
|
|
4654
|
+
}
|
|
4523
4655
|
},
|
|
4524
4656
|
{
|
|
4525
4657
|
"type": "function",
|
|
@@ -4536,7 +4668,7 @@
|
|
|
4536
4668
|
{
|
|
4537
4669
|
"name": "enable",
|
|
4538
4670
|
"type": "function",
|
|
4539
|
-
"description": "Enables the action for a tab. By default, an action is enabled.",
|
|
4671
|
+
"description": "Enables the action button for a tab. By default, an action button is enabled.",
|
|
4540
4672
|
"async": "callback",
|
|
4541
4673
|
"parameters": [
|
|
4542
4674
|
{
|
|
@@ -4544,7 +4676,7 @@
|
|
|
4544
4676
|
"optional": true,
|
|
4545
4677
|
"name": "tabId",
|
|
4546
4678
|
"minimum": 0,
|
|
4547
|
-
"description": "The id of the tab for which you want to modify the action."
|
|
4679
|
+
"description": "The id of the tab for which you want to modify the action button."
|
|
4548
4680
|
},
|
|
4549
4681
|
{
|
|
4550
4682
|
"type": "function",
|
|
@@ -4557,7 +4689,7 @@
|
|
|
4557
4689
|
{
|
|
4558
4690
|
"name": "disable",
|
|
4559
4691
|
"type": "function",
|
|
4560
|
-
"description": "Disables the action for a tab.",
|
|
4692
|
+
"description": "Disables the action button for a tab.",
|
|
4561
4693
|
"async": "callback",
|
|
4562
4694
|
"parameters": [
|
|
4563
4695
|
{
|
|
@@ -4565,7 +4697,7 @@
|
|
|
4565
4697
|
"optional": true,
|
|
4566
4698
|
"name": "tabId",
|
|
4567
4699
|
"minimum": 0,
|
|
4568
|
-
"description": "The id of the tab for which you want to modify the action."
|
|
4700
|
+
"description": "The id of the tab for which you want to modify the action button."
|
|
4569
4701
|
},
|
|
4570
4702
|
{
|
|
4571
4703
|
"type": "function",
|
|
@@ -4578,12 +4710,27 @@
|
|
|
4578
4710
|
{
|
|
4579
4711
|
"name": "isEnabled",
|
|
4580
4712
|
"type": "function",
|
|
4581
|
-
"description": "Checks whether the action is enabled.",
|
|
4713
|
+
"description": "Checks whether the action button is enabled.",
|
|
4582
4714
|
"async": "callback",
|
|
4583
4715
|
"parameters": [
|
|
4584
4716
|
{
|
|
4585
4717
|
"name": "details",
|
|
4586
|
-
"
|
|
4718
|
+
"type": "object",
|
|
4719
|
+
"properties": {
|
|
4720
|
+
"tabId": {
|
|
4721
|
+
"type": "integer",
|
|
4722
|
+
"optional": true,
|
|
4723
|
+
"minimum": 0,
|
|
4724
|
+
"description": "Specifies for which tab the state should be retrieved. If no tab is specified, the global value is retrieved."
|
|
4725
|
+
},
|
|
4726
|
+
"windowId": {
|
|
4727
|
+
"type": "integer",
|
|
4728
|
+
"optional": true,
|
|
4729
|
+
"minimum": -2,
|
|
4730
|
+
"unsupported": true,
|
|
4731
|
+
"description": "Will throw an error if used."
|
|
4732
|
+
}
|
|
4733
|
+
}
|
|
4587
4734
|
},
|
|
4588
4735
|
{
|
|
4589
4736
|
"type": "function",
|
|
@@ -4601,7 +4748,7 @@
|
|
|
4601
4748
|
"name": "openPopup",
|
|
4602
4749
|
"type": "function",
|
|
4603
4750
|
"requireUserInput": true,
|
|
4604
|
-
"description": "Opens the
|
|
4751
|
+
"description": "Opens the action's popup window in the active window.",
|
|
4605
4752
|
"async": true,
|
|
4606
4753
|
"parameters": []
|
|
4607
4754
|
}
|
|
@@ -4610,7 +4757,7 @@
|
|
|
4610
4757
|
{
|
|
4611
4758
|
"name": "onClicked",
|
|
4612
4759
|
"type": "function",
|
|
4613
|
-
"description": "Fired when an action
|
|
4760
|
+
"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 `restrictions <|link-user-input-restrictions|>`__ apply.",
|
|
4614
4761
|
"parameters": [
|
|
4615
4762
|
{
|
|
4616
4763
|
"name": "tab",
|
|
@@ -4847,7 +4994,7 @@
|
|
|
4847
4994
|
"properties": {
|
|
4848
4995
|
"browser_style": {
|
|
4849
4996
|
"type": "boolean",
|
|
4850
|
-
"description": "Enable browser styles in the ``management_url`` page. See the `MDN documentation
|
|
4997
|
+
"description": "Enable browser styles in the ``management_url`` page. See the `MDN documentation on browser styles <|link-mdn-browser-styles|>`__ for more information.",
|
|
4851
4998
|
"optional": true,
|
|
4852
4999
|
"default": false
|
|
4853
5000
|
},
|
|
@@ -4855,10 +5002,10 @@
|
|
|
4855
5002
|
"type": "string",
|
|
4856
5003
|
"optional": true,
|
|
4857
5004
|
"deprecated": true,
|
|
4858
|
-
"description": "This property is no longer used. The only supported data format for the ``data`` argument in
|
|
5005
|
+
"description": "This property is no longer used. The only supported data format for the ``data`` argument in :ref:`cloudFile.onFileUpload` is |File|."
|
|
4859
5006
|
},
|
|
4860
5007
|
"reuse_uploads": {
|
|
4861
|
-
"description": "If a previously uploaded cloud file attachment is reused at a later time in a different message, Thunderbird may use the already known ``url`` and ``templateInfo`` values without triggering the registered :ref:`cloudFile.onFileUpload` listener again. Setting this option to false will always trigger the registered listener, providing the already known values through the ``relatedFileInfo`` parameter of the :ref:`cloudFile.onFileUpload` event, to let the provider decide how to handle these cases.",
|
|
5008
|
+
"description": "If a previously uploaded cloud file attachment is reused at a later time in a different message, Thunderbird may use the already known ``url`` and ``templateInfo`` values without triggering the registered :ref:`cloudFile.onFileUpload` listener again. Setting this option to <value>false</value> will always trigger the registered listener, providing the already known values through the ``relatedFileInfo`` parameter of the :ref:`cloudFile.onFileUpload` event, to let the provider decide how to handle these cases.",
|
|
4862
5009
|
"type": "boolean",
|
|
4863
5010
|
"optional": true,
|
|
4864
5011
|
"default": true
|
|
@@ -4884,7 +5031,7 @@
|
|
|
4884
5031
|
"type": "string",
|
|
4885
5032
|
"optional": true,
|
|
4886
5033
|
"deprecated": true,
|
|
4887
|
-
"description": "This property is no longer used. The ``service_url`` property of the :ref:`cloudFile.CloudFileTemplateInfo` object returned by the :ref:`cloudFile.onFileUpload` event can be used to add a
|
|
5034
|
+
"description": "This property is no longer used. The ``service_url`` property of the :ref:`cloudFile.CloudFileTemplateInfo` object returned by the :ref:`cloudFile.onFileUpload` event can be used to add a <em>Learn more about</em> link to the footer of the cloud file attachment element."
|
|
4888
5035
|
}
|
|
4889
5036
|
},
|
|
4890
5037
|
"optional": true
|
|
@@ -4934,7 +5081,7 @@
|
|
|
4934
5081
|
"properties": {
|
|
4935
5082
|
"aborted": {
|
|
4936
5083
|
"type": "boolean",
|
|
4937
|
-
"description": "Set this to true if the file upload was aborted by the user and an :ref:`cloudFile.onFileUploadAbort` event has been received. No error message will be shown to the user.",
|
|
5084
|
+
"description": "Set this to <value>true</value> if the file upload was aborted by the user and an :ref:`cloudFile.onFileUploadAbort` event has been received. No error message will be shown to the user.",
|
|
4938
5085
|
"optional": true
|
|
4939
5086
|
},
|
|
4940
5087
|
"error": {
|
|
@@ -4946,7 +5093,7 @@
|
|
|
4946
5093
|
"type": "string"
|
|
4947
5094
|
}
|
|
4948
5095
|
],
|
|
4949
|
-
"description": "Report an error to the user. Set this to true for showing a generic error message, or set a specific error message.",
|
|
5096
|
+
"description": "Report an error to the user. Set this to <value>true</value> for showing a generic error message, or set a specific error message.",
|
|
4950
5097
|
"optional": true
|
|
4951
5098
|
},
|
|
4952
5099
|
"url": {
|
|
@@ -5023,7 +5170,7 @@
|
|
|
5023
5170
|
"type": "string"
|
|
5024
5171
|
}
|
|
5025
5172
|
],
|
|
5026
|
-
"description": "Report an error to the user. Set this to true for showing a generic error message, or set a specific error message.",
|
|
5173
|
+
"description": "Report an error to the user. Set this to <value>true</value> for showing a generic error message, or set a specific error message.",
|
|
5027
5174
|
"optional": true
|
|
5028
5175
|
},
|
|
5029
5176
|
"url": {
|
|
@@ -5104,19 +5251,19 @@
|
|
|
5104
5251
|
"type": "integer",
|
|
5105
5252
|
"minimum": -1,
|
|
5106
5253
|
"optional": true,
|
|
5107
|
-
"description": "The maximum size in bytes for a single file to upload. Set to
|
|
5254
|
+
"description": "The maximum size in bytes for a single file to upload. Set to <value>-1</value> if unlimited."
|
|
5108
5255
|
},
|
|
5109
5256
|
"spaceRemaining": {
|
|
5110
5257
|
"type": "integer",
|
|
5111
5258
|
"minimum": -1,
|
|
5112
5259
|
"optional": true,
|
|
5113
|
-
"description": "The amount of remaining space on the cloud provider, in bytes. Set to
|
|
5260
|
+
"description": "The amount of remaining space on the cloud provider, in bytes. Set to <value>-1</value> if unsupported."
|
|
5114
5261
|
},
|
|
5115
5262
|
"spaceUsed": {
|
|
5116
5263
|
"type": "integer",
|
|
5117
5264
|
"minimum": -1,
|
|
5118
5265
|
"optional": true,
|
|
5119
|
-
"description": "The amount of space already used on the cloud provider, in bytes. Set to
|
|
5266
|
+
"description": "The amount of space already used on the cloud provider, in bytes. Set to <value>-1</value> if unsupported."
|
|
5120
5267
|
},
|
|
5121
5268
|
"managementUrl": {
|
|
5122
5269
|
"type": "string",
|
|
@@ -5143,7 +5290,7 @@
|
|
|
5143
5290
|
"service_url": {
|
|
5144
5291
|
"type": "string",
|
|
5145
5292
|
"optional": true,
|
|
5146
|
-
"description": "A URL pointing to a web page of the used cloud file service. Will be used in a
|
|
5293
|
+
"description": "A URL pointing to a web page of the used cloud file service. Will be used in a <em>Learn more about</em> link in the footer of the cloud file attachment element."
|
|
5147
5294
|
},
|
|
5148
5295
|
"download_password_protected": {
|
|
5149
5296
|
"type": "boolean",
|
|
@@ -5166,7 +5313,7 @@
|
|
|
5166
5313
|
},
|
|
5167
5314
|
"format": {
|
|
5168
5315
|
"optional": true,
|
|
5169
|
-
"description": "A format options object as used by
|
|
5316
|
+
"description": "A format options object as used by |DateTimeFormat|. Defaults to: <literalinclude>includes/cloudFile/defaultDateFormat.js<lang>JavaScript</lang></literalinclude>",
|
|
5170
5317
|
"type": "object",
|
|
5171
5318
|
"additionalProperties": true
|
|
5172
5319
|
}
|
|
@@ -5199,7 +5346,7 @@
|
|
|
5199
5346
|
{
|
|
5200
5347
|
"id": "RelatedCloudFile",
|
|
5201
5348
|
"type": "object",
|
|
5202
|
-
"description": "Information about an already uploaded cloud file, which is related to a new upload. For example if the content of a cloud attachment is updated, if a repeatedly used cloud attachment is renamed (and therefore should be re-uploaded to not invalidate existing links) or if the provider has its manifest property ``reuse_uploads`` set to
|
|
5349
|
+
"description": "Information about an already uploaded cloud file, which is related to a new upload. For example if the content of a cloud attachment is updated, if a repeatedly used cloud attachment is renamed (and therefore should be re-uploaded to not invalidate existing links) or if the provider has its manifest property ``reuse_uploads`` set to <value>false</value>.",
|
|
5203
5350
|
"properties": {
|
|
5204
5351
|
"id": {
|
|
5205
5352
|
"type": "integer",
|
|
@@ -5306,19 +5453,19 @@
|
|
|
5306
5453
|
"type": "integer",
|
|
5307
5454
|
"minimum": -1,
|
|
5308
5455
|
"optional": true,
|
|
5309
|
-
"description": "The maximum size in bytes for a single file to upload. Set to
|
|
5456
|
+
"description": "The maximum size in bytes for a single file to upload. Set to <value>-1</value> if unlimited."
|
|
5310
5457
|
},
|
|
5311
5458
|
"spaceRemaining": {
|
|
5312
5459
|
"type": "integer",
|
|
5313
5460
|
"minimum": -1,
|
|
5314
5461
|
"optional": true,
|
|
5315
|
-
"description": "The amount of remaining space on the cloud provider, in bytes. Set to
|
|
5462
|
+
"description": "The amount of remaining space on the cloud provider, in bytes. Set to <value>-1</value> if unsupported."
|
|
5316
5463
|
},
|
|
5317
5464
|
"spaceUsed": {
|
|
5318
5465
|
"type": "integer",
|
|
5319
5466
|
"minimum": -1,
|
|
5320
5467
|
"optional": true,
|
|
5321
|
-
"description": "The amount of space already used on the cloud provider, in bytes. Set to
|
|
5468
|
+
"description": "The amount of space already used on the cloud provider, in bytes. Set to <value>-1</value> if unsupported."
|
|
5322
5469
|
},
|
|
5323
5470
|
"managementUrl": {
|
|
5324
5471
|
"type": "string",
|
|
@@ -5370,7 +5517,7 @@
|
|
|
5370
5517
|
"choices": [
|
|
5371
5518
|
{
|
|
5372
5519
|
"type": "string",
|
|
5373
|
-
"description": "A name and email address in the format
|
|
5520
|
+
"description": "A name and email address in the format <value>Name <email@example.com></value>, or just an email address."
|
|
5374
5521
|
},
|
|
5375
5522
|
{
|
|
5376
5523
|
"type": "object",
|
|
@@ -5450,7 +5597,7 @@
|
|
|
5450
5597
|
"overrideDefaultFcc": {
|
|
5451
5598
|
"type": "boolean",
|
|
5452
5599
|
"optional": true,
|
|
5453
|
-
"description": "Indicates whether the default fcc setting (defined by the used identity) is being overridden for this message. Setting
|
|
5600
|
+
"description": "Indicates whether the default fcc setting (defined by the used identity) is being overridden for this message. Setting <value>false</value> will clear the override. Setting <value>true</value> will throw an <em>ExtensionError</em>, if ``overrideDefaultFccFolder`` is not set as well."
|
|
5454
5601
|
},
|
|
5455
5602
|
"overrideDefaultFccFolder": {
|
|
5456
5603
|
"choices": [
|
|
@@ -5465,7 +5612,7 @@
|
|
|
5465
5612
|
}
|
|
5466
5613
|
],
|
|
5467
5614
|
"optional": true,
|
|
5468
|
-
"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
|
|
5615
|
+
"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."
|
|
5469
5616
|
},
|
|
5470
5617
|
"additionalFccFolder": {
|
|
5471
5618
|
"choices": [
|
|
@@ -5479,7 +5626,7 @@
|
|
|
5479
5626
|
]
|
|
5480
5627
|
}
|
|
5481
5628
|
],
|
|
5482
|
-
"description": "An additional fcc folder which can be selected while composing the message,
|
|
5629
|
+
"description": "An additional fcc folder which can be selected while composing the message, an empty string if not used.",
|
|
5483
5630
|
"optional": true
|
|
5484
5631
|
},
|
|
5485
5632
|
"replyTo": {
|
|
@@ -5507,7 +5654,7 @@
|
|
|
5507
5654
|
"optional": true
|
|
5508
5655
|
},
|
|
5509
5656
|
"relatedMessageId": {
|
|
5510
|
-
"description": "The id of the original message (in case of draft, template, forward or reply). Read-only. Is <
|
|
5657
|
+
"description": "The id of the original message (in case of draft, template, forward or reply). Read-only. Is <value>null</value> in all other cases or if the original message was opened from file.",
|
|
5511
5658
|
"type": "integer",
|
|
5512
5659
|
"optional": true
|
|
5513
5660
|
},
|
|
@@ -5550,7 +5697,7 @@
|
|
|
5550
5697
|
"html",
|
|
5551
5698
|
"both"
|
|
5552
5699
|
],
|
|
5553
|
-
"description": "Defines the mime format of the sent message (ignored on plain text messages). Defaults to
|
|
5700
|
+
"description": "Defines the mime format of the sent message (ignored on plain text messages). Defaults to <value>auto</value>, which will send html messages as plain text, if they do not include any formatting, and as <value>both</value> otherwise (a multipart/mixed message).",
|
|
5554
5701
|
"optional": true
|
|
5555
5702
|
},
|
|
5556
5703
|
"customHeaders": {
|
|
@@ -5558,7 +5705,7 @@
|
|
|
5558
5705
|
"items": {
|
|
5559
5706
|
"$ref": "CustomHeader"
|
|
5560
5707
|
},
|
|
5561
|
-
"description": "Array of custom headers. Headers will be returned in
|
|
5708
|
+
"description": "Array of custom headers. Headers will be returned in <em>Http-Header-Case</em> (a.k.a. <em>Train-Case</em>). Set an empty array to clear all custom headers.",
|
|
5562
5709
|
"optional": true
|
|
5563
5710
|
},
|
|
5564
5711
|
"priority": {
|
|
@@ -5576,7 +5723,7 @@
|
|
|
5576
5723
|
"returnReceipt": {
|
|
5577
5724
|
"type": "boolean",
|
|
5578
5725
|
"optional": true,
|
|
5579
|
-
"description": "Add the
|
|
5726
|
+
"description": "Add the <em>Disposition-Notification-To</em> header to the message to requests the recipients email client to send a reply once the message has been received. Recipient server may strip the header and the recipient might ignore the request."
|
|
5580
5727
|
},
|
|
5581
5728
|
"deliveryStatusNotification": {
|
|
5582
5729
|
"type": "boolean",
|
|
@@ -5652,7 +5799,7 @@
|
|
|
5652
5799
|
"properties": {
|
|
5653
5800
|
"name": {
|
|
5654
5801
|
"type": "string",
|
|
5655
|
-
"description": "Name of a custom header, must have a
|
|
5802
|
+
"description": "Name of a custom header, must have a <value>X-</value> prefix.",
|
|
5656
5803
|
"pattern": "^X-.*$"
|
|
5657
5804
|
},
|
|
5658
5805
|
"value": {
|
|
@@ -5666,14 +5813,14 @@
|
|
|
5666
5813
|
"additionalProperties": {
|
|
5667
5814
|
"type": "boolean"
|
|
5668
5815
|
},
|
|
5669
|
-
"description": "
|
|
5816
|
+
"description": "A <em>dictionary object</em> with entries for all installed dictionaries, having a language identifier as <em>key</em> (for example <value>en-US</value>) and a boolean expression as <em>value</em>, indicating whether that dictionary is enabled for spellchecking or not."
|
|
5670
5817
|
}
|
|
5671
5818
|
],
|
|
5672
5819
|
"events": [
|
|
5673
5820
|
{
|
|
5674
5821
|
"name": "onBeforeSend",
|
|
5675
5822
|
"type": "function",
|
|
5676
|
-
"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 `restrictions
|
|
5823
|
+
"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 `restrictions <|link-user-input-restrictions|>`__ apply.",
|
|
5677
5824
|
"permissions": [
|
|
5678
5825
|
"compose"
|
|
5679
5826
|
],
|
|
@@ -6035,7 +6182,7 @@
|
|
|
6035
6182
|
"name": "getActiveDictionaries",
|
|
6036
6183
|
"type": "function",
|
|
6037
6184
|
"async": "callback",
|
|
6038
|
-
"description": "Returns a :ref:`ComposeDictionaries` object, listing all installed dictionaries, including the information whether they are currently enabled or not.",
|
|
6185
|
+
"description": "Returns a :ref:`compose.ComposeDictionaries` object, listing all installed dictionaries, including the information whether they are currently enabled or not.",
|
|
6039
6186
|
"permissions": [
|
|
6040
6187
|
"compose"
|
|
6041
6188
|
],
|
|
@@ -6111,7 +6258,7 @@
|
|
|
6111
6258
|
{
|
|
6112
6259
|
"name": "getAttachmentFile",
|
|
6113
6260
|
"type": "function",
|
|
6114
|
-
"description": "Gets the content of a :ref:`compose.ComposeAttachment` as a
|
|
6261
|
+
"description": "Gets the content of a :ref:`compose.ComposeAttachment` as a |File| object.",
|
|
6115
6262
|
"async": "callback",
|
|
6116
6263
|
"parameters": [
|
|
6117
6264
|
{
|
|
@@ -6172,7 +6319,7 @@
|
|
|
6172
6319
|
{
|
|
6173
6320
|
"name": "updateAttachment",
|
|
6174
6321
|
"type": "function",
|
|
6175
|
-
"description": "Updates the name and/or the content of an attachment in the message being composed in the specified tab. If the specified attachment is a cloud file attachment and the associated provider failed to update the attachment, the function will throw an
|
|
6322
|
+
"description": "Updates the name and/or the content of an attachment in the message being composed in the specified tab. If the specified attachment is a cloud file attachment and the associated provider failed to update the attachment, the function will throw an <em>ExtensionError</em>.",
|
|
6176
6323
|
"permissions": [
|
|
6177
6324
|
"compose"
|
|
6178
6325
|
],
|
|
@@ -6227,7 +6374,7 @@
|
|
|
6227
6374
|
"compose.send"
|
|
6228
6375
|
],
|
|
6229
6376
|
"type": "function",
|
|
6230
|
-
"description": "Sends the message currently being composed. If the send mode is not specified or set to
|
|
6377
|
+
"description": "Sends the message currently being composed. If the send mode is not specified or set to <value>default</value>, the message will be send directly if the user is online and placed in the users outbox otherwise. The returned Promise fulfills once the message has been successfully sent or placed in the user's outbox. Throws when the send process has been aborted by the user, by an :ref:`compose.onBeforeSend` event or if there has been an error while sending the message to the outgoing mail server.",
|
|
6231
6378
|
"async": "callback",
|
|
6232
6379
|
"parameters": [
|
|
6233
6380
|
{
|
|
@@ -6382,19 +6529,19 @@
|
|
|
6382
6529
|
"properties": {
|
|
6383
6530
|
"default_label": {
|
|
6384
6531
|
"type": "string",
|
|
6385
|
-
"description": "The label of the composeAction, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
|
|
6532
|
+
"description": "The label of the composeAction button, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
|
|
6386
6533
|
"optional": true,
|
|
6387
6534
|
"preprocess": "localize"
|
|
6388
6535
|
},
|
|
6389
6536
|
"default_title": {
|
|
6390
6537
|
"type": "string",
|
|
6391
|
-
"description": "The title of the composeAction. This shows up in the tooltip and the label. Defaults to the add-on name.",
|
|
6538
|
+
"description": "The title of the composeAction button. This shows up in the tooltip and the label. Defaults to the add-on name.",
|
|
6392
6539
|
"optional": true,
|
|
6393
6540
|
"preprocess": "localize"
|
|
6394
6541
|
},
|
|
6395
6542
|
"default_icon": {
|
|
6396
6543
|
"$ref": "IconPath",
|
|
6397
|
-
"description": "The
|
|
6544
|
+
"description": "The paths to one or more icons for the composeAction button.",
|
|
6398
6545
|
"optional": true
|
|
6399
6546
|
},
|
|
6400
6547
|
"theme_icons": {
|
|
@@ -6410,17 +6557,17 @@
|
|
|
6410
6557
|
"type": "string",
|
|
6411
6558
|
"format": "relativeUrl",
|
|
6412
6559
|
"optional": true,
|
|
6413
|
-
"description": "The html document to be opened as a popup when the user clicks on the composeAction
|
|
6560
|
+
"description": "The html document to be opened as a popup when the user clicks on the composeAction button.",
|
|
6414
6561
|
"preprocess": "localize"
|
|
6415
6562
|
},
|
|
6416
6563
|
"browser_style": {
|
|
6417
6564
|
"type": "boolean",
|
|
6418
6565
|
"optional": true,
|
|
6419
|
-
"description": "Enable browser styles. See the `MDN documentation on browser styles
|
|
6566
|
+
"description": "Enable browser styles. See the `MDN documentation on browser styles <|link-mdn-browser-styles|>`__ for more information.",
|
|
6420
6567
|
"default": false
|
|
6421
6568
|
},
|
|
6422
6569
|
"default_area": {
|
|
6423
|
-
"description": "Defines the location the composeAction will appear. The default location is
|
|
6570
|
+
"description": "Defines the location the composeAction button will appear. The default location is <value>maintoolbar</value>.",
|
|
6424
6571
|
"type": "string",
|
|
6425
6572
|
"enum": [
|
|
6426
6573
|
"maintoolbar",
|
|
@@ -6437,33 +6584,14 @@
|
|
|
6437
6584
|
},
|
|
6438
6585
|
{
|
|
6439
6586
|
"namespace": "composeAction",
|
|
6440
|
-
"description": "Use a composeAction to put
|
|
6587
|
+
"description": "Use a composeAction to put a button in the message composition toolbars. In addition to its icon, a composeAction button can also have a tooltip, a badge, and a popup.",
|
|
6441
6588
|
"permissions": [
|
|
6442
6589
|
"manifest:compose_action"
|
|
6443
6590
|
],
|
|
6444
6591
|
"types": [
|
|
6445
|
-
{
|
|
6446
|
-
"id": "Details",
|
|
6447
|
-
"type": "object",
|
|
6448
|
-
"description": "Specifies to which tab or window the value should be set, or from which one it should be retrieved. If no tab nor window is specified, the global value is set or retrieved.",
|
|
6449
|
-
"properties": {
|
|
6450
|
-
"tabId": {
|
|
6451
|
-
"type": "integer",
|
|
6452
|
-
"optional": true,
|
|
6453
|
-
"minimum": 0,
|
|
6454
|
-
"description": "When setting a value, it will be specific to the specified tab, and will automatically reset when the tab navigates. When getting, specifies the tab to get the value from; if there is no tab-specific value, the window one will be inherited."
|
|
6455
|
-
},
|
|
6456
|
-
"windowId": {
|
|
6457
|
-
"type": "integer",
|
|
6458
|
-
"optional": true,
|
|
6459
|
-
"minimum": -2,
|
|
6460
|
-
"description": "When setting a value, it will be specific to the specified window. When getting, specifies the window to get the value from; if there is no window-specific value, the global one will be inherited."
|
|
6461
|
-
}
|
|
6462
|
-
}
|
|
6463
|
-
},
|
|
6464
6592
|
{
|
|
6465
6593
|
"id": "ColorArray",
|
|
6466
|
-
"description": "An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is <
|
|
6594
|
+
"description": "An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is <value>[255, 0, 0, 255]</value>.",
|
|
6467
6595
|
"type": "array",
|
|
6468
6596
|
"items": {
|
|
6469
6597
|
"type": "integer",
|
|
@@ -6481,12 +6609,12 @@
|
|
|
6481
6609
|
"type": "any"
|
|
6482
6610
|
},
|
|
6483
6611
|
"postprocess": "convertImageDataToURL",
|
|
6484
|
-
"description": "Pixel data for an image. Must be an ImageData object (for example, from a
|
|
6612
|
+
"description": "Pixel data for an image. Must be an |ImageData| object (for example, from a |Canvas| element)."
|
|
6485
6613
|
},
|
|
6486
6614
|
{
|
|
6487
6615
|
"id": "ImageDataDictionary",
|
|
6488
6616
|
"type": "object",
|
|
6489
|
-
"description": "A
|
|
6617
|
+
"description": "A <em>dictionary object</em> to specify multiple |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 |ImageData| object, and <em>name</em> its size. Example: <literalinclude>includes/ImageDataDictionary.json<lang>JavaScript</lang></literalinclude>See the `MDN documentation about choosing icon sizes <|link-mdn-icon-size|>`__ for more information on this.",
|
|
6490
6618
|
"patternProperties": {
|
|
6491
6619
|
"^[1-9]\\d*$": {
|
|
6492
6620
|
"$ref": "ImageDataType"
|
|
@@ -6496,7 +6624,7 @@
|
|
|
6496
6624
|
{
|
|
6497
6625
|
"id": "OnClickData",
|
|
6498
6626
|
"type": "object",
|
|
6499
|
-
"description": "Information sent when a
|
|
6627
|
+
"description": "Information sent when a composeAction button is clicked.",
|
|
6500
6628
|
"properties": {
|
|
6501
6629
|
"modifiers": {
|
|
6502
6630
|
"type": "array",
|
|
@@ -6524,13 +6652,12 @@
|
|
|
6524
6652
|
{
|
|
6525
6653
|
"name": "setTitle",
|
|
6526
6654
|
"type": "function",
|
|
6527
|
-
"description": "Sets the title of the composeAction.
|
|
6655
|
+
"description": "Sets the title of the composeAction button. Is used as tooltip and as the label.",
|
|
6528
6656
|
"async": "callback",
|
|
6529
6657
|
"parameters": [
|
|
6530
6658
|
{
|
|
6531
6659
|
"name": "details",
|
|
6532
6660
|
"type": "object",
|
|
6533
|
-
"$import": "Details",
|
|
6534
6661
|
"properties": {
|
|
6535
6662
|
"title": {
|
|
6536
6663
|
"choices": [
|
|
@@ -6541,7 +6668,20 @@
|
|
|
6541
6668
|
"type": "null"
|
|
6542
6669
|
}
|
|
6543
6670
|
],
|
|
6544
|
-
"description": "
|
|
6671
|
+
"description": "A string the composeAction button should display as its label and when moused over. Cleared by setting it to <value>null</value> or an empty string (title defined the manifest will be used)."
|
|
6672
|
+
},
|
|
6673
|
+
"tabId": {
|
|
6674
|
+
"type": "integer",
|
|
6675
|
+
"optional": true,
|
|
6676
|
+
"minimum": 0,
|
|
6677
|
+
"description": "Sets the title only for the given tab."
|
|
6678
|
+
},
|
|
6679
|
+
"windowId": {
|
|
6680
|
+
"type": "integer",
|
|
6681
|
+
"optional": true,
|
|
6682
|
+
"minimum": -2,
|
|
6683
|
+
"unsupported": true,
|
|
6684
|
+
"description": "Will throw an error if used."
|
|
6545
6685
|
}
|
|
6546
6686
|
}
|
|
6547
6687
|
},
|
|
@@ -6556,12 +6696,27 @@
|
|
|
6556
6696
|
{
|
|
6557
6697
|
"name": "getTitle",
|
|
6558
6698
|
"type": "function",
|
|
6559
|
-
"description": "Gets the title of the composeAction.",
|
|
6699
|
+
"description": "Gets the title of the composeAction button.",
|
|
6560
6700
|
"async": "callback",
|
|
6561
6701
|
"parameters": [
|
|
6562
6702
|
{
|
|
6563
6703
|
"name": "details",
|
|
6564
|
-
"
|
|
6704
|
+
"type": "object",
|
|
6705
|
+
"properties": {
|
|
6706
|
+
"tabId": {
|
|
6707
|
+
"type": "integer",
|
|
6708
|
+
"optional": true,
|
|
6709
|
+
"minimum": 0,
|
|
6710
|
+
"description": "Specifies for which tab the title should be retrieved. If no tab is specified, the global value is retrieved."
|
|
6711
|
+
},
|
|
6712
|
+
"windowId": {
|
|
6713
|
+
"type": "integer",
|
|
6714
|
+
"optional": true,
|
|
6715
|
+
"minimum": -2,
|
|
6716
|
+
"unsupported": true,
|
|
6717
|
+
"description": "Will throw an error if used."
|
|
6718
|
+
}
|
|
6719
|
+
}
|
|
6565
6720
|
},
|
|
6566
6721
|
{
|
|
6567
6722
|
"type": "function",
|
|
@@ -6578,13 +6733,12 @@
|
|
|
6578
6733
|
{
|
|
6579
6734
|
"name": "setLabel",
|
|
6580
6735
|
"type": "function",
|
|
6581
|
-
"description": "Sets the label of the composeAction
|
|
6736
|
+
"description": "Sets the label of the composeAction button. Can be used to set different values for the tooltip (defined by the title) and the label. Additionally, the label can be set to an empty string, not showing any label at all.",
|
|
6582
6737
|
"async": "callback",
|
|
6583
6738
|
"parameters": [
|
|
6584
6739
|
{
|
|
6585
6740
|
"name": "details",
|
|
6586
6741
|
"type": "object",
|
|
6587
|
-
"$import": "Details",
|
|
6588
6742
|
"properties": {
|
|
6589
6743
|
"label": {
|
|
6590
6744
|
"choices": [
|
|
@@ -6595,7 +6749,20 @@
|
|
|
6595
6749
|
"type": "null"
|
|
6596
6750
|
}
|
|
6597
6751
|
],
|
|
6598
|
-
"description": "
|
|
6752
|
+
"description": "A string the composeAction button should use as its label, overriding the defined title. Can be set to an empty string to not display any label at all. If the containing toolbar is configured to display text only, its title will be used. Cleared by setting it to <value>null</value>."
|
|
6753
|
+
},
|
|
6754
|
+
"tabId": {
|
|
6755
|
+
"type": "integer",
|
|
6756
|
+
"optional": true,
|
|
6757
|
+
"minimum": 0,
|
|
6758
|
+
"description": "Sets the label only for the given tab."
|
|
6759
|
+
},
|
|
6760
|
+
"windowId": {
|
|
6761
|
+
"type": "integer",
|
|
6762
|
+
"optional": true,
|
|
6763
|
+
"minimum": -2,
|
|
6764
|
+
"unsupported": true,
|
|
6765
|
+
"description": "Will throw an error if used."
|
|
6599
6766
|
}
|
|
6600
6767
|
}
|
|
6601
6768
|
},
|
|
@@ -6610,12 +6777,27 @@
|
|
|
6610
6777
|
{
|
|
6611
6778
|
"name": "getLabel",
|
|
6612
6779
|
"type": "function",
|
|
6613
|
-
"description": "Gets the label of the composeAction.",
|
|
6780
|
+
"description": "Gets the label of the composeAction button.",
|
|
6614
6781
|
"async": "callback",
|
|
6615
6782
|
"parameters": [
|
|
6616
6783
|
{
|
|
6617
6784
|
"name": "details",
|
|
6618
|
-
"
|
|
6785
|
+
"type": "object",
|
|
6786
|
+
"properties": {
|
|
6787
|
+
"tabId": {
|
|
6788
|
+
"type": "integer",
|
|
6789
|
+
"optional": true,
|
|
6790
|
+
"minimum": 0,
|
|
6791
|
+
"description": "Specifies for which tab the label should be retrieved. If no tab is specified, the global label is retrieved."
|
|
6792
|
+
},
|
|
6793
|
+
"windowId": {
|
|
6794
|
+
"type": "integer",
|
|
6795
|
+
"optional": true,
|
|
6796
|
+
"minimum": -2,
|
|
6797
|
+
"unsupported": true,
|
|
6798
|
+
"description": "Will throw an error if used."
|
|
6799
|
+
}
|
|
6800
|
+
}
|
|
6619
6801
|
},
|
|
6620
6802
|
{
|
|
6621
6803
|
"type": "function",
|
|
@@ -6632,13 +6814,12 @@
|
|
|
6632
6814
|
{
|
|
6633
6815
|
"name": "setIcon",
|
|
6634
6816
|
"type": "function",
|
|
6635
|
-
"description": "Sets the icon for the composeAction
|
|
6817
|
+
"description": "Sets the icon for the composeAction button. Either the ``path`` or the ``imageData`` property must be specified.",
|
|
6636
6818
|
"async": "callback",
|
|
6637
6819
|
"parameters": [
|
|
6638
6820
|
{
|
|
6639
6821
|
"name": "details",
|
|
6640
6822
|
"type": "object",
|
|
6641
|
-
"$import": "Details",
|
|
6642
6823
|
"properties": {
|
|
6643
6824
|
"imageData": {
|
|
6644
6825
|
"choices": [
|
|
@@ -6650,19 +6831,25 @@
|
|
|
6650
6831
|
}
|
|
6651
6832
|
],
|
|
6652
6833
|
"optional": true,
|
|
6653
|
-
"description": "
|
|
6834
|
+
"description": "The image data for one or more icons for the composeAction button."
|
|
6654
6835
|
},
|
|
6655
6836
|
"path": {
|
|
6656
|
-
"
|
|
6657
|
-
|
|
6658
|
-
|
|
6659
|
-
|
|
6660
|
-
|
|
6661
|
-
|
|
6662
|
-
|
|
6663
|
-
|
|
6837
|
+
"$ref": "manifest.IconPath",
|
|
6838
|
+
"optional": true,
|
|
6839
|
+
"description": "The paths to one or more icons for the composeAction button."
|
|
6840
|
+
},
|
|
6841
|
+
"tabId": {
|
|
6842
|
+
"type": "integer",
|
|
6843
|
+
"optional": true,
|
|
6844
|
+
"minimum": 0,
|
|
6845
|
+
"description": "Sets the icon only for the given tab."
|
|
6846
|
+
},
|
|
6847
|
+
"windowId": {
|
|
6848
|
+
"type": "integer",
|
|
6664
6849
|
"optional": true,
|
|
6665
|
-
"
|
|
6850
|
+
"minimum": -2,
|
|
6851
|
+
"unsupported": true,
|
|
6852
|
+
"description": "Will throw an error if used."
|
|
6666
6853
|
}
|
|
6667
6854
|
}
|
|
6668
6855
|
},
|
|
@@ -6677,13 +6864,12 @@
|
|
|
6677
6864
|
{
|
|
6678
6865
|
"name": "setPopup",
|
|
6679
6866
|
"type": "function",
|
|
6680
|
-
"description": "Sets the html document to be opened as a popup when the user clicks on the composeAction
|
|
6867
|
+
"description": "Sets the html document to be opened as a popup when the user clicks on the composeAction button.",
|
|
6681
6868
|
"async": "callback",
|
|
6682
6869
|
"parameters": [
|
|
6683
6870
|
{
|
|
6684
6871
|
"name": "details",
|
|
6685
6872
|
"type": "object",
|
|
6686
|
-
"$import": "Details",
|
|
6687
6873
|
"properties": {
|
|
6688
6874
|
"popup": {
|
|
6689
6875
|
"choices": [
|
|
@@ -6694,7 +6880,20 @@
|
|
|
6694
6880
|
"type": "null"
|
|
6695
6881
|
}
|
|
6696
6882
|
],
|
|
6697
|
-
"description": "The html file to show in a popup.
|
|
6883
|
+
"description": "The html file to show in a popup. Can be set to an empty string to not open a popup. Cleared by setting it to <value>null</value> (action will use the popup value defined in the manifest)."
|
|
6884
|
+
},
|
|
6885
|
+
"tabId": {
|
|
6886
|
+
"type": "integer",
|
|
6887
|
+
"optional": true,
|
|
6888
|
+
"minimum": 0,
|
|
6889
|
+
"description": "Sets the popup only for the given tab."
|
|
6890
|
+
},
|
|
6891
|
+
"windowId": {
|
|
6892
|
+
"type": "integer",
|
|
6893
|
+
"optional": true,
|
|
6894
|
+
"minimum": -2,
|
|
6895
|
+
"unsupported": true,
|
|
6896
|
+
"description": "Will throw an error if used."
|
|
6698
6897
|
}
|
|
6699
6898
|
}
|
|
6700
6899
|
},
|
|
@@ -6709,12 +6908,27 @@
|
|
|
6709
6908
|
{
|
|
6710
6909
|
"name": "getPopup",
|
|
6711
6910
|
"type": "function",
|
|
6712
|
-
"description": "Gets the html document set as the popup for this composeAction.",
|
|
6911
|
+
"description": "Gets the html document set as the popup for this composeAction button.",
|
|
6713
6912
|
"async": "callback",
|
|
6714
6913
|
"parameters": [
|
|
6715
6914
|
{
|
|
6716
6915
|
"name": "details",
|
|
6717
|
-
"
|
|
6916
|
+
"type": "object",
|
|
6917
|
+
"properties": {
|
|
6918
|
+
"tabId": {
|
|
6919
|
+
"type": "integer",
|
|
6920
|
+
"optional": true,
|
|
6921
|
+
"minimum": 0,
|
|
6922
|
+
"description": "Specifies for which tab the popup document should be retrieved. If no tab is specified, the global value is retrieved."
|
|
6923
|
+
},
|
|
6924
|
+
"windowId": {
|
|
6925
|
+
"type": "integer",
|
|
6926
|
+
"optional": true,
|
|
6927
|
+
"minimum": -2,
|
|
6928
|
+
"unsupported": true,
|
|
6929
|
+
"description": "Will throw an error if used."
|
|
6930
|
+
}
|
|
6931
|
+
}
|
|
6718
6932
|
},
|
|
6719
6933
|
{
|
|
6720
6934
|
"type": "function",
|
|
@@ -6731,13 +6945,12 @@
|
|
|
6731
6945
|
{
|
|
6732
6946
|
"name": "setBadgeText",
|
|
6733
6947
|
"type": "function",
|
|
6734
|
-
"description": "Sets the badge text for the composeAction. The badge is displayed on top of the icon.",
|
|
6948
|
+
"description": "Sets the badge text for the composeAction button. The badge is displayed on top of the icon.",
|
|
6735
6949
|
"async": "callback",
|
|
6736
6950
|
"parameters": [
|
|
6737
6951
|
{
|
|
6738
6952
|
"name": "details",
|
|
6739
6953
|
"type": "object",
|
|
6740
|
-
"$import": "Details",
|
|
6741
6954
|
"properties": {
|
|
6742
6955
|
"text": {
|
|
6743
6956
|
"choices": [
|
|
@@ -6748,7 +6961,20 @@
|
|
|
6748
6961
|
"type": "null"
|
|
6749
6962
|
}
|
|
6750
6963
|
],
|
|
6751
|
-
"description": "Any number of characters can be passed, but only about four can fit in the space."
|
|
6964
|
+
"description": "Any number of characters can be passed, but only about four can fit in the space. Cleared by setting it to <value>null</value> or an empty string."
|
|
6965
|
+
},
|
|
6966
|
+
"tabId": {
|
|
6967
|
+
"type": "integer",
|
|
6968
|
+
"optional": true,
|
|
6969
|
+
"minimum": 0,
|
|
6970
|
+
"description": "Sets the badge text only for the given tab."
|
|
6971
|
+
},
|
|
6972
|
+
"windowId": {
|
|
6973
|
+
"type": "integer",
|
|
6974
|
+
"optional": true,
|
|
6975
|
+
"minimum": -2,
|
|
6976
|
+
"unsupported": true,
|
|
6977
|
+
"description": "Will throw an error if used."
|
|
6752
6978
|
}
|
|
6753
6979
|
}
|
|
6754
6980
|
},
|
|
@@ -6763,12 +6989,27 @@
|
|
|
6763
6989
|
{
|
|
6764
6990
|
"name": "getBadgeText",
|
|
6765
6991
|
"type": "function",
|
|
6766
|
-
"description": "Gets the badge text of the composeAction
|
|
6992
|
+
"description": "Gets the badge text of the composeAction button.",
|
|
6767
6993
|
"async": "callback",
|
|
6768
6994
|
"parameters": [
|
|
6769
6995
|
{
|
|
6770
6996
|
"name": "details",
|
|
6771
|
-
"
|
|
6997
|
+
"type": "object",
|
|
6998
|
+
"properties": {
|
|
6999
|
+
"tabId": {
|
|
7000
|
+
"type": "integer",
|
|
7001
|
+
"optional": true,
|
|
7002
|
+
"minimum": 0,
|
|
7003
|
+
"description": "Specifies for which tab the badge text should be retrieved. If no tab is specified, the global label is retrieved."
|
|
7004
|
+
},
|
|
7005
|
+
"windowId": {
|
|
7006
|
+
"type": "integer",
|
|
7007
|
+
"optional": true,
|
|
7008
|
+
"minimum": -2,
|
|
7009
|
+
"unsupported": true,
|
|
7010
|
+
"description": "Will throw an error if used."
|
|
7011
|
+
}
|
|
7012
|
+
}
|
|
6772
7013
|
},
|
|
6773
7014
|
{
|
|
6774
7015
|
"type": "function",
|
|
@@ -6791,10 +7032,8 @@
|
|
|
6791
7032
|
{
|
|
6792
7033
|
"name": "details",
|
|
6793
7034
|
"type": "object",
|
|
6794
|
-
"$import": "Details",
|
|
6795
7035
|
"properties": {
|
|
6796
7036
|
"color": {
|
|
6797
|
-
"description": "An array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is <code>[255, 0, 0, 255]</code>. Can also be a string with a CSS value, with opaque red being <code>#FF0000</code> or <code>#F00</code>.",
|
|
6798
7037
|
"choices": [
|
|
6799
7038
|
{
|
|
6800
7039
|
"type": "string"
|
|
@@ -6805,7 +7044,21 @@
|
|
|
6805
7044
|
{
|
|
6806
7045
|
"type": "null"
|
|
6807
7046
|
}
|
|
6808
|
-
]
|
|
7047
|
+
],
|
|
7048
|
+
"description": "The color to use as background in the badge. Cleared by setting it to <value>null</value> or an empty string."
|
|
7049
|
+
},
|
|
7050
|
+
"tabId": {
|
|
7051
|
+
"type": "integer",
|
|
7052
|
+
"optional": true,
|
|
7053
|
+
"minimum": 0,
|
|
7054
|
+
"description": "Sets the background color for the badge only for the given tab."
|
|
7055
|
+
},
|
|
7056
|
+
"windowId": {
|
|
7057
|
+
"type": "integer",
|
|
7058
|
+
"optional": true,
|
|
7059
|
+
"minimum": -2,
|
|
7060
|
+
"unsupported": true,
|
|
7061
|
+
"description": "Will throw an error if used."
|
|
6809
7062
|
}
|
|
6810
7063
|
}
|
|
6811
7064
|
},
|
|
@@ -6820,12 +7073,27 @@
|
|
|
6820
7073
|
{
|
|
6821
7074
|
"name": "getBadgeBackgroundColor",
|
|
6822
7075
|
"type": "function",
|
|
6823
|
-
"description": "Gets the background color of the composeAction.",
|
|
7076
|
+
"description": "Gets the badge background color of the composeAction button.",
|
|
6824
7077
|
"async": "callback",
|
|
6825
7078
|
"parameters": [
|
|
6826
7079
|
{
|
|
6827
7080
|
"name": "details",
|
|
6828
|
-
"
|
|
7081
|
+
"type": "object",
|
|
7082
|
+
"properties": {
|
|
7083
|
+
"tabId": {
|
|
7084
|
+
"type": "integer",
|
|
7085
|
+
"optional": true,
|
|
7086
|
+
"minimum": 0,
|
|
7087
|
+
"description": "Specifies for which tab the badge background color should be retrieved. If no tab is specified, the global label is retrieved."
|
|
7088
|
+
},
|
|
7089
|
+
"windowId": {
|
|
7090
|
+
"type": "integer",
|
|
7091
|
+
"optional": true,
|
|
7092
|
+
"minimum": -2,
|
|
7093
|
+
"unsupported": true,
|
|
7094
|
+
"description": "Will throw an error if used."
|
|
7095
|
+
}
|
|
7096
|
+
}
|
|
6829
7097
|
},
|
|
6830
7098
|
{
|
|
6831
7099
|
"type": "function",
|
|
@@ -6842,7 +7110,7 @@
|
|
|
6842
7110
|
{
|
|
6843
7111
|
"name": "enable",
|
|
6844
7112
|
"type": "function",
|
|
6845
|
-
"description": "Enables the composeAction for a tab. By default, a composeAction is enabled.",
|
|
7113
|
+
"description": "Enables the composeAction button for a tab. By default, a composeAction button is enabled.",
|
|
6846
7114
|
"async": "callback",
|
|
6847
7115
|
"parameters": [
|
|
6848
7116
|
{
|
|
@@ -6850,7 +7118,7 @@
|
|
|
6850
7118
|
"optional": true,
|
|
6851
7119
|
"name": "tabId",
|
|
6852
7120
|
"minimum": 0,
|
|
6853
|
-
"description": "The id of the tab for which you want to modify the composeAction."
|
|
7121
|
+
"description": "The id of the tab for which you want to modify the composeAction button."
|
|
6854
7122
|
},
|
|
6855
7123
|
{
|
|
6856
7124
|
"type": "function",
|
|
@@ -6863,7 +7131,7 @@
|
|
|
6863
7131
|
{
|
|
6864
7132
|
"name": "disable",
|
|
6865
7133
|
"type": "function",
|
|
6866
|
-
"description": "Disables the composeAction for a tab.",
|
|
7134
|
+
"description": "Disables the composeAction button for a tab.",
|
|
6867
7135
|
"async": "callback",
|
|
6868
7136
|
"parameters": [
|
|
6869
7137
|
{
|
|
@@ -6871,7 +7139,7 @@
|
|
|
6871
7139
|
"optional": true,
|
|
6872
7140
|
"name": "tabId",
|
|
6873
7141
|
"minimum": 0,
|
|
6874
|
-
"description": "The id of the tab for which you want to modify the composeAction."
|
|
7142
|
+
"description": "The id of the tab for which you want to modify the composeAction button."
|
|
6875
7143
|
},
|
|
6876
7144
|
{
|
|
6877
7145
|
"type": "function",
|
|
@@ -6884,12 +7152,27 @@
|
|
|
6884
7152
|
{
|
|
6885
7153
|
"name": "isEnabled",
|
|
6886
7154
|
"type": "function",
|
|
6887
|
-
"description": "Checks whether the composeAction is enabled.",
|
|
7155
|
+
"description": "Checks whether the composeAction button is enabled.",
|
|
6888
7156
|
"async": "callback",
|
|
6889
7157
|
"parameters": [
|
|
6890
7158
|
{
|
|
6891
7159
|
"name": "details",
|
|
6892
|
-
"
|
|
7160
|
+
"type": "object",
|
|
7161
|
+
"properties": {
|
|
7162
|
+
"tabId": {
|
|
7163
|
+
"type": "integer",
|
|
7164
|
+
"optional": true,
|
|
7165
|
+
"minimum": 0,
|
|
7166
|
+
"description": "Specifies for which tab the state should be retrieved. If no tab is specified, the global value is retrieved."
|
|
7167
|
+
},
|
|
7168
|
+
"windowId": {
|
|
7169
|
+
"type": "integer",
|
|
7170
|
+
"optional": true,
|
|
7171
|
+
"minimum": -2,
|
|
7172
|
+
"unsupported": true,
|
|
7173
|
+
"description": "Will throw an error if used."
|
|
7174
|
+
}
|
|
7175
|
+
}
|
|
6893
7176
|
},
|
|
6894
7177
|
{
|
|
6895
7178
|
"type": "function",
|
|
@@ -6907,7 +7190,7 @@
|
|
|
6907
7190
|
"name": "openPopup",
|
|
6908
7191
|
"type": "function",
|
|
6909
7192
|
"requireUserInput": true,
|
|
6910
|
-
"description": "Opens the
|
|
7193
|
+
"description": "Opens the action's popup window in the active window.",
|
|
6911
7194
|
"async": true,
|
|
6912
7195
|
"parameters": []
|
|
6913
7196
|
}
|
|
@@ -6916,7 +7199,7 @@
|
|
|
6916
7199
|
{
|
|
6917
7200
|
"name": "onClicked",
|
|
6918
7201
|
"type": "function",
|
|
6919
|
-
"description": "Fired when a composeAction
|
|
7202
|
+
"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 `restrictions <|link-user-input-restrictions|>`__ apply.",
|
|
6920
7203
|
"parameters": [
|
|
6921
7204
|
{
|
|
6922
7205
|
"name": "tab",
|
|
@@ -7265,7 +7548,7 @@
|
|
|
7265
7548
|
"permissions": [
|
|
7266
7549
|
"accountsFolders"
|
|
7267
7550
|
],
|
|
7268
|
-
"description": "Copies the given ``sourceFolder`` into the given ``destination``.
|
|
7551
|
+
"description": "Copies the given ``sourceFolder`` into the given ``destination``. Throws if the destination already contains a folder with the name of the source folder.",
|
|
7269
7552
|
"async": "callback",
|
|
7270
7553
|
"parameters": [
|
|
7271
7554
|
{
|
|
@@ -7345,7 +7628,7 @@
|
|
|
7345
7628
|
},
|
|
7346
7629
|
{
|
|
7347
7630
|
"name": "includeSubFolders",
|
|
7348
|
-
"description": "Specifies whether the returned :ref:`folders.MailFolder` object for each parent folder should include its nested subfolders . Defaults to
|
|
7631
|
+
"description": "Specifies whether the returned :ref:`folders.MailFolder` object for each parent folder should include its nested subfolders . Defaults to <value>false</value>.",
|
|
7349
7632
|
"optional": true,
|
|
7350
7633
|
"default": false,
|
|
7351
7634
|
"type": "boolean"
|
|
@@ -7384,7 +7667,7 @@
|
|
|
7384
7667
|
},
|
|
7385
7668
|
{
|
|
7386
7669
|
"name": "includeSubFolders",
|
|
7387
|
-
"description": "Specifies whether the returned :ref:`folders.MailFolder` object for each direct subfolder should also include all its nested subfolders . Defaults to
|
|
7670
|
+
"description": "Specifies whether the returned :ref:`folders.MailFolder` object for each direct subfolder should also include all its nested subfolders . Defaults to <value>true</value>.",
|
|
7388
7671
|
"optional": true,
|
|
7389
7672
|
"default": true,
|
|
7390
7673
|
"type": "boolean"
|
|
@@ -7601,7 +7884,7 @@
|
|
|
7601
7884
|
{
|
|
7602
7885
|
"name": "get",
|
|
7603
7886
|
"type": "function",
|
|
7604
|
-
"description": "Returns details of the requested identity, or null if it doesn't exist.",
|
|
7887
|
+
"description": "Returns details of the requested identity, or <value>null</value> if it doesn't exist.",
|
|
7605
7888
|
"async": "callback",
|
|
7606
7889
|
"parameters": [
|
|
7607
7890
|
{
|
|
@@ -7697,7 +7980,7 @@
|
|
|
7697
7980
|
{
|
|
7698
7981
|
"name": "getDefault",
|
|
7699
7982
|
"type": "function",
|
|
7700
|
-
"description": "Returns the default identity for the requested account, or null if it is not defined.",
|
|
7983
|
+
"description": "Returns the default identity for the requested account, or <value>null</value> if it is not defined.",
|
|
7701
7984
|
"async": "callback",
|
|
7702
7985
|
"parameters": [
|
|
7703
7986
|
{
|
|
@@ -7870,26 +8153,26 @@
|
|
|
7870
8153
|
"properties": {
|
|
7871
8154
|
"text": {
|
|
7872
8155
|
"type": "string",
|
|
7873
|
-
"description": "String to match against the
|
|
8156
|
+
"description": "String to match against the ``recipients``, ``author``, ``subject``, or ``body``."
|
|
7874
8157
|
},
|
|
7875
8158
|
"recipients": {
|
|
7876
8159
|
"type": "boolean",
|
|
7877
|
-
"description": "Shows messages where
|
|
8160
|
+
"description": "Shows messages where ``text`` matches the recipients.",
|
|
7878
8161
|
"optional": true
|
|
7879
8162
|
},
|
|
7880
8163
|
"author": {
|
|
7881
8164
|
"type": "boolean",
|
|
7882
|
-
"description": "Shows messages where
|
|
8165
|
+
"description": "Shows messages where ``text`` matches the author.",
|
|
7883
8166
|
"optional": true
|
|
7884
8167
|
},
|
|
7885
8168
|
"subject": {
|
|
7886
8169
|
"type": "boolean",
|
|
7887
|
-
"description": "Shows messages where
|
|
8170
|
+
"description": "Shows messages where ``text`` matches the subject.",
|
|
7888
8171
|
"optional": true
|
|
7889
8172
|
},
|
|
7890
8173
|
"body": {
|
|
7891
8174
|
"type": "boolean",
|
|
7892
|
-
"description": "Shows messages where
|
|
8175
|
+
"description": "Shows messages where ``text`` matches the message body.",
|
|
7893
8176
|
"optional": true
|
|
7894
8177
|
}
|
|
7895
8178
|
}
|
|
@@ -7989,7 +8272,7 @@
|
|
|
7989
8272
|
{
|
|
7990
8273
|
"name": "update",
|
|
7991
8274
|
"type": "function",
|
|
7992
|
-
"description": "Modifies the properties of a mail tab. Properties that are not specified in
|
|
8275
|
+
"description": "Modifies the properties of a mail tab. Properties that are not specified in ``updateProperties`` are not modified.",
|
|
7993
8276
|
"async": true,
|
|
7994
8277
|
"parameters": [
|
|
7995
8278
|
{
|
|
@@ -8010,7 +8293,7 @@
|
|
|
8010
8293
|
},
|
|
8011
8294
|
"sortType": {
|
|
8012
8295
|
"type": "string",
|
|
8013
|
-
"description": "Sorts the list of messages.
|
|
8296
|
+
"description": "Sorts the list of messages. ``sortOrder`` must also be given.",
|
|
8014
8297
|
"optional": true,
|
|
8015
8298
|
"enum": [
|
|
8016
8299
|
"none",
|
|
@@ -8037,7 +8320,7 @@
|
|
|
8037
8320
|
},
|
|
8038
8321
|
"sortOrder": {
|
|
8039
8322
|
"type": "string",
|
|
8040
|
-
"description": "Sorts the list of messages.
|
|
8323
|
+
"description": "Sorts the list of messages. ``sortType`` must also be given.",
|
|
8041
8324
|
"optional": true,
|
|
8042
8325
|
"enum": [
|
|
8043
8326
|
"none",
|
|
@@ -8270,7 +8553,7 @@
|
|
|
8270
8553
|
"permissions": [
|
|
8271
8554
|
"menus"
|
|
8272
8555
|
],
|
|
8273
|
-
"description": "
|
|
8556
|
+
"description": "The menus API allows to add items to Thunderbirds menus. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages.",
|
|
8274
8557
|
"properties": {
|
|
8275
8558
|
"ACTION_MENU_TOP_LEVEL_LIMIT": {
|
|
8276
8559
|
"value": 6,
|
|
@@ -8303,7 +8586,7 @@
|
|
|
8303
8586
|
"all_message_attachments",
|
|
8304
8587
|
"tools_menu"
|
|
8305
8588
|
],
|
|
8306
|
-
"description": "The different contexts a menu can appear in. Specifying <
|
|
8589
|
+
"description": "The different contexts a menu can appear in. Specifying <value>all</value> is equivalent to the combination of all other contexts excluding <value>tab</value> and <value>tools_menu</value>. More information about each context can be found in the `Supported UI Elements <|link-ui-elements|>`__ article on developer.thunderbird.net."
|
|
8307
8590
|
},
|
|
8308
8591
|
{
|
|
8309
8592
|
"id": "ItemType",
|
|
@@ -8349,7 +8632,7 @@
|
|
|
8349
8632
|
"mediaType": {
|
|
8350
8633
|
"type": "string",
|
|
8351
8634
|
"optional": true,
|
|
8352
|
-
"description": "One of
|
|
8635
|
+
"description": "One of <value>image</value>, <value>video</value>, or <value>audio</value> if the context menu was activated on one of these types of elements."
|
|
8353
8636
|
},
|
|
8354
8637
|
"viewType": {
|
|
8355
8638
|
"$ref": "extension.ViewType",
|
|
@@ -8368,7 +8651,7 @@
|
|
|
8368
8651
|
},
|
|
8369
8652
|
"srcUrl": {
|
|
8370
8653
|
"type": "string",
|
|
8371
|
-
"description": "Will be present for elements with a
|
|
8654
|
+
"description": "Will be present for elements with a <em>src</em> URL. **Note:** Host permission is required.",
|
|
8372
8655
|
"optional": true
|
|
8373
8656
|
},
|
|
8374
8657
|
"pageUrl": {
|
|
@@ -8389,7 +8672,7 @@
|
|
|
8389
8672
|
"targetElementId": {
|
|
8390
8673
|
"type": "integer",
|
|
8391
8674
|
"optional": true,
|
|
8392
|
-
"description": "An identifier of the clicked content element, if any. Use menus.getTargetElement in the page to find the corresponding element."
|
|
8675
|
+
"description": "An identifier of the clicked content element, if any. Use :ref:`menus.getTargetElement` in the page to find the corresponding element."
|
|
8393
8676
|
},
|
|
8394
8677
|
"fieldId": {
|
|
8395
8678
|
"type": "string",
|
|
@@ -8476,7 +8759,7 @@
|
|
|
8476
8759
|
"mediaType": {
|
|
8477
8760
|
"type": "string",
|
|
8478
8761
|
"optional": true,
|
|
8479
|
-
"description": "One of
|
|
8762
|
+
"description": "One of <value>image</value>, <value>video</value>, or <value>audio</value> if the context menu was activated on one of these types of elements."
|
|
8480
8763
|
},
|
|
8481
8764
|
"viewType": {
|
|
8482
8765
|
"$ref": "extension.ViewType",
|
|
@@ -8496,7 +8779,7 @@
|
|
|
8496
8779
|
"srcUrl": {
|
|
8497
8780
|
"type": "string",
|
|
8498
8781
|
"optional": true,
|
|
8499
|
-
"description": "Will be present for elements with a
|
|
8782
|
+
"description": "Will be present for elements with a <em>src</em> URL."
|
|
8500
8783
|
},
|
|
8501
8784
|
"pageUrl": {
|
|
8502
8785
|
"type": "string",
|
|
@@ -8551,7 +8834,7 @@
|
|
|
8551
8834
|
"targetElementId": {
|
|
8552
8835
|
"type": "integer",
|
|
8553
8836
|
"optional": true,
|
|
8554
|
-
"description": "An identifier of the clicked content element, if any. Use menus.getTargetElement in the page to find the corresponding element."
|
|
8837
|
+
"description": "An identifier of the clicked content element, if any. Use :ref:`menus.getTargetElement` in the page to find the corresponding element."
|
|
8555
8838
|
},
|
|
8556
8839
|
"fieldId": {
|
|
8557
8840
|
"type": "string",
|
|
@@ -8608,7 +8891,7 @@
|
|
|
8608
8891
|
{
|
|
8609
8892
|
"name": "create",
|
|
8610
8893
|
"type": "function",
|
|
8611
|
-
"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 `runtime.lastError
|
|
8894
|
+
"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 `runtime.lastError <|link-runtime-last-error|>`__).",
|
|
8612
8895
|
"returns": {
|
|
8613
8896
|
"choices": [
|
|
8614
8897
|
{
|
|
@@ -8628,7 +8911,7 @@
|
|
|
8628
8911
|
"type": {
|
|
8629
8912
|
"$ref": "ItemType",
|
|
8630
8913
|
"optional": true,
|
|
8631
|
-
"description": "The type of menu item. Defaults to
|
|
8914
|
+
"description": "The type of menu item. Defaults to <value>normal</value> if not specified."
|
|
8632
8915
|
},
|
|
8633
8916
|
"id": {
|
|
8634
8917
|
"type": "string",
|
|
@@ -8636,23 +8919,19 @@
|
|
|
8636
8919
|
"description": "The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension."
|
|
8637
8920
|
},
|
|
8638
8921
|
"icons": {
|
|
8639
|
-
"
|
|
8922
|
+
"$ref": "manifest.IconPath",
|
|
8640
8923
|
"optional": true,
|
|
8641
|
-
"
|
|
8642
|
-
"^[1-9]\\d*$": {
|
|
8643
|
-
"type": "string"
|
|
8644
|
-
}
|
|
8645
|
-
}
|
|
8924
|
+
"description": "Custom icons to display next to the menu item. Custom icons can only be set for items appearing in submenus."
|
|
8646
8925
|
},
|
|
8647
8926
|
"title": {
|
|
8648
8927
|
"type": "string",
|
|
8649
8928
|
"optional": true,
|
|
8650
|
-
"description": "The text to be displayed in the item; this is <em>required</em> unless
|
|
8929
|
+
"description": "The text to be displayed in the item; this is <em>required</em> unless ``type`` is <value>separator</value>. When the context is <value>selection</value>, you can use <value>%s</value> within the string to show the selected text. For example, if this parameter's value is <value>Translate '%s' to Latin</value> and the user selects the word <value>cool</value>, the context menu item for the selection is <value>Translate 'cool' to Latin</value>. To specify an access key for the new menu entry, include a <value>&</value> before the desired letter in the title. For example <value>&Help</value>."
|
|
8651
8930
|
},
|
|
8652
8931
|
"checked": {
|
|
8653
8932
|
"type": "boolean",
|
|
8654
8933
|
"optional": true,
|
|
8655
|
-
"description": "The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items."
|
|
8934
|
+
"description": "The initial state of a checkbox or radio item: <value>true</value> for selected and <value>false</value> for unselected. Only one radio item can be selected at a time in a given group of radio items."
|
|
8656
8935
|
},
|
|
8657
8936
|
"contexts": {
|
|
8658
8937
|
"type": "array",
|
|
@@ -8661,7 +8940,7 @@
|
|
|
8661
8940
|
},
|
|
8662
8941
|
"minItems": 1,
|
|
8663
8942
|
"optional": true,
|
|
8664
|
-
"description": "List of contexts this menu item will appear in. Defaults to ['page'] if not specified."
|
|
8943
|
+
"description": "List of contexts this menu item will appear in. Defaults to <value>['page']</value> if not specified."
|
|
8665
8944
|
},
|
|
8666
8945
|
"viewTypes": {
|
|
8667
8946
|
"type": "array",
|
|
@@ -8690,7 +8969,7 @@
|
|
|
8690
8969
|
{
|
|
8691
8970
|
"name": "tab",
|
|
8692
8971
|
"$ref": "tabs.Tab",
|
|
8693
|
-
"description": "The details of the tab where the click took place.
|
|
8972
|
+
"description": "The details of the tab where the click took place."
|
|
8694
8973
|
}
|
|
8695
8974
|
]
|
|
8696
8975
|
},
|
|
@@ -8712,7 +8991,7 @@
|
|
|
8712
8991
|
"type": "string"
|
|
8713
8992
|
},
|
|
8714
8993
|
"optional": true,
|
|
8715
|
-
"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 `Match Patterns
|
|
8994
|
+
"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 `Match Patterns <|link-match-patterns|>`__."
|
|
8716
8995
|
},
|
|
8717
8996
|
"targetUrlPatterns": {
|
|
8718
8997
|
"type": "array",
|
|
@@ -8730,7 +9009,7 @@
|
|
|
8730
9009
|
"command": {
|
|
8731
9010
|
"type": "string",
|
|
8732
9011
|
"optional": true,
|
|
8733
|
-
"description": "Specifies a command to issue for the context click.
|
|
9012
|
+
"description": "Specifies a command to issue for the context click. Currently supports internal commands <value>_execute_browser_action</value>, <value>_execute_compose_action</value> and <value>_execute_message_display_action</value>."
|
|
8734
9013
|
}
|
|
8735
9014
|
}
|
|
8736
9015
|
},
|
|
@@ -8738,7 +9017,7 @@
|
|
|
8738
9017
|
"type": "function",
|
|
8739
9018
|
"name": "callback",
|
|
8740
9019
|
"optional": true,
|
|
8741
|
-
"description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in `runtime.lastError
|
|
9020
|
+
"description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in `runtime.lastError <|link-runtime-last-error|>`__.",
|
|
8742
9021
|
"parameters": []
|
|
8743
9022
|
}
|
|
8744
9023
|
]
|
|
@@ -8771,13 +9050,8 @@
|
|
|
8771
9050
|
"optional": true
|
|
8772
9051
|
},
|
|
8773
9052
|
"icons": {
|
|
8774
|
-
"
|
|
8775
|
-
"optional": "omit-key-if-missing"
|
|
8776
|
-
"patternProperties": {
|
|
8777
|
-
"^[1-9]\\d*$": {
|
|
8778
|
-
"type": "string"
|
|
8779
|
-
}
|
|
8780
|
-
}
|
|
9053
|
+
"$ref": "manifest.IconPath",
|
|
9054
|
+
"optional": "omit-key-if-missing"
|
|
8781
9055
|
},
|
|
8782
9056
|
"title": {
|
|
8783
9057
|
"type": "string",
|
|
@@ -8912,7 +9186,7 @@
|
|
|
8912
9186
|
"menus.overrideContext"
|
|
8913
9187
|
],
|
|
8914
9188
|
"type": "function",
|
|
8915
|
-
"description": "Show the matching menu items from this extension instead of the default menu. This should be called during a
|
|
9189
|
+
"description": "Show the matching menu items from this extension instead of the default menu. This should be called during a `contextmenu <|link-contextmenu-event|>`__ event handler, and only applies to the menu that opens after this event.",
|
|
8916
9190
|
"parameters": [
|
|
8917
9191
|
{
|
|
8918
9192
|
"name": "contextOptions",
|
|
@@ -8930,13 +9204,13 @@
|
|
|
8930
9204
|
"tab"
|
|
8931
9205
|
],
|
|
8932
9206
|
"optional": true,
|
|
8933
|
-
"description": "ContextType to override, to allow menu items from other extensions in the menu. Currently only
|
|
9207
|
+
"description": "ContextType to override, to allow menu items from other extensions in the menu. Currently only <value>tab</value> is supported. ``contextOptions.showDefaults`` cannot be used with this option."
|
|
8934
9208
|
},
|
|
8935
9209
|
"tabId": {
|
|
8936
9210
|
"type": "integer",
|
|
8937
9211
|
"minimum": 0,
|
|
8938
9212
|
"optional": true,
|
|
8939
|
-
"description": "Required when context is
|
|
9213
|
+
"description": "Required when context is <value>tab</value>. Requires the <permission>tabs</permission> permission."
|
|
8940
9214
|
}
|
|
8941
9215
|
}
|
|
8942
9216
|
}
|
|
@@ -8954,7 +9228,7 @@
|
|
|
8954
9228
|
{
|
|
8955
9229
|
"name": "onClicked",
|
|
8956
9230
|
"type": "function",
|
|
8957
|
-
"description": "Fired when a context menu item is clicked. This is a user input event handler. For asynchronous listeners some `restrictions
|
|
9231
|
+
"description": "Fired when a context menu item is clicked. This is a user input event handler. For asynchronous listeners some `restrictions <|link-user-input-restrictions|>`__ apply.",
|
|
8958
9232
|
"parameters": [
|
|
8959
9233
|
{
|
|
8960
9234
|
"name": "info",
|
|
@@ -8972,7 +9246,7 @@
|
|
|
8972
9246
|
{
|
|
8973
9247
|
"name": "onShown",
|
|
8974
9248
|
"type": "function",
|
|
8975
|
-
"description": "Fired when a menu is shown. The extension can add, modify or remove menu items and call
|
|
9249
|
+
"description": "Fired when a menu is shown. The extension can add, modify or remove menu items and call :ref:`menus.refresh` to update the menu.",
|
|
8976
9250
|
"parameters": [
|
|
8977
9251
|
{
|
|
8978
9252
|
"name": "info",
|
|
@@ -9014,11 +9288,11 @@
|
|
|
9014
9288
|
"content",
|
|
9015
9289
|
"devtools"
|
|
9016
9290
|
],
|
|
9017
|
-
"description": "Retrieve the element that was associated with a recent contextmenu event.",
|
|
9291
|
+
"description": "Retrieve the element that was associated with a recent `contextmenu <|link-contextmenu-event|>`__ event.",
|
|
9018
9292
|
"parameters": [
|
|
9019
9293
|
{
|
|
9020
9294
|
"type": "integer",
|
|
9021
|
-
"description": "The identifier of the clicked element, available as info.targetElementId in the menus.onShown
|
|
9295
|
+
"description": "The identifier of the clicked element, available as ``info.targetElementId`` in the :ref:`menus.onShown` and :ref:`menus.onClicked` events.",
|
|
9022
9296
|
"name": "targetElementId"
|
|
9023
9297
|
}
|
|
9024
9298
|
],
|
|
@@ -9079,7 +9353,7 @@
|
|
|
9079
9353
|
{
|
|
9080
9354
|
"name": "getDisplayedMessage",
|
|
9081
9355
|
"type": "function",
|
|
9082
|
-
"description": "Gets the currently displayed message in the specified tab (even if the tab itself is currently not visible). It returns null if no messages are displayed, or if multiple messages are displayed.",
|
|
9356
|
+
"description": "Gets the currently displayed message in the specified tab (even if the tab itself is currently not visible). It returns <value>null</value> if no messages are displayed, or if multiple messages are displayed.",
|
|
9083
9357
|
"async": "callback",
|
|
9084
9358
|
"parameters": [
|
|
9085
9359
|
{
|
|
@@ -9147,12 +9421,12 @@
|
|
|
9147
9421
|
"type": "integer",
|
|
9148
9422
|
"optional": true,
|
|
9149
9423
|
"minimum": 1,
|
|
9150
|
-
"description": "The id of a message to be opened. Will throw an
|
|
9424
|
+
"description": "The id of a message to be opened. Will throw an <em>ExtensionError</em>, if the provided ``messageId`` is unknown or invalid."
|
|
9151
9425
|
},
|
|
9152
9426
|
"headerMessageId": {
|
|
9153
9427
|
"type": "string",
|
|
9154
9428
|
"optional": true,
|
|
9155
|
-
"description": "The headerMessageId of a message to be opened. Will throw an
|
|
9429
|
+
"description": "The headerMessageId of a message to be opened. Will throw an <em>ExtensionError</em>, if the provided ``headerMessageId`` is unknown or invalid. Not supported for external messages."
|
|
9156
9430
|
},
|
|
9157
9431
|
"location": {
|
|
9158
9432
|
"type": "string",
|
|
@@ -9206,19 +9480,19 @@
|
|
|
9206
9480
|
"properties": {
|
|
9207
9481
|
"default_label": {
|
|
9208
9482
|
"type": "string",
|
|
9209
|
-
"description": "The label of the messageDisplayAction, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
|
|
9483
|
+
"description": "The label of the messageDisplayAction button, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.",
|
|
9210
9484
|
"optional": true,
|
|
9211
9485
|
"preprocess": "localize"
|
|
9212
9486
|
},
|
|
9213
9487
|
"default_title": {
|
|
9214
9488
|
"type": "string",
|
|
9215
|
-
"description": "The title of the messageDisplayAction. This shows up in the tooltip and the label. Defaults to the add-on name.",
|
|
9489
|
+
"description": "The title of the messageDisplayAction button. This shows up in the tooltip and the label. Defaults to the add-on name.",
|
|
9216
9490
|
"optional": true,
|
|
9217
9491
|
"preprocess": "localize"
|
|
9218
9492
|
},
|
|
9219
9493
|
"default_icon": {
|
|
9220
9494
|
"$ref": "IconPath",
|
|
9221
|
-
"description": "The
|
|
9495
|
+
"description": "The paths to one or more icons for the messageDisplayAction button.",
|
|
9222
9496
|
"optional": true
|
|
9223
9497
|
},
|
|
9224
9498
|
"theme_icons": {
|
|
@@ -9234,13 +9508,13 @@
|
|
|
9234
9508
|
"type": "string",
|
|
9235
9509
|
"format": "relativeUrl",
|
|
9236
9510
|
"optional": true,
|
|
9237
|
-
"description": "The html document to be opened as a popup when the user clicks on the messageDisplayAction
|
|
9511
|
+
"description": "The html document to be opened as a popup when the user clicks on the messageDisplayAction button.",
|
|
9238
9512
|
"preprocess": "localize"
|
|
9239
9513
|
},
|
|
9240
9514
|
"browser_style": {
|
|
9241
9515
|
"type": "boolean",
|
|
9242
9516
|
"optional": true,
|
|
9243
|
-
"description": "Enable browser styles. See the `MDN documentation on browser styles
|
|
9517
|
+
"description": "Enable browser styles. See the `MDN documentation on browser styles <|link-mdn-browser-styles|>`__ for more information.",
|
|
9244
9518
|
"default": false
|
|
9245
9519
|
},
|
|
9246
9520
|
"default_area": {
|
|
@@ -9257,34 +9531,15 @@
|
|
|
9257
9531
|
},
|
|
9258
9532
|
{
|
|
9259
9533
|
"namespace": "messageDisplayAction",
|
|
9260
|
-
"description": "Use a messageDisplayAction to put
|
|
9534
|
+
"description": "Use a messageDisplayAction to put a button in the message display toolbar. In addition to its icon, a messageDisplayAction button can also have a tooltip, a badge, and a popup.",
|
|
9261
9535
|
"permissions": [
|
|
9262
9536
|
"manifest:message_display_action"
|
|
9263
9537
|
],
|
|
9264
9538
|
"types": [
|
|
9265
|
-
{
|
|
9266
|
-
"id": "Details",
|
|
9267
|
-
"type": "object",
|
|
9268
|
-
"description": "Specifies to which tab or window the value should be set, or from which one it should be retrieved. If no tab nor window is specified, the global value is set or retrieved.",
|
|
9269
|
-
"properties": {
|
|
9270
|
-
"tabId": {
|
|
9271
|
-
"type": "integer",
|
|
9272
|
-
"optional": true,
|
|
9273
|
-
"minimum": 0,
|
|
9274
|
-
"description": "When setting a value, it will be specific to the specified tab, and will automatically reset when the tab navigates. When getting, specifies the tab to get the value from; if there is no tab-specific value, the window one will be inherited."
|
|
9275
|
-
},
|
|
9276
|
-
"windowId": {
|
|
9277
|
-
"type": "integer",
|
|
9278
|
-
"optional": true,
|
|
9279
|
-
"minimum": -2,
|
|
9280
|
-
"description": "When setting a value, it will be specific to the specified window. When getting, specifies the window to get the value from; if there is no window-specific value, the global one will be inherited."
|
|
9281
|
-
}
|
|
9282
|
-
}
|
|
9283
|
-
},
|
|
9284
9539
|
{
|
|
9285
9540
|
"id": "ColorArray",
|
|
9541
|
+
"description": "An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is <value>[255, 0, 0, 255]</value>.",
|
|
9286
9542
|
"type": "array",
|
|
9287
|
-
"description": "An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is <code>[255, 0, 0, 255]</code>.",
|
|
9288
9543
|
"items": {
|
|
9289
9544
|
"type": "integer",
|
|
9290
9545
|
"minimum": 0,
|
|
@@ -9301,12 +9556,12 @@
|
|
|
9301
9556
|
"type": "any"
|
|
9302
9557
|
},
|
|
9303
9558
|
"postprocess": "convertImageDataToURL",
|
|
9304
|
-
"description": "Pixel data for an image. Must be an ImageData object (for example, from a
|
|
9559
|
+
"description": "Pixel data for an image. Must be an |ImageData| object (for example, from a |Canvas| element)."
|
|
9305
9560
|
},
|
|
9306
9561
|
{
|
|
9307
9562
|
"id": "ImageDataDictionary",
|
|
9308
9563
|
"type": "object",
|
|
9309
|
-
"description": "A
|
|
9564
|
+
"description": "A <em>dictionary object</em> to specify multiple |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 |ImageData| object, and <em>name</em> its size. Example: <literalinclude>includes/ImageDataDictionary.json<lang>JavaScript</lang></literalinclude>See the `MDN documentation about choosing icon sizes <|link-mdn-icon-size|>`__ for more information on this.",
|
|
9310
9565
|
"patternProperties": {
|
|
9311
9566
|
"^[1-9]\\d*$": {
|
|
9312
9567
|
"$ref": "ImageDataType"
|
|
@@ -9316,7 +9571,7 @@
|
|
|
9316
9571
|
{
|
|
9317
9572
|
"id": "OnClickData",
|
|
9318
9573
|
"type": "object",
|
|
9319
|
-
"description": "Information sent when a
|
|
9574
|
+
"description": "Information sent when a messageDisplayAction button is clicked.",
|
|
9320
9575
|
"properties": {
|
|
9321
9576
|
"modifiers": {
|
|
9322
9577
|
"type": "array",
|
|
@@ -9344,13 +9599,12 @@
|
|
|
9344
9599
|
{
|
|
9345
9600
|
"name": "setTitle",
|
|
9346
9601
|
"type": "function",
|
|
9347
|
-
"description": "Sets the title of the messageDisplayAction.
|
|
9602
|
+
"description": "Sets the title of the messageDisplayAction button. Is used as tooltip and as the label.",
|
|
9348
9603
|
"async": "callback",
|
|
9349
9604
|
"parameters": [
|
|
9350
9605
|
{
|
|
9351
9606
|
"name": "details",
|
|
9352
9607
|
"type": "object",
|
|
9353
|
-
"$import": "Details",
|
|
9354
9608
|
"properties": {
|
|
9355
9609
|
"title": {
|
|
9356
9610
|
"choices": [
|
|
@@ -9361,7 +9615,20 @@
|
|
|
9361
9615
|
"type": "null"
|
|
9362
9616
|
}
|
|
9363
9617
|
],
|
|
9364
|
-
"description": "
|
|
9618
|
+
"description": "A string the messageDisplayAction button should display as its label and when moused over. Cleared by setting it to <value>null</value> or an empty string (title defined the manifest will be used)."
|
|
9619
|
+
},
|
|
9620
|
+
"tabId": {
|
|
9621
|
+
"type": "integer",
|
|
9622
|
+
"optional": true,
|
|
9623
|
+
"minimum": 0,
|
|
9624
|
+
"description": "Sets the title only for the given tab."
|
|
9625
|
+
},
|
|
9626
|
+
"windowId": {
|
|
9627
|
+
"type": "integer",
|
|
9628
|
+
"optional": true,
|
|
9629
|
+
"minimum": -2,
|
|
9630
|
+
"unsupported": true,
|
|
9631
|
+
"description": "Will throw an error if used."
|
|
9365
9632
|
}
|
|
9366
9633
|
}
|
|
9367
9634
|
},
|
|
@@ -9376,12 +9643,27 @@
|
|
|
9376
9643
|
{
|
|
9377
9644
|
"name": "getTitle",
|
|
9378
9645
|
"type": "function",
|
|
9379
|
-
"description": "Gets the title of the messageDisplayAction.",
|
|
9646
|
+
"description": "Gets the title of the messageDisplayAction button.",
|
|
9380
9647
|
"async": "callback",
|
|
9381
9648
|
"parameters": [
|
|
9382
9649
|
{
|
|
9383
9650
|
"name": "details",
|
|
9384
|
-
"
|
|
9651
|
+
"type": "object",
|
|
9652
|
+
"properties": {
|
|
9653
|
+
"tabId": {
|
|
9654
|
+
"type": "integer",
|
|
9655
|
+
"optional": true,
|
|
9656
|
+
"minimum": 0,
|
|
9657
|
+
"description": "Specifies for which tab the title should be retrieved. If no tab is specified, the global value is retrieved."
|
|
9658
|
+
},
|
|
9659
|
+
"windowId": {
|
|
9660
|
+
"type": "integer",
|
|
9661
|
+
"optional": true,
|
|
9662
|
+
"minimum": -2,
|
|
9663
|
+
"unsupported": true,
|
|
9664
|
+
"description": "Will throw an error if used."
|
|
9665
|
+
}
|
|
9666
|
+
}
|
|
9385
9667
|
},
|
|
9386
9668
|
{
|
|
9387
9669
|
"type": "function",
|
|
@@ -9398,13 +9680,12 @@
|
|
|
9398
9680
|
{
|
|
9399
9681
|
"name": "setLabel",
|
|
9400
9682
|
"type": "function",
|
|
9401
|
-
"description": "Sets the label of the messageDisplayAction
|
|
9683
|
+
"description": "Sets the label of the messageDisplayAction button. Can be used to set different values for the tooltip (defined by the title) and the label. Additionally, the label can be set to an empty string, not showing any label at all.",
|
|
9402
9684
|
"async": "callback",
|
|
9403
9685
|
"parameters": [
|
|
9404
9686
|
{
|
|
9405
9687
|
"name": "details",
|
|
9406
9688
|
"type": "object",
|
|
9407
|
-
"$import": "Details",
|
|
9408
9689
|
"properties": {
|
|
9409
9690
|
"label": {
|
|
9410
9691
|
"choices": [
|
|
@@ -9415,7 +9696,20 @@
|
|
|
9415
9696
|
"type": "null"
|
|
9416
9697
|
}
|
|
9417
9698
|
],
|
|
9418
|
-
"description": "
|
|
9699
|
+
"description": "A string the messageDisplayAction button should use as its label, overriding the defined title. Can be set to an empty string to not display any label at all. If the containing toolbar is configured to display text only, its title will be used. Cleared by setting it to <value>null</value>."
|
|
9700
|
+
},
|
|
9701
|
+
"tabId": {
|
|
9702
|
+
"type": "integer",
|
|
9703
|
+
"optional": true,
|
|
9704
|
+
"minimum": 0,
|
|
9705
|
+
"description": "Sets the label only for the given tab."
|
|
9706
|
+
},
|
|
9707
|
+
"windowId": {
|
|
9708
|
+
"type": "integer",
|
|
9709
|
+
"optional": true,
|
|
9710
|
+
"minimum": -2,
|
|
9711
|
+
"unsupported": true,
|
|
9712
|
+
"description": "Will throw an error if used."
|
|
9419
9713
|
}
|
|
9420
9714
|
}
|
|
9421
9715
|
},
|
|
@@ -9430,12 +9724,27 @@
|
|
|
9430
9724
|
{
|
|
9431
9725
|
"name": "getLabel",
|
|
9432
9726
|
"type": "function",
|
|
9433
|
-
"description": "Gets the label of the messageDisplayAction.",
|
|
9727
|
+
"description": "Gets the label of the messageDisplayAction button.",
|
|
9434
9728
|
"async": "callback",
|
|
9435
9729
|
"parameters": [
|
|
9436
9730
|
{
|
|
9437
9731
|
"name": "details",
|
|
9438
|
-
"
|
|
9732
|
+
"type": "object",
|
|
9733
|
+
"properties": {
|
|
9734
|
+
"tabId": {
|
|
9735
|
+
"type": "integer",
|
|
9736
|
+
"optional": true,
|
|
9737
|
+
"minimum": 0,
|
|
9738
|
+
"description": "Specifies for which tab the label should be retrieved. If no tab is specified, the global label is retrieved."
|
|
9739
|
+
},
|
|
9740
|
+
"windowId": {
|
|
9741
|
+
"type": "integer",
|
|
9742
|
+
"optional": true,
|
|
9743
|
+
"minimum": -2,
|
|
9744
|
+
"unsupported": true,
|
|
9745
|
+
"description": "Will throw an error if used."
|
|
9746
|
+
}
|
|
9747
|
+
}
|
|
9439
9748
|
},
|
|
9440
9749
|
{
|
|
9441
9750
|
"type": "function",
|
|
@@ -9452,13 +9761,12 @@
|
|
|
9452
9761
|
{
|
|
9453
9762
|
"name": "setIcon",
|
|
9454
9763
|
"type": "function",
|
|
9455
|
-
"description": "Sets the icon for the messageDisplayAction
|
|
9764
|
+
"description": "Sets the icon for the messageDisplayAction button. Either the ``path`` or the ``imageData`` property must be specified.",
|
|
9456
9765
|
"async": "callback",
|
|
9457
9766
|
"parameters": [
|
|
9458
9767
|
{
|
|
9459
9768
|
"name": "details",
|
|
9460
9769
|
"type": "object",
|
|
9461
|
-
"$import": "Details",
|
|
9462
9770
|
"properties": {
|
|
9463
9771
|
"imageData": {
|
|
9464
9772
|
"choices": [
|
|
@@ -9470,19 +9778,25 @@
|
|
|
9470
9778
|
}
|
|
9471
9779
|
],
|
|
9472
9780
|
"optional": true,
|
|
9473
|
-
"description": "
|
|
9781
|
+
"description": "The image data for one or more icons for the composeAction button."
|
|
9474
9782
|
},
|
|
9475
9783
|
"path": {
|
|
9476
|
-
"
|
|
9477
|
-
|
|
9478
|
-
|
|
9479
|
-
|
|
9480
|
-
|
|
9481
|
-
|
|
9482
|
-
|
|
9483
|
-
|
|
9784
|
+
"$ref": "manifest.IconPath",
|
|
9785
|
+
"optional": true,
|
|
9786
|
+
"description": "The paths to one or more icons for the messageDisplayAction button."
|
|
9787
|
+
},
|
|
9788
|
+
"tabId": {
|
|
9789
|
+
"type": "integer",
|
|
9790
|
+
"optional": true,
|
|
9791
|
+
"minimum": 0,
|
|
9792
|
+
"description": "Sets the icon only for the given tab."
|
|
9793
|
+
},
|
|
9794
|
+
"windowId": {
|
|
9795
|
+
"type": "integer",
|
|
9484
9796
|
"optional": true,
|
|
9485
|
-
"
|
|
9797
|
+
"minimum": -2,
|
|
9798
|
+
"unsupported": true,
|
|
9799
|
+
"description": "Will throw an error if used."
|
|
9486
9800
|
}
|
|
9487
9801
|
}
|
|
9488
9802
|
},
|
|
@@ -9497,13 +9811,12 @@
|
|
|
9497
9811
|
{
|
|
9498
9812
|
"name": "setPopup",
|
|
9499
9813
|
"type": "function",
|
|
9500
|
-
"description": "Sets the html document to be opened as a popup when the user clicks on the messageDisplayAction
|
|
9814
|
+
"description": "Sets the html document to be opened as a popup when the user clicks on the messageDisplayAction button.",
|
|
9501
9815
|
"async": "callback",
|
|
9502
9816
|
"parameters": [
|
|
9503
9817
|
{
|
|
9504
9818
|
"name": "details",
|
|
9505
9819
|
"type": "object",
|
|
9506
|
-
"$import": "Details",
|
|
9507
9820
|
"properties": {
|
|
9508
9821
|
"popup": {
|
|
9509
9822
|
"choices": [
|
|
@@ -9514,7 +9827,20 @@
|
|
|
9514
9827
|
"type": "null"
|
|
9515
9828
|
}
|
|
9516
9829
|
],
|
|
9517
|
-
"description": "The html file to show in a popup.
|
|
9830
|
+
"description": "The html file to show in a popup. Can be set to an empty string to not open a popup. Cleared by setting it to <value>null</value> (action will use the popup value defined in the manifest)."
|
|
9831
|
+
},
|
|
9832
|
+
"tabId": {
|
|
9833
|
+
"type": "integer",
|
|
9834
|
+
"optional": true,
|
|
9835
|
+
"minimum": 0,
|
|
9836
|
+
"description": "Sets the popup only for the given tab."
|
|
9837
|
+
},
|
|
9838
|
+
"windowId": {
|
|
9839
|
+
"type": "integer",
|
|
9840
|
+
"optional": true,
|
|
9841
|
+
"minimum": -2,
|
|
9842
|
+
"unsupported": true,
|
|
9843
|
+
"description": "Will throw an error if used."
|
|
9518
9844
|
}
|
|
9519
9845
|
}
|
|
9520
9846
|
},
|
|
@@ -9529,12 +9855,27 @@
|
|
|
9529
9855
|
{
|
|
9530
9856
|
"name": "getPopup",
|
|
9531
9857
|
"type": "function",
|
|
9532
|
-
"description": "Gets the html document set as the popup for this messageDisplayAction.",
|
|
9858
|
+
"description": "Gets the html document set as the popup for this messageDisplayAction button.",
|
|
9533
9859
|
"async": "callback",
|
|
9534
9860
|
"parameters": [
|
|
9535
9861
|
{
|
|
9536
9862
|
"name": "details",
|
|
9537
|
-
"
|
|
9863
|
+
"type": "object",
|
|
9864
|
+
"properties": {
|
|
9865
|
+
"tabId": {
|
|
9866
|
+
"type": "integer",
|
|
9867
|
+
"optional": true,
|
|
9868
|
+
"minimum": 0,
|
|
9869
|
+
"description": "Specifies for which tab the popup document should be retrieved. If no tab is specified, the global value is retrieved."
|
|
9870
|
+
},
|
|
9871
|
+
"windowId": {
|
|
9872
|
+
"type": "integer",
|
|
9873
|
+
"optional": true,
|
|
9874
|
+
"minimum": -2,
|
|
9875
|
+
"unsupported": true,
|
|
9876
|
+
"description": "Will throw an error if used."
|
|
9877
|
+
}
|
|
9878
|
+
}
|
|
9538
9879
|
},
|
|
9539
9880
|
{
|
|
9540
9881
|
"type": "function",
|
|
@@ -9551,13 +9892,12 @@
|
|
|
9551
9892
|
{
|
|
9552
9893
|
"name": "setBadgeText",
|
|
9553
9894
|
"type": "function",
|
|
9554
|
-
"description": "Sets the badge text for the messageDisplayAction. The badge is displayed on top of the icon.",
|
|
9895
|
+
"description": "Sets the badge text for the messageDisplayAction button. The badge is displayed on top of the icon.",
|
|
9555
9896
|
"async": "callback",
|
|
9556
9897
|
"parameters": [
|
|
9557
9898
|
{
|
|
9558
9899
|
"name": "details",
|
|
9559
9900
|
"type": "object",
|
|
9560
|
-
"$import": "Details",
|
|
9561
9901
|
"properties": {
|
|
9562
9902
|
"text": {
|
|
9563
9903
|
"choices": [
|
|
@@ -9568,7 +9908,20 @@
|
|
|
9568
9908
|
"type": "null"
|
|
9569
9909
|
}
|
|
9570
9910
|
],
|
|
9571
|
-
"description": "Any number of characters can be passed, but only about four can fit in the space."
|
|
9911
|
+
"description": "Any number of characters can be passed, but only about four can fit in the space. Cleared by setting it to <value>null</value> or an empty string."
|
|
9912
|
+
},
|
|
9913
|
+
"tabId": {
|
|
9914
|
+
"type": "integer",
|
|
9915
|
+
"optional": true,
|
|
9916
|
+
"minimum": 0,
|
|
9917
|
+
"description": "Sets the badge text only for the given tab."
|
|
9918
|
+
},
|
|
9919
|
+
"windowId": {
|
|
9920
|
+
"type": "integer",
|
|
9921
|
+
"optional": true,
|
|
9922
|
+
"minimum": -2,
|
|
9923
|
+
"unsupported": true,
|
|
9924
|
+
"description": "Will throw an error if used."
|
|
9572
9925
|
}
|
|
9573
9926
|
}
|
|
9574
9927
|
},
|
|
@@ -9583,12 +9936,27 @@
|
|
|
9583
9936
|
{
|
|
9584
9937
|
"name": "getBadgeText",
|
|
9585
9938
|
"type": "function",
|
|
9586
|
-
"description": "Gets the badge text of the messageDisplayAction
|
|
9939
|
+
"description": "Gets the badge text of the messageDisplayAction button.",
|
|
9587
9940
|
"async": "callback",
|
|
9588
9941
|
"parameters": [
|
|
9589
9942
|
{
|
|
9590
9943
|
"name": "details",
|
|
9591
|
-
"
|
|
9944
|
+
"type": "object",
|
|
9945
|
+
"properties": {
|
|
9946
|
+
"tabId": {
|
|
9947
|
+
"type": "integer",
|
|
9948
|
+
"optional": true,
|
|
9949
|
+
"minimum": 0,
|
|
9950
|
+
"description": "Specifies for which tab the badge text should be retrieved. If no tab is specified, the global label is retrieved."
|
|
9951
|
+
},
|
|
9952
|
+
"windowId": {
|
|
9953
|
+
"type": "integer",
|
|
9954
|
+
"optional": true,
|
|
9955
|
+
"minimum": -2,
|
|
9956
|
+
"unsupported": true,
|
|
9957
|
+
"description": "Will throw an error if used."
|
|
9958
|
+
}
|
|
9959
|
+
}
|
|
9592
9960
|
},
|
|
9593
9961
|
{
|
|
9594
9962
|
"type": "function",
|
|
@@ -9611,10 +9979,8 @@
|
|
|
9611
9979
|
{
|
|
9612
9980
|
"name": "details",
|
|
9613
9981
|
"type": "object",
|
|
9614
|
-
"$import": "Details",
|
|
9615
9982
|
"properties": {
|
|
9616
9983
|
"color": {
|
|
9617
|
-
"description": "An array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is <code>[255, 0, 0, 255]</code>. Can also be a string with a CSS value, with opaque red being <code>#FF0000</code> or <code>#F00</code>.",
|
|
9618
9984
|
"choices": [
|
|
9619
9985
|
{
|
|
9620
9986
|
"type": "string"
|
|
@@ -9625,7 +9991,21 @@
|
|
|
9625
9991
|
{
|
|
9626
9992
|
"type": "null"
|
|
9627
9993
|
}
|
|
9628
|
-
]
|
|
9994
|
+
],
|
|
9995
|
+
"description": "The color to use as background in the badge. Cleared by setting it to <value>null</value> or an empty string."
|
|
9996
|
+
},
|
|
9997
|
+
"tabId": {
|
|
9998
|
+
"type": "integer",
|
|
9999
|
+
"optional": true,
|
|
10000
|
+
"minimum": 0,
|
|
10001
|
+
"description": "Sets the background color for the badge only for the given tab."
|
|
10002
|
+
},
|
|
10003
|
+
"windowId": {
|
|
10004
|
+
"type": "integer",
|
|
10005
|
+
"optional": true,
|
|
10006
|
+
"minimum": -2,
|
|
10007
|
+
"unsupported": true,
|
|
10008
|
+
"description": "Will throw an error if used."
|
|
9629
10009
|
}
|
|
9630
10010
|
}
|
|
9631
10011
|
},
|
|
@@ -9640,12 +10020,27 @@
|
|
|
9640
10020
|
{
|
|
9641
10021
|
"name": "getBadgeBackgroundColor",
|
|
9642
10022
|
"type": "function",
|
|
9643
|
-
"description": "Gets the background color of the messageDisplayAction.",
|
|
10023
|
+
"description": "Gets the badge background color of the messageDisplayAction button.",
|
|
9644
10024
|
"async": "callback",
|
|
9645
10025
|
"parameters": [
|
|
9646
10026
|
{
|
|
9647
10027
|
"name": "details",
|
|
9648
|
-
"
|
|
10028
|
+
"type": "object",
|
|
10029
|
+
"properties": {
|
|
10030
|
+
"tabId": {
|
|
10031
|
+
"type": "integer",
|
|
10032
|
+
"optional": true,
|
|
10033
|
+
"minimum": 0,
|
|
10034
|
+
"description": "Specifies for which tab the badge background color should be retrieved. If no tab is specified, the global label is retrieved."
|
|
10035
|
+
},
|
|
10036
|
+
"windowId": {
|
|
10037
|
+
"type": "integer",
|
|
10038
|
+
"optional": true,
|
|
10039
|
+
"minimum": -2,
|
|
10040
|
+
"unsupported": true,
|
|
10041
|
+
"description": "Will throw an error if used."
|
|
10042
|
+
}
|
|
10043
|
+
}
|
|
9649
10044
|
},
|
|
9650
10045
|
{
|
|
9651
10046
|
"type": "function",
|
|
@@ -9662,7 +10057,7 @@
|
|
|
9662
10057
|
{
|
|
9663
10058
|
"name": "enable",
|
|
9664
10059
|
"type": "function",
|
|
9665
|
-
"description": "Enables the messageDisplayAction for a tab. By default, a messageDisplayAction is enabled.",
|
|
10060
|
+
"description": "Enables the messageDisplayAction button for a tab. By default, a messageDisplayAction button is enabled.",
|
|
9666
10061
|
"async": "callback",
|
|
9667
10062
|
"parameters": [
|
|
9668
10063
|
{
|
|
@@ -9670,7 +10065,7 @@
|
|
|
9670
10065
|
"optional": true,
|
|
9671
10066
|
"name": "tabId",
|
|
9672
10067
|
"minimum": 0,
|
|
9673
|
-
"description": "The id of the tab for which you want to modify the messageDisplayAction."
|
|
10068
|
+
"description": "The id of the tab for which you want to modify the messageDisplayAction button."
|
|
9674
10069
|
},
|
|
9675
10070
|
{
|
|
9676
10071
|
"type": "function",
|
|
@@ -9683,7 +10078,7 @@
|
|
|
9683
10078
|
{
|
|
9684
10079
|
"name": "disable",
|
|
9685
10080
|
"type": "function",
|
|
9686
|
-
"description": "Disables the messageDisplayAction for a tab.",
|
|
10081
|
+
"description": "Disables the messageDisplayAction button for a tab.",
|
|
9687
10082
|
"async": "callback",
|
|
9688
10083
|
"parameters": [
|
|
9689
10084
|
{
|
|
@@ -9691,7 +10086,7 @@
|
|
|
9691
10086
|
"optional": true,
|
|
9692
10087
|
"name": "tabId",
|
|
9693
10088
|
"minimum": 0,
|
|
9694
|
-
"description": "The id of the tab for which you want to modify the messageDisplayAction."
|
|
10089
|
+
"description": "The id of the tab for which you want to modify the messageDisplayAction button."
|
|
9695
10090
|
},
|
|
9696
10091
|
{
|
|
9697
10092
|
"type": "function",
|
|
@@ -9704,12 +10099,27 @@
|
|
|
9704
10099
|
{
|
|
9705
10100
|
"name": "isEnabled",
|
|
9706
10101
|
"type": "function",
|
|
9707
|
-
"description": "Checks whether the messageDisplayAction is enabled.",
|
|
10102
|
+
"description": "Checks whether the messageDisplayAction button is enabled.",
|
|
9708
10103
|
"async": "callback",
|
|
9709
10104
|
"parameters": [
|
|
9710
10105
|
{
|
|
9711
10106
|
"name": "details",
|
|
9712
|
-
"
|
|
10107
|
+
"type": "object",
|
|
10108
|
+
"properties": {
|
|
10109
|
+
"tabId": {
|
|
10110
|
+
"type": "integer",
|
|
10111
|
+
"optional": true,
|
|
10112
|
+
"minimum": 0,
|
|
10113
|
+
"description": "Specifies for which tab the state should be retrieved. If no tab is specified, the global value is retrieved."
|
|
10114
|
+
},
|
|
10115
|
+
"windowId": {
|
|
10116
|
+
"type": "integer",
|
|
10117
|
+
"optional": true,
|
|
10118
|
+
"minimum": -2,
|
|
10119
|
+
"unsupported": true,
|
|
10120
|
+
"description": "Will throw an error if used."
|
|
10121
|
+
}
|
|
10122
|
+
}
|
|
9713
10123
|
},
|
|
9714
10124
|
{
|
|
9715
10125
|
"type": "function",
|
|
@@ -9727,7 +10137,7 @@
|
|
|
9727
10137
|
"name": "openPopup",
|
|
9728
10138
|
"type": "function",
|
|
9729
10139
|
"requireUserInput": true,
|
|
9730
|
-
"description": "Opens the
|
|
10140
|
+
"description": "Opens the action's popup window in the active window.",
|
|
9731
10141
|
"async": true,
|
|
9732
10142
|
"parameters": []
|
|
9733
10143
|
}
|
|
@@ -9736,7 +10146,7 @@
|
|
|
9736
10146
|
{
|
|
9737
10147
|
"name": "onClicked",
|
|
9738
10148
|
"type": "function",
|
|
9739
|
-
"description": "Fired when a messageDisplayAction
|
|
10149
|
+
"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 `restrictions <|link-user-input-restrictions|>`__ apply.",
|
|
9740
10150
|
"parameters": [
|
|
9741
10151
|
{
|
|
9742
10152
|
"name": "tab",
|
|
@@ -9810,7 +10220,7 @@
|
|
|
9810
10220
|
},
|
|
9811
10221
|
"flagged": {
|
|
9812
10222
|
"type": "boolean",
|
|
9813
|
-
"description": "Whether this message is flagged (a.k.a.
|
|
10223
|
+
"description": "Whether this message is flagged (a.k.a. starred)."
|
|
9814
10224
|
},
|
|
9815
10225
|
"folder": {
|
|
9816
10226
|
"$ref": "folders.MailFolder",
|
|
@@ -9822,7 +10232,7 @@
|
|
|
9822
10232
|
"description": "The message-id header of the message."
|
|
9823
10233
|
},
|
|
9824
10234
|
"headersOnly": {
|
|
9825
|
-
"description": "Some account types (for example
|
|
10235
|
+
"description": "Some account types (for example <value>pop3</value>) allow to download only the headers of the message, but not its body. The body of such messages will not be available.",
|
|
9826
10236
|
"type": "boolean"
|
|
9827
10237
|
},
|
|
9828
10238
|
"id": {
|
|
@@ -9830,12 +10240,12 @@
|
|
|
9830
10240
|
"minimum": 1
|
|
9831
10241
|
},
|
|
9832
10242
|
"junk": {
|
|
9833
|
-
"description": "Whether the message has been marked as junk. Always
|
|
10243
|
+
"description": "Whether the message has been marked as junk. Always <value>false</value> for news/nntp messages and external messages.",
|
|
9834
10244
|
"type": "boolean"
|
|
9835
10245
|
},
|
|
9836
10246
|
"junkScore": {
|
|
9837
10247
|
"type": "integer",
|
|
9838
|
-
"description": "The junk score associated with the message. Always
|
|
10248
|
+
"description": "The junk score associated with the message. Always <value>0</value> for news/nntp messages and external messages.",
|
|
9839
10249
|
"minimum": 0,
|
|
9840
10250
|
"maximum": 100
|
|
9841
10251
|
},
|
|
@@ -9905,7 +10315,7 @@
|
|
|
9905
10315
|
},
|
|
9906
10316
|
"headers": {
|
|
9907
10317
|
"type": "object",
|
|
9908
|
-
"description": "
|
|
10318
|
+
"description": "A <em>dictionary object</em> of 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>",
|
|
9909
10319
|
"optional": true,
|
|
9910
10320
|
"additionalProperties": {
|
|
9911
10321
|
"type": "array",
|
|
@@ -9922,7 +10332,7 @@
|
|
|
9922
10332
|
"partName": {
|
|
9923
10333
|
"type": "string",
|
|
9924
10334
|
"optional": true,
|
|
9925
|
-
"description": "The identifier of this part, used in :ref:`messages.getAttachmentFile"
|
|
10335
|
+
"description": "The identifier of this part, used in :ref:`messages.getAttachmentFile`"
|
|
9926
10336
|
},
|
|
9927
10337
|
"parts": {
|
|
9928
10338
|
"type": "array",
|
|
@@ -9935,7 +10345,7 @@
|
|
|
9935
10345
|
"size": {
|
|
9936
10346
|
"type": "integer",
|
|
9937
10347
|
"optional": true,
|
|
9938
|
-
"description": "The size of this part. The size of
|
|
10348
|
+
"description": "The size of this part. The size of <em>message/*</em> parts is not the actual message size (on disc), but the total size of its decoded body parts, excluding headers."
|
|
9939
10349
|
}
|
|
9940
10350
|
}
|
|
9941
10351
|
},
|
|
@@ -9946,7 +10356,7 @@
|
|
|
9946
10356
|
"properties": {
|
|
9947
10357
|
"flagged": {
|
|
9948
10358
|
"type": "boolean",
|
|
9949
|
-
"description": "Whether the message is flagged (a.k.a
|
|
10359
|
+
"description": "Whether the message is flagged (a.k.a starred).",
|
|
9950
10360
|
"optional": true
|
|
9951
10361
|
},
|
|
9952
10362
|
"junk": {
|
|
@@ -10003,7 +10413,7 @@
|
|
|
10003
10413
|
"properties": {
|
|
10004
10414
|
"tags": {
|
|
10005
10415
|
"type": "object",
|
|
10006
|
-
"description": "
|
|
10416
|
+
"description": "A <em>dictionary object</em> with one or more filter condition as <em>key-value</em> pairs, the <em>key</em> being the tag to filter on, and the <em>value</em> being a boolean expression, requesting whether a message must include (<value>true</value>) or exclude (<value>false</value>) the tag. For a list of available tags, call the :ref:`messages.listTags` method.",
|
|
10007
10417
|
"patternProperties": {
|
|
10008
10418
|
".*": {
|
|
10009
10419
|
"type": "boolean"
|
|
@@ -10229,7 +10639,7 @@
|
|
|
10229
10639
|
{
|
|
10230
10640
|
"name": "getRaw",
|
|
10231
10641
|
"type": "function",
|
|
10232
|
-
"description": "Returns the unmodified source of a message as a `binary string
|
|
10642
|
+
"description": "Returns the unmodified source of a message as a `binary string <|link-binary-string|>`__, which is a simple series of 8-bit values. Throws if the message could not be read, for example due to network issues. If the message contains non-ASCII characters, the body parts in the binary string cannot be read directly and must be decoded according to their character sets. Use :ref:`messages.getFull` to get the correctly decoded parts. Manually decoding the raw message is probably too error-prone, especially if the message contains MIME parts with different character set encodings or attachments.\n\nTo get a readable version of the raw message as it appears in Thunderbird's message source view, it may be sufficient to decode the message according to the character set specified in its main `content-type <|link-content-type|>`__ header (example: <value>text/html; charset=UTF-8</value>) using the following function (see MDN for `supported input encodings <|link-input-encoding|>`__): <literalinclude>includes/messages/decodeBinaryString.js<lang>JavaScript</lang></literalinclude>",
|
|
10233
10643
|
"async": "callback",
|
|
10234
10644
|
"parameters": [
|
|
10235
10645
|
{
|
|
@@ -10276,7 +10686,7 @@
|
|
|
10276
10686
|
{
|
|
10277
10687
|
"name": "getAttachmentFile",
|
|
10278
10688
|
"type": "function",
|
|
10279
|
-
"description": "Gets the content of a :ref:`messages.MessageAttachment` as a
|
|
10689
|
+
"description": "Gets the content of a :ref:`messages.MessageAttachment` as a |File| object.",
|
|
10280
10690
|
"async": "callback",
|
|
10281
10691
|
"parameters": [
|
|
10282
10692
|
{
|
|
@@ -10320,7 +10730,7 @@
|
|
|
10320
10730
|
"author": {
|
|
10321
10731
|
"type": "string",
|
|
10322
10732
|
"optional": true,
|
|
10323
|
-
"description": "Returns only messages with this value matching the author. The search value is a single email address, a name or a combination (e.g.:
|
|
10733
|
+
"description": "Returns only messages with this value matching the author. The search value is a single email address, a name or a combination (e.g.: <value>Name <user@domain.org></value>). The address part of the search value (if provided) must match the author's address completely. The name part of the search value (if provided) must match the author's name partially. All matches are done case-insensitive."
|
|
10324
10734
|
},
|
|
10325
10735
|
"body": {
|
|
10326
10736
|
"type": "string",
|
|
@@ -10365,7 +10775,7 @@
|
|
|
10365
10775
|
"recipients": {
|
|
10366
10776
|
"type": "string",
|
|
10367
10777
|
"optional": true,
|
|
10368
|
-
"description": "Returns only messages whose recipients match all specified addresses. The search value is a semicolon separated list of email addresses, names or combinations (e.g.:
|
|
10778
|
+
"description": "Returns only messages whose recipients match all specified addresses. The search value is a semicolon separated list of email addresses, names or combinations (e.g.: <value>Name <user@domain.org></value>). For a match, all specified addresses must equal a recipient's address completely and all specified names must match a recipient's name partially. All matches are done case-insensitive."
|
|
10369
10779
|
},
|
|
10370
10780
|
"subject": {
|
|
10371
10781
|
"type": "string",
|
|
@@ -10409,7 +10819,7 @@
|
|
|
10409
10819
|
{
|
|
10410
10820
|
"name": "update",
|
|
10411
10821
|
"type": "function",
|
|
10412
|
-
"description": "Marks or unmarks a message as junk, read, flagged, or tagged. Updating external messages will throw an
|
|
10822
|
+
"description": "Marks or unmarks a message as junk, read, flagged, or tagged. Updating external messages will throw an <em>ExtensionError</em>.",
|
|
10413
10823
|
"async": true,
|
|
10414
10824
|
"parameters": [
|
|
10415
10825
|
{
|
|
@@ -10426,7 +10836,7 @@
|
|
|
10426
10836
|
{
|
|
10427
10837
|
"name": "move",
|
|
10428
10838
|
"type": "function",
|
|
10429
|
-
"description": "Moves messages to a specified folder. If the messages cannot be removed from the source folder, they will be copied instead of moved. Moving external messages will throw an
|
|
10839
|
+
"description": "Moves messages to a specified folder. If the messages cannot be removed from the source folder, they will be copied instead of moved. Moving external messages will throw an <em>ExtensionError</em>.",
|
|
10430
10840
|
"async": true,
|
|
10431
10841
|
"permissions": [
|
|
10432
10842
|
"accountsRead",
|
|
@@ -10478,7 +10888,7 @@
|
|
|
10478
10888
|
{
|
|
10479
10889
|
"name": "delete",
|
|
10480
10890
|
"type": "function",
|
|
10481
|
-
"description": "Deletes messages permanently, or moves them to the trash folder (honoring the account's deletion behavior settings). Deleting external messages will throw an
|
|
10891
|
+
"description": "Deletes messages permanently, or moves them to the trash folder (honoring the account's deletion behavior settings). Deleting external messages will throw an <em>ExtensionError</em>. The ``skipTrash`` parameter allows immediate permanent deletion, bypassing the trash folder.\n**Note**: Consider using :ref:`messages.move` to manually move messages to the account's trash folder, instead of requesting the overly powerful permission to actually delete messages. The account's trash folder can be extracted as follows: <literalinclude>includes/messages/getTrash.js<lang>JavaScript</lang></literalinclude>",
|
|
10482
10892
|
"async": true,
|
|
10483
10893
|
"permissions": [
|
|
10484
10894
|
"messagesDelete"
|
|
@@ -10542,7 +10952,7 @@
|
|
|
10542
10952
|
{
|
|
10543
10953
|
"name": "archive",
|
|
10544
10954
|
"type": "function",
|
|
10545
|
-
"description": "Archives messages using the current settings. Archiving external messages will throw an
|
|
10955
|
+
"description": "Archives messages using the current settings. Archiving external messages will throw an <em>ExtensionError</em>.",
|
|
10546
10956
|
"async": true,
|
|
10547
10957
|
"permissions": [
|
|
10548
10958
|
"messagesMove"
|
|
@@ -10679,7 +11089,7 @@
|
|
|
10679
11089
|
}
|
|
10680
11090
|
],
|
|
10681
11091
|
"optional": true,
|
|
10682
|
-
"description": "Sets the background color of the badge. Can be specified as an array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is <
|
|
11092
|
+
"description": "Sets the background color of the badge. Can be specified as an array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is <value>[255, 0, 0, 255]</value>. Can also be a string with an HTML color name (<value>red</value>) or a HEX color value (<value>#FF0000</value> or <value>#F00</value>). Reset when set to an empty string."
|
|
10683
11093
|
},
|
|
10684
11094
|
"badgeText": {
|
|
10685
11095
|
"type": "string",
|
|
@@ -10696,7 +11106,7 @@
|
|
|
10696
11106
|
}
|
|
10697
11107
|
],
|
|
10698
11108
|
"optional": true,
|
|
10699
|
-
"description": "
|
|
11109
|
+
"description": "The paths to one or more icons for the button in the spaces toolbar. Defaults to the extension icon, if set to an empty string."
|
|
10700
11110
|
},
|
|
10701
11111
|
"themeIcons": {
|
|
10702
11112
|
"type": "array",
|
|
@@ -10704,7 +11114,7 @@
|
|
|
10704
11114
|
"items": {
|
|
10705
11115
|
"$ref": "manifest.ThemeIcons"
|
|
10706
11116
|
},
|
|
10707
|
-
"description": "Specifies dark and light icons for the spaces toolbar button to be used with themes: The ``light`` icons will be used on dark backgrounds and vice versa. At least the set for
|
|
11117
|
+
"description": "Specifies dark and light icons for the spaces toolbar button to be used with themes: The ``light`` icons will be used on dark backgrounds and vice versa. At least the set for <em>16px</em> icons should be specified. The set for <em>32px</em> icons will be used on screens with a very high pixel density, if specified."
|
|
10708
11118
|
},
|
|
10709
11119
|
"title": {
|
|
10710
11120
|
"type": "string",
|
|
@@ -10714,13 +11124,13 @@
|
|
|
10714
11124
|
"url": {
|
|
10715
11125
|
"type": "string",
|
|
10716
11126
|
"optional": true,
|
|
10717
|
-
"description": "The page url, loaded into a tab when the button is clicked. Supported are
|
|
11127
|
+
"description": "The page url, loaded into a tab when the button is clicked. Supported are <value>https://</value> and <value>http://</value> links, as well as links to WebExtension pages."
|
|
10718
11128
|
}
|
|
10719
11129
|
}
|
|
10720
11130
|
},
|
|
10721
11131
|
{
|
|
10722
11132
|
"id": "ColorArray",
|
|
10723
|
-
"description": "An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is <
|
|
11133
|
+
"description": "An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is <value>[255, 0, 0, 255]</value>.",
|
|
10724
11134
|
"type": "array",
|
|
10725
11135
|
"items": {
|
|
10726
11136
|
"type": "integer",
|
|
@@ -10818,7 +11228,7 @@
|
|
|
10818
11228
|
},
|
|
10819
11229
|
{
|
|
10820
11230
|
"namespace": "tabs",
|
|
10821
|
-
"description": "
|
|
11231
|
+
"description": "The tabs API supports creating, modifying and interacting with tabs in Thunderbird windows.",
|
|
10822
11232
|
"types": [
|
|
10823
11233
|
{
|
|
10824
11234
|
"id": "Tab",
|
|
@@ -10828,7 +11238,7 @@
|
|
|
10828
11238
|
"type": "integer",
|
|
10829
11239
|
"minimum": -1,
|
|
10830
11240
|
"optional": true,
|
|
10831
|
-
"description": "The ID of the tab. Tab IDs are unique within a
|
|
11241
|
+
"description": "The ID of the tab. Tab IDs are unique within a session. Under some circumstances a Tab may not be assigned an ID. Tab ID can also be set to :ref:`tabs.TAB_ID_NONE` for apps and devtools windows."
|
|
10832
11242
|
},
|
|
10833
11243
|
"index": {
|
|
10834
11244
|
"type": "integer",
|
|
@@ -10882,7 +11292,7 @@
|
|
|
10882
11292
|
"status": {
|
|
10883
11293
|
"type": "string",
|
|
10884
11294
|
"optional": true,
|
|
10885
|
-
"description": "Either <
|
|
11295
|
+
"description": "Either <value>loading</value> or <value>complete</value>."
|
|
10886
11296
|
},
|
|
10887
11297
|
"width": {
|
|
10888
11298
|
"type": "integer",
|
|
@@ -10958,7 +11368,7 @@
|
|
|
10958
11368
|
"properties": {
|
|
10959
11369
|
"urls": {
|
|
10960
11370
|
"type": "array",
|
|
10961
|
-
"description": "A list of URLs or URL patterns. Events that cannot match any of the URLs will be filtered out.
|
|
11371
|
+
"description": "A list of URLs or URL patterns. Events that cannot match any of the URLs will be filtered out. Filtering with urls requires the <permission>tabs</permission> or <permission>activeTab</permission> permission.",
|
|
10962
11372
|
"optional": true,
|
|
10963
11373
|
"items": {
|
|
10964
11374
|
"type": "string"
|
|
@@ -10988,7 +11398,7 @@
|
|
|
10988
11398
|
"properties": {
|
|
10989
11399
|
"TAB_ID_NONE": {
|
|
10990
11400
|
"value": -1,
|
|
10991
|
-
"description": "An ID which represents the absence of a
|
|
11401
|
+
"description": "An ID which represents the absence of a tab."
|
|
10992
11402
|
}
|
|
10993
11403
|
},
|
|
10994
11404
|
"functions": [
|
|
@@ -11037,7 +11447,7 @@
|
|
|
11037
11447
|
{
|
|
11038
11448
|
"name": "connect",
|
|
11039
11449
|
"type": "function",
|
|
11040
|
-
"description": "Connects to the content script(s) in the specified tab. The `runtime.onConnect
|
|
11450
|
+
"description": "Connects to the content script(s) in the specified tab. The `runtime.onConnect <|link-runtime-on-connect|>`__ event is fired in each content script running in the specified tab for the current extension. For more details, see `Content Script Messaging <|link-content-scripts|>`__.",
|
|
11041
11451
|
"parameters": [
|
|
11042
11452
|
{
|
|
11043
11453
|
"type": "integer",
|
|
@@ -11057,7 +11467,7 @@
|
|
|
11057
11467
|
"type": "integer",
|
|
11058
11468
|
"optional": true,
|
|
11059
11469
|
"minimum": 0,
|
|
11060
|
-
"description": "Open a port to a specific frame identified by
|
|
11470
|
+
"description": "Open a port to a specific frame identified by ``frameId`` instead of all frames in the tab."
|
|
11061
11471
|
}
|
|
11062
11472
|
},
|
|
11063
11473
|
"optional": true
|
|
@@ -11071,7 +11481,7 @@
|
|
|
11071
11481
|
{
|
|
11072
11482
|
"name": "sendMessage",
|
|
11073
11483
|
"type": "function",
|
|
11074
|
-
"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.
|
|
11484
|
+
"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 `runtime.onMessage <|link-runtime-on-message|>`__ event is fired in each content script running in the specified tab for the current extension.",
|
|
11075
11485
|
"async": "responseCallback",
|
|
11076
11486
|
"parameters": [
|
|
11077
11487
|
{
|
|
@@ -11091,7 +11501,7 @@
|
|
|
11091
11501
|
"type": "integer",
|
|
11092
11502
|
"optional": true,
|
|
11093
11503
|
"minimum": 0,
|
|
11094
|
-
"description": "Send a message to a specific frame identified by
|
|
11504
|
+
"description": "Send a message to a specific frame identified by ``frameId`` instead of all frames in the tab."
|
|
11095
11505
|
}
|
|
11096
11506
|
},
|
|
11097
11507
|
"optional": true
|
|
@@ -11104,7 +11514,7 @@
|
|
|
11104
11514
|
{
|
|
11105
11515
|
"name": "response",
|
|
11106
11516
|
"type": "any",
|
|
11107
|
-
"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 `runtime.lastError
|
|
11517
|
+
"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 `runtime.lastError <|link-runtime-last-error|>`__ will be set to the error message."
|
|
11108
11518
|
}
|
|
11109
11519
|
]
|
|
11110
11520
|
}
|
|
@@ -11113,7 +11523,7 @@
|
|
|
11113
11523
|
{
|
|
11114
11524
|
"name": "create",
|
|
11115
11525
|
"type": "function",
|
|
11116
|
-
"description": "Creates a new content tab. Use the :ref:`messageDisplay_api` to open messages.",
|
|
11526
|
+
"description": "Creates a new content tab. Use the :ref:`messageDisplay_api` to open messages. Only supported in <value>normal</value> windows.",
|
|
11117
11527
|
"async": "callback",
|
|
11118
11528
|
"parameters": [
|
|
11119
11529
|
{
|
|
@@ -11136,19 +11546,19 @@
|
|
|
11136
11546
|
"url": {
|
|
11137
11547
|
"type": "string",
|
|
11138
11548
|
"optional": true,
|
|
11139
|
-
"description": "The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e.
|
|
11549
|
+
"description": "The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. <value>http://www.google.com</value>, not <value>www.google.com</value>). Relative URLs will be relative to the current page within the extension."
|
|
11140
11550
|
},
|
|
11141
11551
|
"active": {
|
|
11142
11552
|
"type": "boolean",
|
|
11143
11553
|
"optional": true,
|
|
11144
|
-
"description": "Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see :ref:`windows.update`). Defaults to <
|
|
11554
|
+
"description": "Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see :ref:`windows.update`). Defaults to <value>true</value>."
|
|
11145
11555
|
},
|
|
11146
11556
|
"selected": {
|
|
11147
|
-
"deprecated": "Please use
|
|
11557
|
+
"deprecated": "Please use ``createProperties.active``.",
|
|
11148
11558
|
"unsupported": true,
|
|
11149
11559
|
"type": "boolean",
|
|
11150
11560
|
"optional": true,
|
|
11151
|
-
"description": "Whether the tab should become the selected tab in the window. Defaults to <
|
|
11561
|
+
"description": "Whether the tab should become the selected tab in the window. Defaults to <value>true</value>"
|
|
11152
11562
|
}
|
|
11153
11563
|
}
|
|
11154
11564
|
},
|
|
@@ -11187,7 +11597,7 @@
|
|
|
11187
11597
|
{
|
|
11188
11598
|
"name": "tab",
|
|
11189
11599
|
"optional": true,
|
|
11190
|
-
"description": "Details about the duplicated tab. The :ref:`tabs.Tab` object doesn't contain
|
|
11600
|
+
"description": "Details about the duplicated tab. The :ref:`tabs.Tab` object doesn't contain ``url``, ``title`` and ``favIconUrl`` if the <permission>tabs</permission> permission has not been requested.",
|
|
11191
11601
|
"$ref": "Tab"
|
|
11192
11602
|
}
|
|
11193
11603
|
]
|
|
@@ -11222,7 +11632,7 @@
|
|
|
11222
11632
|
"highlighted": {
|
|
11223
11633
|
"type": "boolean",
|
|
11224
11634
|
"optional": true,
|
|
11225
|
-
"description": "Whether the tabs are highlighted.
|
|
11635
|
+
"description": "Whether the tabs are highlighted. Works as an alias of active."
|
|
11226
11636
|
},
|
|
11227
11637
|
"currentWindow": {
|
|
11228
11638
|
"type": "boolean",
|
|
@@ -11257,7 +11667,7 @@
|
|
|
11257
11667
|
}
|
|
11258
11668
|
],
|
|
11259
11669
|
"optional": true,
|
|
11260
|
-
"description": "Match tabs against one or more `URL Patterns
|
|
11670
|
+
"description": "Match tabs against one or more `URL Patterns <|link-match-patterns|>`__. Note that fragment identifiers are not matched."
|
|
11261
11671
|
},
|
|
11262
11672
|
"windowId": {
|
|
11263
11673
|
"type": "integer",
|
|
@@ -11296,7 +11706,7 @@
|
|
|
11296
11706
|
{
|
|
11297
11707
|
"name": "update",
|
|
11298
11708
|
"type": "function",
|
|
11299
|
-
"description": "Modifies the properties of a tab. Properties that are not specified in
|
|
11709
|
+
"description": "Modifies the properties of a tab. Properties that are not specified in ``updateProperties`` are not modified.",
|
|
11300
11710
|
"async": "callback",
|
|
11301
11711
|
"parameters": [
|
|
11302
11712
|
{
|
|
@@ -11314,12 +11724,12 @@
|
|
|
11314
11724
|
"url": {
|
|
11315
11725
|
"type": "string",
|
|
11316
11726
|
"optional": true,
|
|
11317
|
-
"description": "A URL to navigate the tab to. Only applicable for
|
|
11727
|
+
"description": "A URL to navigate the tab to. Only applicable for <value>content</value> tabs and active <value>mail</value> tabs."
|
|
11318
11728
|
},
|
|
11319
11729
|
"active": {
|
|
11320
11730
|
"type": "boolean",
|
|
11321
11731
|
"optional": true,
|
|
11322
|
-
"description": "Set this to true
|
|
11732
|
+
"description": "Set this to <value>true</value>, if the tab should be active. Does not affect whether the window is focused (see :ref:`windows.update`). Setting this to <value>false</value> has no effect."
|
|
11323
11733
|
}
|
|
11324
11734
|
}
|
|
11325
11735
|
},
|
|
@@ -11332,7 +11742,7 @@
|
|
|
11332
11742
|
"name": "tab",
|
|
11333
11743
|
"$ref": "Tab",
|
|
11334
11744
|
"optional": true,
|
|
11335
|
-
"description": "Details about the updated tab. The :ref:`tabs.Tab` object doesn't contain
|
|
11745
|
+
"description": "Details about the updated tab. The :ref:`tabs.Tab` object doesn't contain ``url``, ``title`` and ``favIconUrl`` if the <permission>tabs</permission> permission has not been requested."
|
|
11336
11746
|
}
|
|
11337
11747
|
]
|
|
11338
11748
|
}
|
|
@@ -11341,7 +11751,7 @@
|
|
|
11341
11751
|
{
|
|
11342
11752
|
"name": "move",
|
|
11343
11753
|
"type": "function",
|
|
11344
|
-
"description": "Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from
|
|
11754
|
+
"description": "Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from windows of type <value>normal</value>.",
|
|
11345
11755
|
"async": "callback",
|
|
11346
11756
|
"parameters": [
|
|
11347
11757
|
{
|
|
@@ -11374,7 +11784,7 @@
|
|
|
11374
11784
|
"index": {
|
|
11375
11785
|
"type": "integer",
|
|
11376
11786
|
"minimum": -1,
|
|
11377
|
-
"description": "The position to move the window to.
|
|
11787
|
+
"description": "The position to move the window to. <value>-1</value> will place the tab at the end of the window."
|
|
11378
11788
|
}
|
|
11379
11789
|
}
|
|
11380
11790
|
},
|
|
@@ -11469,7 +11879,7 @@
|
|
|
11469
11879
|
{
|
|
11470
11880
|
"name": "executeScript",
|
|
11471
11881
|
"type": "function",
|
|
11472
|
-
"description": "Injects JavaScript code into a page. For details, see the `programmatic injection
|
|
11882
|
+
"description": "Injects JavaScript code into a page. For details, see the `programmatic injection <|link-content-scripts|>`__ section of the content scripts doc.",
|
|
11473
11883
|
"async": "callback",
|
|
11474
11884
|
"parameters": [
|
|
11475
11885
|
{
|
|
@@ -11506,7 +11916,7 @@
|
|
|
11506
11916
|
{
|
|
11507
11917
|
"name": "insertCSS",
|
|
11508
11918
|
"type": "function",
|
|
11509
|
-
"description": "Injects CSS into a page. For details, see the `programmatic injection
|
|
11919
|
+
"description": "Injects CSS into a page. For details, see the `programmatic injection <|link-content-scripts|>`__ section of the content scripts doc.",
|
|
11510
11920
|
"async": "callback",
|
|
11511
11921
|
"parameters": [
|
|
11512
11922
|
{
|
|
@@ -11533,7 +11943,7 @@
|
|
|
11533
11943
|
{
|
|
11534
11944
|
"name": "removeCSS",
|
|
11535
11945
|
"type": "function",
|
|
11536
|
-
"description": "Removes injected CSS from a page. For details, see the `programmatic injection
|
|
11946
|
+
"description": "Removes injected CSS from a page. For details, see the `programmatic injection <|link-content-scripts|>`__ section of the content scripts doc.",
|
|
11537
11947
|
"async": "callback",
|
|
11538
11948
|
"parameters": [
|
|
11539
11949
|
{
|
|
@@ -11589,7 +11999,7 @@
|
|
|
11589
11999
|
"status": {
|
|
11590
12000
|
"type": "string",
|
|
11591
12001
|
"optional": true,
|
|
11592
|
-
"description": "The status of the tab. Can be either <
|
|
12002
|
+
"description": "The status of the tab. Can be either <value>loading</value> or <value>complete</value>."
|
|
11593
12003
|
},
|
|
11594
12004
|
"url": {
|
|
11595
12005
|
"type": "string",
|
|
@@ -11744,7 +12154,7 @@
|
|
|
11744
12154
|
},
|
|
11745
12155
|
"isWindowClosing": {
|
|
11746
12156
|
"type": "boolean",
|
|
11747
|
-
"description": "
|
|
12157
|
+
"description": "Is <value>true</value> when the tab is being closed because its window is being closed."
|
|
11748
12158
|
}
|
|
11749
12159
|
}
|
|
11750
12160
|
}
|
|
@@ -11756,12 +12166,12 @@
|
|
|
11756
12166
|
"windows.json": [
|
|
11757
12167
|
{
|
|
11758
12168
|
"namespace": "windows",
|
|
11759
|
-
"description": "
|
|
12169
|
+
"description": "The windows API supports creating, modifying and interacting with Thunderbird windows.",
|
|
11760
12170
|
"types": [
|
|
11761
12171
|
{
|
|
11762
12172
|
"id": "WindowType",
|
|
11763
12173
|
"type": "string",
|
|
11764
|
-
"description": "The type of a window. Under some circumstances a
|
|
12174
|
+
"description": "The type of a window. Under some circumstances a window may not be assigned a type property.",
|
|
11765
12175
|
"enum": [
|
|
11766
12176
|
"normal",
|
|
11767
12177
|
"popup",
|
|
@@ -11824,21 +12234,21 @@
|
|
|
11824
12234
|
"$ref": "tabs.Tab"
|
|
11825
12235
|
},
|
|
11826
12236
|
"optional": true,
|
|
11827
|
-
"description": "Array of :ref:`tabs.Tab` objects representing the current tabs in the window. Only included if requested by :ref:`windows.get`, :ref:`windows.getCurrent`, :ref:`windows.getAll` or :ref:`windows.getLastFocused
|
|
12237
|
+
"description": "Array of :ref:`tabs.Tab` objects representing the current tabs in the window. Only included if requested by :ref:`windows.get`, :ref:`windows.getCurrent`, :ref:`windows.getAll` or :ref:`windows.getLastFocused`, and the optional :ref:`windows.GetInfo` parameter has its ``populate`` member set to <value>true</value>."
|
|
11828
12238
|
},
|
|
11829
12239
|
"incognito": {
|
|
11830
12240
|
"type": "boolean",
|
|
11831
|
-
"description": "Whether the window is incognito."
|
|
12241
|
+
"description": "Whether the window is incognito. Since Thunderbird does not support the incognito mode, this is always <value>false</value>."
|
|
11832
12242
|
},
|
|
11833
12243
|
"type": {
|
|
11834
12244
|
"$ref": "WindowType",
|
|
11835
12245
|
"optional": true,
|
|
11836
|
-
"description": "The type of
|
|
12246
|
+
"description": "The type of window this is."
|
|
11837
12247
|
},
|
|
11838
12248
|
"state": {
|
|
11839
12249
|
"$ref": "WindowState",
|
|
11840
12250
|
"optional": true,
|
|
11841
|
-
"description": "The state of this
|
|
12251
|
+
"description": "The state of this window."
|
|
11842
12252
|
},
|
|
11843
12253
|
"alwaysOnTop": {
|
|
11844
12254
|
"type": "boolean",
|
|
@@ -11854,7 +12264,7 @@
|
|
|
11854
12264
|
{
|
|
11855
12265
|
"id": "CreateType",
|
|
11856
12266
|
"type": "string",
|
|
11857
|
-
"description": "Specifies what type of
|
|
12267
|
+
"description": "Specifies what type of window to create. Thunderbird does not support <value>panel</value> and <value>detached_panel</value>, they are interpreted as <value>popup</value>.",
|
|
11858
12268
|
"enum": [
|
|
11859
12269
|
"normal",
|
|
11860
12270
|
"popup",
|
|
@@ -11870,7 +12280,7 @@
|
|
|
11870
12280
|
"populate": {
|
|
11871
12281
|
"type": "boolean",
|
|
11872
12282
|
"optional": true,
|
|
11873
|
-
"description": "If true, the :ref:`windows.Window` returned will have a
|
|
12283
|
+
"description": "If true, the :ref:`windows.Window` returned will have a ``tabs`` property that contains an array of :ref:`tabs.Tab` objects representing the tabs inside the window. The :ref:`tabs.Tab` objects only contain the ``url``, ``title`` and ``favIconUrl`` properties if the extension's manifest file includes the <permission>tabs</permission> permission."
|
|
11874
12284
|
},
|
|
11875
12285
|
"windowTypes": {
|
|
11876
12286
|
"type": "array",
|
|
@@ -11925,7 +12335,7 @@
|
|
|
11925
12335
|
{
|
|
11926
12336
|
"name": "getCurrent",
|
|
11927
12337
|
"type": "function",
|
|
11928
|
-
"description": "Gets the
|
|
12338
|
+
"description": "Gets the active or topmost window.",
|
|
11929
12339
|
"async": "callback",
|
|
11930
12340
|
"parameters": [
|
|
11931
12341
|
{
|
|
@@ -11997,7 +12407,7 @@
|
|
|
11997
12407
|
{
|
|
11998
12408
|
"name": "create",
|
|
11999
12409
|
"type": "function",
|
|
12000
|
-
"description": "Creates (opens) a new
|
|
12410
|
+
"description": "Creates (opens) a new window with any optional sizing, position or default URL provided.",
|
|
12001
12411
|
"async": "callback",
|
|
12002
12412
|
"parameters": [
|
|
12003
12413
|
{
|
|
@@ -12007,7 +12417,7 @@
|
|
|
12007
12417
|
"default": {},
|
|
12008
12418
|
"properties": {
|
|
12009
12419
|
"url": {
|
|
12010
|
-
"description": "A URL or array of URLs to open as tabs in the window. Fully-qualified URLs must include a scheme (i.e.
|
|
12420
|
+
"description": "A URL or array of URLs to open as tabs in the window. Fully-qualified URLs must include a scheme (i.e. <value>http://www.google.com</value>, not <value>www.google.com</value>). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.",
|
|
12011
12421
|
"optional": true,
|
|
12012
12422
|
"choices": [
|
|
12013
12423
|
{
|
|
@@ -12032,12 +12442,12 @@
|
|
|
12032
12442
|
"left": {
|
|
12033
12443
|
"type": "integer",
|
|
12034
12444
|
"optional": true,
|
|
12035
|
-
"description": "The number of pixels to position the new window from the left edge of the screen. If not specified, the new window is offset naturally from the last focused window.
|
|
12445
|
+
"description": "The number of pixels to position the new window from the left edge of the screen. If not specified, the new window is offset naturally from the last focused window."
|
|
12036
12446
|
},
|
|
12037
12447
|
"top": {
|
|
12038
12448
|
"type": "integer",
|
|
12039
12449
|
"optional": true,
|
|
12040
|
-
"description": "The number of pixels to position the new window from the top edge of the screen. If not specified, the new window is offset naturally from the last focused window.
|
|
12450
|
+
"description": "The number of pixels to position the new window from the top edge of the screen. If not specified, the new window is offset naturally from the last focused window."
|
|
12041
12451
|
},
|
|
12042
12452
|
"width": {
|
|
12043
12453
|
"type": "integer",
|
|
@@ -12058,24 +12468,24 @@
|
|
|
12058
12468
|
"description": "If true, opens an active window. If false, opens an inactive window."
|
|
12059
12469
|
},
|
|
12060
12470
|
"incognito": {
|
|
12471
|
+
"unsupported": true,
|
|
12061
12472
|
"type": "boolean",
|
|
12062
|
-
"optional": true
|
|
12063
|
-
"description": "Whether the new window should be an incognito window."
|
|
12473
|
+
"optional": true
|
|
12064
12474
|
},
|
|
12065
12475
|
"type": {
|
|
12066
12476
|
"$ref": "CreateType",
|
|
12067
12477
|
"optional": true,
|
|
12068
|
-
"description": "Specifies what type of
|
|
12478
|
+
"description": "Specifies what type of window to create. Thunderbird does not support <value>panel</value> and <value>detached_panel</value>, they are interpreted as <value>popup</value>."
|
|
12069
12479
|
},
|
|
12070
12480
|
"state": {
|
|
12071
12481
|
"$ref": "WindowState",
|
|
12072
12482
|
"optional": true,
|
|
12073
|
-
"description": "The initial state of the window. The
|
|
12483
|
+
"description": "The initial state of the window. The ``minimized``, ``maximized`` and ``fullscreen`` states cannot be combined with ``left``, ``top``, ``width`` or ``height``."
|
|
12074
12484
|
},
|
|
12075
12485
|
"allowScriptsToClose": {
|
|
12076
12486
|
"type": "boolean",
|
|
12077
12487
|
"optional": true,
|
|
12078
|
-
"description": "Allow scripts to close the window."
|
|
12488
|
+
"description": "Allow scripts running inside the window to close the window by calling <code>window.close()</code>."
|
|
12079
12489
|
},
|
|
12080
12490
|
"titlePreface": {
|
|
12081
12491
|
"type": "string",
|
|
@@ -12128,13 +12538,13 @@
|
|
|
12128
12538
|
"type": "integer",
|
|
12129
12539
|
"minimum": 0,
|
|
12130
12540
|
"optional": true,
|
|
12131
|
-
"description": "The width to resize the window to in pixels.
|
|
12541
|
+
"description": "The width to resize the window to in pixels."
|
|
12132
12542
|
},
|
|
12133
12543
|
"height": {
|
|
12134
12544
|
"type": "integer",
|
|
12135
12545
|
"minimum": 0,
|
|
12136
12546
|
"optional": true,
|
|
12137
|
-
"description": "The height to resize the window to in pixels.
|
|
12547
|
+
"description": "The height to resize the window to in pixels."
|
|
12138
12548
|
},
|
|
12139
12549
|
"focused": {
|
|
12140
12550
|
"type": "boolean",
|
|
@@ -12144,12 +12554,12 @@
|
|
|
12144
12554
|
"drawAttention": {
|
|
12145
12555
|
"type": "boolean",
|
|
12146
12556
|
"optional": true,
|
|
12147
|
-
"description": "
|
|
12557
|
+
"description": "Setting this to <value>true</value> will cause the window to be displayed in a manner that draws the user's attention to the window, without changing the focused window. The effect lasts until the user changes focus to the window. This option has no effect if the window already has focus."
|
|
12148
12558
|
},
|
|
12149
12559
|
"state": {
|
|
12150
12560
|
"$ref": "WindowState",
|
|
12151
12561
|
"optional": true,
|
|
12152
|
-
"description": "The new state of the window. The
|
|
12562
|
+
"description": "The new state of the window. The ``minimized``, ``maximized`` and ``fullscreen`` states cannot be combined with ``left``, ``top``, ``width`` or ``height``."
|
|
12153
12563
|
},
|
|
12154
12564
|
"titlePreface": {
|
|
12155
12565
|
"type": "string",
|
|
@@ -12215,7 +12625,7 @@
|
|
|
12215
12625
|
"items": {
|
|
12216
12626
|
"$ref": "WindowType"
|
|
12217
12627
|
},
|
|
12218
|
-
"description": "Conditions that the window's type being created must satisfy. By default it will satisfy <
|
|
12628
|
+
"description": "Conditions that the window's type being created must satisfy. By default it will satisfy <value>['app', 'normal', 'panel', 'popup']</value>, with <value>app</value> and <value>panel</value> window types limited to the extension's own windows."
|
|
12219
12629
|
}
|
|
12220
12630
|
],
|
|
12221
12631
|
"parameters": [
|
|
@@ -12237,7 +12647,7 @@
|
|
|
12237
12647
|
"items": {
|
|
12238
12648
|
"$ref": "WindowType"
|
|
12239
12649
|
},
|
|
12240
|
-
"description": "Conditions that the window's type being removed must satisfy. By default it will satisfy <
|
|
12650
|
+
"description": "Conditions that the window's type being removed must satisfy. By default it will satisfy <value>['app', 'normal', 'panel', 'popup']</value>, with <value>app</value> and <value>panel</value> window types limited to the extension's own windows."
|
|
12241
12651
|
}
|
|
12242
12652
|
],
|
|
12243
12653
|
"parameters": [
|
|
@@ -12252,7 +12662,7 @@
|
|
|
12252
12662
|
{
|
|
12253
12663
|
"name": "onFocusChanged",
|
|
12254
12664
|
"type": "function",
|
|
12255
|
-
"description": "Fired when the currently focused window changes. Will be :ref:`windows.WINDOW_ID_NONE
|
|
12665
|
+
"description": "Fired when the currently focused window changes. Will be :ref:`windows.WINDOW_ID_NONE`, if all windows have lost focus. **Note:** On some Linux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one window to another.",
|
|
12256
12666
|
"filters": [
|
|
12257
12667
|
{
|
|
12258
12668
|
"name": "windowTypes",
|
|
@@ -12260,7 +12670,7 @@
|
|
|
12260
12670
|
"items": {
|
|
12261
12671
|
"$ref": "WindowType"
|
|
12262
12672
|
},
|
|
12263
|
-
"description": "Conditions that the window's type being
|
|
12673
|
+
"description": "Conditions that the window's type being focused must satisfy. By default it will satisfy <value>['app', 'normal', 'panel', 'popup']</value>, with <value>app</value> and <value>panel</value> window types limited to the extension's own windows."
|
|
12264
12674
|
}
|
|
12265
12675
|
],
|
|
12266
12676
|
"parameters": [
|