webext-schema 2.0.6 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/modules/browser.js +1088 -0
- package/modules/schema.js +7 -6
- package/modules/update.js +1 -1
- package/package.json +15 -9
- package/schemas/beta/webext.json +113 -22
- package/schemas/central/webext.json +113 -22
- package/schemas/mail/mailext.json +267 -142
- package/schemas/release/webext.json +63 -2
|
@@ -2979,6 +2979,59 @@
|
|
|
2979
2979
|
}
|
|
2980
2980
|
]
|
|
2981
2981
|
}
|
|
2982
|
+
],
|
|
2983
|
+
"events": [
|
|
2984
|
+
{
|
|
2985
|
+
"name": "onCreated",
|
|
2986
|
+
"type": "function",
|
|
2987
|
+
"description": "Fired when a new account has been created.",
|
|
2988
|
+
"parameters": [
|
|
2989
|
+
{
|
|
2990
|
+
"name": "id",
|
|
2991
|
+
"type": "string"
|
|
2992
|
+
},
|
|
2993
|
+
{
|
|
2994
|
+
"name": "account",
|
|
2995
|
+
"$ref": "MailAccount"
|
|
2996
|
+
}
|
|
2997
|
+
]
|
|
2998
|
+
},
|
|
2999
|
+
{
|
|
3000
|
+
"name": "onDeleted",
|
|
3001
|
+
"type": "function",
|
|
3002
|
+
"description": "Fired when an account has been removed.",
|
|
3003
|
+
"parameters": [
|
|
3004
|
+
{
|
|
3005
|
+
"name": "id",
|
|
3006
|
+
"type": "string"
|
|
3007
|
+
}
|
|
3008
|
+
]
|
|
3009
|
+
},
|
|
3010
|
+
{
|
|
3011
|
+
"name": "onUpdated",
|
|
3012
|
+
"type": "function",
|
|
3013
|
+
"description": "Fired when a property of an account has been modified. Folders and identities of accounts are not monitored by this event, use the dedicated folder and identity events instead. A changed ``defaultIdentity`` is reported only after a different identity has been assigned as default identity, but not after a property of the default identity has been changed.",
|
|
3014
|
+
"parameters": [
|
|
3015
|
+
{
|
|
3016
|
+
"name": "id",
|
|
3017
|
+
"type": "string"
|
|
3018
|
+
},
|
|
3019
|
+
{
|
|
3020
|
+
"name": "changedValues",
|
|
3021
|
+
"type": "object",
|
|
3022
|
+
"properties": {
|
|
3023
|
+
"name": {
|
|
3024
|
+
"type": "string",
|
|
3025
|
+
"description": "The human-friendly name of this account."
|
|
3026
|
+
},
|
|
3027
|
+
"defaultIdentity": {
|
|
3028
|
+
"$ref": "identities.MailIdentity",
|
|
3029
|
+
"description": "The default identity of this account."
|
|
3030
|
+
}
|
|
3031
|
+
}
|
|
3032
|
+
}
|
|
3033
|
+
]
|
|
3034
|
+
}
|
|
2982
3035
|
]
|
|
2983
3036
|
}
|
|
2984
3037
|
],
|
|
@@ -3259,7 +3312,7 @@
|
|
|
3259
3312
|
{
|
|
3260
3313
|
"name": "query",
|
|
3261
3314
|
"type": "string",
|
|
3262
|
-
"description": "The boolean query expression corresponding to the search. Note
|
|
3315
|
+
"description": "The boolean query expression corresponding to the search. **Note:** This parameter may change in future releases of Thunderbird.",
|
|
3263
3316
|
"optional": true
|
|
3264
3317
|
}
|
|
3265
3318
|
],
|
|
@@ -3952,7 +4005,7 @@
|
|
|
3952
4005
|
"items": {
|
|
3953
4006
|
"$ref": "ThemeIcons"
|
|
3954
4007
|
},
|
|
3955
|
-
"description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. Note
|
|
4008
|
+
"description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. **Note:** The default theme uses the ``default_icon`` for light backgrounds (if specified)."
|
|
3956
4009
|
},
|
|
3957
4010
|
"default_popup": {
|
|
3958
4011
|
"type": "string",
|
|
@@ -4464,7 +4517,7 @@
|
|
|
4464
4517
|
{
|
|
4465
4518
|
"name": "onClicked",
|
|
4466
4519
|
"type": "function",
|
|
4467
|
-
"description": "Fired when a browserAction icon is clicked.
|
|
4520
|
+
"description": "Fired when a browserAction icon is clicked. This event will not fire if the browserAction has a popup. This is a user input event handler. For asynchronous listeners some `restrictions <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/User_actions>`__ apply.",
|
|
4468
4521
|
"parameters": [
|
|
4469
4522
|
{
|
|
4470
4523
|
"name": "tab",
|
|
@@ -4706,6 +4759,12 @@
|
|
|
4706
4759
|
"File"
|
|
4707
4760
|
]
|
|
4708
4761
|
},
|
|
4762
|
+
"reuse_uploads": {
|
|
4763
|
+
"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.",
|
|
4764
|
+
"type": "boolean",
|
|
4765
|
+
"optional": true,
|
|
4766
|
+
"default": true
|
|
4767
|
+
},
|
|
4709
4768
|
"management_url": {
|
|
4710
4769
|
"type": "string",
|
|
4711
4770
|
"format": "relativeUrl",
|
|
@@ -4764,6 +4823,12 @@
|
|
|
4764
4823
|
"name": "tab",
|
|
4765
4824
|
"$ref": "tabs.Tab",
|
|
4766
4825
|
"description": "The tab where the upload was initiated. Currently only available for the message composer."
|
|
4826
|
+
},
|
|
4827
|
+
{
|
|
4828
|
+
"$ref": "RelatedCloudFile",
|
|
4829
|
+
"name": "relatedFileInfo",
|
|
4830
|
+
"optional": true,
|
|
4831
|
+
"description": "Information about an already uploaded file, which is related to this upload."
|
|
4767
4832
|
}
|
|
4768
4833
|
],
|
|
4769
4834
|
"returns": {
|
|
@@ -4793,7 +4858,7 @@
|
|
|
4793
4858
|
},
|
|
4794
4859
|
"templateInfo": {
|
|
4795
4860
|
"$ref": "CloudFileTemplateInfo",
|
|
4796
|
-
"description": "
|
|
4861
|
+
"description": "Additional file information used in the cloud file entry added to the message.",
|
|
4797
4862
|
"optional": true
|
|
4798
4863
|
}
|
|
4799
4864
|
}
|
|
@@ -4824,7 +4889,7 @@
|
|
|
4824
4889
|
{
|
|
4825
4890
|
"name": "onFileRename",
|
|
4826
4891
|
"type": "function",
|
|
4827
|
-
"description": "Fired when
|
|
4892
|
+
"description": "Fired when a previously uploaded file should be renamed.",
|
|
4828
4893
|
"parameters": [
|
|
4829
4894
|
{
|
|
4830
4895
|
"name": "account",
|
|
@@ -4874,7 +4939,7 @@
|
|
|
4874
4939
|
{
|
|
4875
4940
|
"name": "onFileDeleted",
|
|
4876
4941
|
"type": "function",
|
|
4877
|
-
"description": "Fired when a
|
|
4942
|
+
"description": "Fired when a previously uploaded file should be deleted.",
|
|
4878
4943
|
"parameters": [
|
|
4879
4944
|
{
|
|
4880
4945
|
"name": "account",
|
|
@@ -5042,6 +5107,37 @@
|
|
|
5042
5107
|
]
|
|
5043
5108
|
}
|
|
5044
5109
|
}
|
|
5110
|
+
},
|
|
5111
|
+
{
|
|
5112
|
+
"id": "RelatedCloudFile",
|
|
5113
|
+
"type": "object",
|
|
5114
|
+
"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 ``false``.",
|
|
5115
|
+
"properties": {
|
|
5116
|
+
"id": {
|
|
5117
|
+
"type": "integer",
|
|
5118
|
+
"minimum": 1,
|
|
5119
|
+
"optional": true,
|
|
5120
|
+
"description": "The identifier for the related file. In some circumstances, the id is unavailable."
|
|
5121
|
+
},
|
|
5122
|
+
"url": {
|
|
5123
|
+
"type": "string",
|
|
5124
|
+
"description": "The URL where the upload of the related file can be accessed.",
|
|
5125
|
+
"optional": true
|
|
5126
|
+
},
|
|
5127
|
+
"templateInfo": {
|
|
5128
|
+
"$ref": "CloudFileTemplateInfo",
|
|
5129
|
+
"description": "Additional information of the related file, used in the cloud file entry added to the message.",
|
|
5130
|
+
"optional": true
|
|
5131
|
+
},
|
|
5132
|
+
"name": {
|
|
5133
|
+
"type": "string",
|
|
5134
|
+
"description": "Filename of the related file."
|
|
5135
|
+
},
|
|
5136
|
+
"dataChanged": {
|
|
5137
|
+
"type": "boolean",
|
|
5138
|
+
"description": "The content of the new upload differs from the related file."
|
|
5139
|
+
}
|
|
5140
|
+
}
|
|
5045
5141
|
}
|
|
5046
5142
|
],
|
|
5047
5143
|
"functions": [
|
|
@@ -5247,7 +5343,7 @@
|
|
|
5247
5343
|
},
|
|
5248
5344
|
"from": {
|
|
5249
5345
|
"$ref": "ComposeRecipient",
|
|
5250
|
-
"description": "*Caution*: Setting a value for
|
|
5346
|
+
"description": "*Caution*: Setting a value for ``from`` does not change the used identity, it overrides the FROM header. Many email servers do not accept emails where the FROM header does not match the sender identity. Must be set to exactly one valid email address.",
|
|
5251
5347
|
"optional": true
|
|
5252
5348
|
},
|
|
5253
5349
|
"to": {
|
|
@@ -5309,34 +5405,51 @@
|
|
|
5309
5405
|
},
|
|
5310
5406
|
"body": {
|
|
5311
5407
|
"type": "string",
|
|
5408
|
+
"description": "The HTML content of the message.",
|
|
5312
5409
|
"optional": true
|
|
5313
5410
|
},
|
|
5314
5411
|
"plainTextBody": {
|
|
5315
5412
|
"type": "string",
|
|
5413
|
+
"description": "The plain text content of the message.",
|
|
5316
5414
|
"optional": true
|
|
5317
5415
|
},
|
|
5318
5416
|
"isPlainText": {
|
|
5319
5417
|
"type": "boolean",
|
|
5418
|
+
"description": "Whether the message is an HTML message or a plain text message.",
|
|
5320
5419
|
"optional": true
|
|
5321
5420
|
},
|
|
5322
5421
|
"attachments": {
|
|
5323
5422
|
"type": "array",
|
|
5324
5423
|
"items": {
|
|
5325
|
-
"
|
|
5326
|
-
|
|
5327
|
-
|
|
5328
|
-
"type": "string",
|
|
5329
|
-
"description": "The name, as displayed to the user, of this attachment. If not specified, the name of the ``file`` object is used.",
|
|
5330
|
-
"optional": true
|
|
5424
|
+
"choices": [
|
|
5425
|
+
{
|
|
5426
|
+
"$ref": "FileAttachment"
|
|
5331
5427
|
},
|
|
5332
|
-
|
|
5333
|
-
"
|
|
5334
|
-
"isInstanceOf": "File",
|
|
5335
|
-
"additionalProperties": true
|
|
5428
|
+
{
|
|
5429
|
+
"$ref": "ComposeAttachment"
|
|
5336
5430
|
}
|
|
5337
|
-
|
|
5431
|
+
]
|
|
5338
5432
|
},
|
|
5339
|
-
"description": "
|
|
5433
|
+
"description": "Only used in the begin* functions. Attachments to add to the message.",
|
|
5434
|
+
"optional": true
|
|
5435
|
+
}
|
|
5436
|
+
}
|
|
5437
|
+
},
|
|
5438
|
+
{
|
|
5439
|
+
"id": "FileAttachment",
|
|
5440
|
+
"type": "object",
|
|
5441
|
+
"description": "Object used to add, update or rename an attachment in a message being composed.",
|
|
5442
|
+
"properties": {
|
|
5443
|
+
"file": {
|
|
5444
|
+
"type": "object",
|
|
5445
|
+
"isInstanceOf": "File",
|
|
5446
|
+
"additionalProperties": true,
|
|
5447
|
+
"description": "The new content for the attachment.",
|
|
5448
|
+
"optional": true
|
|
5449
|
+
},
|
|
5450
|
+
"name": {
|
|
5451
|
+
"type": "string",
|
|
5452
|
+
"description": "The new name for the attachment, as displayed to the user. If not specified, the name of the provided ``file`` object is used.",
|
|
5340
5453
|
"optional": true
|
|
5341
5454
|
}
|
|
5342
5455
|
}
|
|
@@ -5352,22 +5465,15 @@
|
|
|
5352
5465
|
},
|
|
5353
5466
|
"name": {
|
|
5354
5467
|
"type": "string",
|
|
5355
|
-
"
|
|
5468
|
+
"optional": true,
|
|
5469
|
+
"description": "The name of this attachment, as displayed to the user."
|
|
5356
5470
|
},
|
|
5357
5471
|
"size": {
|
|
5358
5472
|
"type": "integer",
|
|
5359
|
-
"
|
|
5360
|
-
|
|
5361
|
-
},
|
|
5362
|
-
"functions": [
|
|
5363
|
-
{
|
|
5364
|
-
"name": "getFile",
|
|
5365
|
-
"type": "function",
|
|
5366
|
-
"description": "Retrieves the contents of the attachment as a DOM ``File`` object.",
|
|
5367
|
-
"async": true,
|
|
5368
|
-
"parameters": []
|
|
5473
|
+
"optional": true,
|
|
5474
|
+
"description": "The size in bytes of this attachment. Read-only."
|
|
5369
5475
|
}
|
|
5370
|
-
|
|
5476
|
+
}
|
|
5371
5477
|
}
|
|
5372
5478
|
],
|
|
5373
5479
|
"events": [
|
|
@@ -5386,7 +5492,7 @@
|
|
|
5386
5492
|
{
|
|
5387
5493
|
"name": "details",
|
|
5388
5494
|
"$ref": "ComposeDetails",
|
|
5389
|
-
"description": "The current state of the compose window. This is functionally the same as the :ref:`compose.getComposeDetails` function."
|
|
5495
|
+
"description": "The current state of the compose window. This is functionally the same as calling the :ref:`compose.getComposeDetails` function."
|
|
5390
5496
|
}
|
|
5391
5497
|
],
|
|
5392
5498
|
"returns": {
|
|
@@ -5400,7 +5506,7 @@
|
|
|
5400
5506
|
"details": {
|
|
5401
5507
|
"$ref": "ComposeDetails",
|
|
5402
5508
|
"optional": true,
|
|
5403
|
-
"description": "Updates the compose window.
|
|
5509
|
+
"description": "Updates the compose window. This is functionally the same as calling the :ref:`compose.setComposeDetails` function."
|
|
5404
5510
|
}
|
|
5405
5511
|
}
|
|
5406
5512
|
}
|
|
@@ -5479,7 +5585,7 @@
|
|
|
5479
5585
|
{
|
|
5480
5586
|
"name": "beginNew",
|
|
5481
5587
|
"type": "function",
|
|
5482
|
-
"description": "Open a new message compose window
|
|
5588
|
+
"description": "Open a new message compose window.\n\n**Note:** The compose format can be set by ``details.isPlainText`` or by specifying only one of ``details.body`` or ``details.plainTextBody``. Otherwise the default compose format of the selected identity is used.\n\n**Note:** Specifying ``details.body`` and ``details.plainTextBody`` without also specifying ``details.isPlainText`` threw an exception in Thunderbird up to version 97. Since Thunderbird 98, this combination creates a compose window with the compose format of the selected identity, using the matching ``details.body`` or ``details.plainTextBody`` value.\n\n**Note:** If no identity is specified, this function is using the default identity and not the identity of the referenced message.",
|
|
5483
5589
|
"async": "callback",
|
|
5484
5590
|
"parameters": [
|
|
5485
5591
|
{
|
|
@@ -5510,7 +5616,7 @@
|
|
|
5510
5616
|
{
|
|
5511
5617
|
"name": "beginReply",
|
|
5512
5618
|
"type": "function",
|
|
5513
|
-
"description": "Open a new message compose window replying to a given message
|
|
5619
|
+
"description": "Open a new message compose window replying to a given message.\n\n**Note:** The compose format can be set by ``details.isPlainText`` or by specifying only one of ``details.body`` or ``details.plainTextBody``. Otherwise the default compose format of the selected identity is used.\n\n**Note:** Specifying ``details.body`` and ``details.plainTextBody`` without also specifying ``details.isPlainText`` threw an exception in Thunderbird up to version 97. Since Thunderbird 98, this combination creates a compose window with the compose format of the selected identity, using the matching ``details.body`` or ``details.plainTextBody`` value.\n\n**Note:** If no identity is specified, this function is using the default identity and not the identity of the referenced message.",
|
|
5514
5620
|
"async": "callback",
|
|
5515
5621
|
"parameters": [
|
|
5516
5622
|
{
|
|
@@ -5550,7 +5656,7 @@
|
|
|
5550
5656
|
{
|
|
5551
5657
|
"name": "beginForward",
|
|
5552
5658
|
"type": "function",
|
|
5553
|
-
"description": "Open a new message compose window forwarding a given message
|
|
5659
|
+
"description": "Open a new message compose window forwarding a given message.\n\n**Note:** The compose format can be set by ``details.isPlainText`` or by specifying only one of ``details.body`` or ``details.plainTextBody``. Otherwise the default compose format of the selected identity is used.\n\n**Note:** Specifying ``details.body`` and ``details.plainTextBody`` without also specifying ``details.isPlainText`` threw an exception in Thunderbird up to version 97. Since Thunderbird 98, this combination creates a compose window with the compose format of the selected identity, using the matching ``details.body`` or ``details.plainTextBody`` value.\n\n**Note:** If no identity is specified, this function is using the default identity and not the identity of the referenced message.",
|
|
5554
5660
|
"async": "callback",
|
|
5555
5661
|
"parameters": [
|
|
5556
5662
|
{
|
|
@@ -5616,7 +5722,7 @@
|
|
|
5616
5722
|
"name": "setComposeDetails",
|
|
5617
5723
|
"type": "function",
|
|
5618
5724
|
"async": true,
|
|
5619
|
-
"description": "Updates the compose window.
|
|
5725
|
+
"description": "Updates the compose window. Only fields that are to be changed should be specified. Currently only a limited amount of information can be set, more will be added in later versions.\n\n**Note:** The compose format of an existing compose window cannot be changed. Since Thunderbird 98, setting conflicting values for ``details.body``, ``details.plainTextBody`` or ``details.isPlaintext`` no longer throw an exception, instead the compose window chooses the matching ``details.body`` or ``details.plainTextBody`` value and ignores the other.",
|
|
5620
5726
|
"permissions": [
|
|
5621
5727
|
"compose"
|
|
5622
5728
|
],
|
|
@@ -5628,8 +5734,7 @@
|
|
|
5628
5734
|
},
|
|
5629
5735
|
{
|
|
5630
5736
|
"name": "details",
|
|
5631
|
-
"$ref": "ComposeDetails"
|
|
5632
|
-
"description": "The compose format of an already opened compose window cannot be changed. Setting ``details.body``, ``details.plainTextBody`` or ``details.isPlaintext`` will fail if the compose format of the compose window does not match. Use :ref:`compose.getComposeDetails` to get the current compose format."
|
|
5737
|
+
"$ref": "ComposeDetails"
|
|
5633
5738
|
}
|
|
5634
5739
|
]
|
|
5635
5740
|
},
|
|
@@ -5652,17 +5757,35 @@
|
|
|
5652
5757
|
"optional": true,
|
|
5653
5758
|
"parameters": [
|
|
5654
5759
|
{
|
|
5655
|
-
"
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5660
|
-
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
5665
|
-
|
|
5760
|
+
"type": "array",
|
|
5761
|
+
"items": {
|
|
5762
|
+
"$ref": "ComposeAttachment"
|
|
5763
|
+
}
|
|
5764
|
+
}
|
|
5765
|
+
]
|
|
5766
|
+
}
|
|
5767
|
+
]
|
|
5768
|
+
},
|
|
5769
|
+
{
|
|
5770
|
+
"name": "getAttachmentFile",
|
|
5771
|
+
"type": "function",
|
|
5772
|
+
"description": "Gets the content of a :ref:`compose.ComposeAttachment` as a DOM <code>File</code> object.",
|
|
5773
|
+
"async": "callback",
|
|
5774
|
+
"parameters": [
|
|
5775
|
+
{
|
|
5776
|
+
"name": "id",
|
|
5777
|
+
"type": "integer",
|
|
5778
|
+
"description": "The unique identifier for the attachment."
|
|
5779
|
+
},
|
|
5780
|
+
{
|
|
5781
|
+
"type": "function",
|
|
5782
|
+
"name": "callback",
|
|
5783
|
+
"optional": true,
|
|
5784
|
+
"parameters": [
|
|
5785
|
+
{
|
|
5786
|
+
"type": "object",
|
|
5787
|
+
"isInstanceOf": "File",
|
|
5788
|
+
"additionalProperties": true
|
|
5666
5789
|
}
|
|
5667
5790
|
]
|
|
5668
5791
|
}
|
|
@@ -5682,20 +5805,15 @@
|
|
|
5682
5805
|
"type": "integer"
|
|
5683
5806
|
},
|
|
5684
5807
|
{
|
|
5685
|
-
"name": "
|
|
5686
|
-
"
|
|
5687
|
-
|
|
5688
|
-
|
|
5689
|
-
"type": "string",
|
|
5690
|
-
"description": "The name, as displayed to the user, of this attachment. If not specified, the name of the ``file`` object is used.",
|
|
5691
|
-
"optional": true
|
|
5808
|
+
"name": "attachment",
|
|
5809
|
+
"choices": [
|
|
5810
|
+
{
|
|
5811
|
+
"$ref": "FileAttachment"
|
|
5692
5812
|
},
|
|
5693
|
-
|
|
5694
|
-
"
|
|
5695
|
-
"isInstanceOf": "File",
|
|
5696
|
-
"additionalProperties": true
|
|
5813
|
+
{
|
|
5814
|
+
"$ref": "ComposeAttachment"
|
|
5697
5815
|
}
|
|
5698
|
-
|
|
5816
|
+
]
|
|
5699
5817
|
},
|
|
5700
5818
|
{
|
|
5701
5819
|
"type": "function",
|
|
@@ -5703,14 +5821,7 @@
|
|
|
5703
5821
|
"optional": true,
|
|
5704
5822
|
"parameters": [
|
|
5705
5823
|
{
|
|
5706
|
-
"
|
|
5707
|
-
{
|
|
5708
|
-
"$ref": "ComposeAttachment"
|
|
5709
|
-
},
|
|
5710
|
-
{
|
|
5711
|
-
"type": "any"
|
|
5712
|
-
}
|
|
5713
|
-
]
|
|
5824
|
+
"$ref": "ComposeAttachment"
|
|
5714
5825
|
}
|
|
5715
5826
|
]
|
|
5716
5827
|
}
|
|
@@ -5719,7 +5830,7 @@
|
|
|
5719
5830
|
{
|
|
5720
5831
|
"name": "updateAttachment",
|
|
5721
5832
|
"type": "function",
|
|
5722
|
-
"description": "
|
|
5833
|
+
"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 ``ExtensionError``.",
|
|
5723
5834
|
"permissions": [
|
|
5724
5835
|
"compose"
|
|
5725
5836
|
],
|
|
@@ -5734,21 +5845,8 @@
|
|
|
5734
5845
|
"type": "integer"
|
|
5735
5846
|
},
|
|
5736
5847
|
{
|
|
5737
|
-
"name": "
|
|
5738
|
-
"
|
|
5739
|
-
"properties": {
|
|
5740
|
-
"name": {
|
|
5741
|
-
"type": "string",
|
|
5742
|
-
"description": "The name, as displayed to the user, of this attachment. If not specified, the name of the ``file`` object is used.",
|
|
5743
|
-
"optional": true
|
|
5744
|
-
},
|
|
5745
|
-
"file": {
|
|
5746
|
-
"type": "object",
|
|
5747
|
-
"isInstanceOf": "File",
|
|
5748
|
-
"additionalProperties": true,
|
|
5749
|
-
"optional": true
|
|
5750
|
-
}
|
|
5751
|
-
}
|
|
5848
|
+
"name": "attachment",
|
|
5849
|
+
"$ref": "FileAttachment"
|
|
5752
5850
|
},
|
|
5753
5851
|
{
|
|
5754
5852
|
"type": "function",
|
|
@@ -5756,14 +5854,7 @@
|
|
|
5756
5854
|
"optional": true,
|
|
5757
5855
|
"parameters": [
|
|
5758
5856
|
{
|
|
5759
|
-
"
|
|
5760
|
-
{
|
|
5761
|
-
"$ref": "ComposeAttachment"
|
|
5762
|
-
},
|
|
5763
|
-
{
|
|
5764
|
-
"type": "any"
|
|
5765
|
-
}
|
|
5766
|
-
]
|
|
5857
|
+
"$ref": "ComposeAttachment"
|
|
5767
5858
|
}
|
|
5768
5859
|
]
|
|
5769
5860
|
}
|
|
@@ -5893,7 +5984,7 @@
|
|
|
5893
5984
|
"items": {
|
|
5894
5985
|
"$ref": "ThemeIcons"
|
|
5895
5986
|
},
|
|
5896
|
-
"description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. Note
|
|
5987
|
+
"description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. **Note:** The default theme uses the ``default_icon`` for light backgrounds (if specified)."
|
|
5897
5988
|
},
|
|
5898
5989
|
"default_popup": {
|
|
5899
5990
|
"type": "string",
|
|
@@ -6405,7 +6496,7 @@
|
|
|
6405
6496
|
{
|
|
6406
6497
|
"name": "onClicked",
|
|
6407
6498
|
"type": "function",
|
|
6408
|
-
"description": "Fired when a composeAction icon is clicked.
|
|
6499
|
+
"description": "Fired when a composeAction icon 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 <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/User_actions>`__ apply.",
|
|
6409
6500
|
"parameters": [
|
|
6410
6501
|
{
|
|
6411
6502
|
"name": "tab",
|
|
@@ -7286,7 +7377,7 @@
|
|
|
7286
7377
|
},
|
|
7287
7378
|
"sortType": {
|
|
7288
7379
|
"type": "string",
|
|
7289
|
-
"description": "Note
|
|
7380
|
+
"description": "**Note:** ``sortType`` and ``sortOrder`` depend on each other, so both should be present, or neither.",
|
|
7290
7381
|
"optional": true,
|
|
7291
7382
|
"enum": [
|
|
7292
7383
|
"none",
|
|
@@ -7313,7 +7404,7 @@
|
|
|
7313
7404
|
},
|
|
7314
7405
|
"sortOrder": {
|
|
7315
7406
|
"type": "string",
|
|
7316
|
-
"description": "Note
|
|
7407
|
+
"description": "**Note:** ``sortType`` and ``sortOrder`` depend on each other, so both should be present, or neither.",
|
|
7317
7408
|
"optional": true,
|
|
7318
7409
|
"enum": [
|
|
7319
7410
|
"none",
|
|
@@ -7761,6 +7852,8 @@
|
|
|
7761
7852
|
"message_list",
|
|
7762
7853
|
"folder_pane",
|
|
7763
7854
|
"compose_attachments",
|
|
7855
|
+
"message_attachments",
|
|
7856
|
+
"all_message_attachments",
|
|
7764
7857
|
"tools_menu"
|
|
7765
7858
|
],
|
|
7766
7859
|
"description": "The different contexts a menu can appear in. Specifying <code>all</code> is equivalent to the combination of all other contexts excluding <code>tab</code> and <code>tools_menu</code>. More information about each context can be found in the `Supported UI Elements <https://developer.thunderbird.net/add-ons/mailextensions/supported-ui-elements#menu-items>`__ article on developer.thunderbird.net."
|
|
@@ -7779,7 +7872,7 @@
|
|
|
7779
7872
|
{
|
|
7780
7873
|
"id": "OnShowData",
|
|
7781
7874
|
"type": "object",
|
|
7782
|
-
"description": "Information sent when a context menu is being shown.
|
|
7875
|
+
"description": "Information sent when a context menu is being shown. Some properties are only included if the extension has host permission for the given context, for example :permission:`activeTab` for content tabs, :permission:`compose` for compose tabs and :permission:`messagesRead` for message display tabs.",
|
|
7783
7876
|
"properties": {
|
|
7784
7877
|
"menuIds": {
|
|
7785
7878
|
"description": "A list of IDs of the menu items that were shown.",
|
|
@@ -7802,76 +7895,101 @@
|
|
|
7802
7895
|
"$ref": "ContextType"
|
|
7803
7896
|
}
|
|
7804
7897
|
},
|
|
7805
|
-
"viewType": {
|
|
7806
|
-
"$ref": "extension.ViewType",
|
|
7807
|
-
"optional": true
|
|
7808
|
-
},
|
|
7809
7898
|
"editable": {
|
|
7810
|
-
"type": "boolean"
|
|
7899
|
+
"type": "boolean",
|
|
7900
|
+
"description": "A flag indicating whether the element is editable (text input, textarea, etc.)."
|
|
7811
7901
|
},
|
|
7812
7902
|
"mediaType": {
|
|
7813
7903
|
"type": "string",
|
|
7814
|
-
"optional": true
|
|
7904
|
+
"optional": true,
|
|
7905
|
+
"description": "One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements."
|
|
7815
7906
|
},
|
|
7816
|
-
"
|
|
7817
|
-
"
|
|
7818
|
-
"
|
|
7819
|
-
"
|
|
7907
|
+
"viewType": {
|
|
7908
|
+
"$ref": "extension.ViewType",
|
|
7909
|
+
"optional": true,
|
|
7910
|
+
"description": "The type of view where the menu is shown. May be unset if the menu is not associated with a view."
|
|
7820
7911
|
},
|
|
7821
7912
|
"linkText": {
|
|
7822
7913
|
"type": "string",
|
|
7823
|
-
"
|
|
7824
|
-
"
|
|
7914
|
+
"optional": true,
|
|
7915
|
+
"description": "If the element is a link, the text of that link. **Note:** Host permission is required."
|
|
7916
|
+
},
|
|
7917
|
+
"linkUrl": {
|
|
7918
|
+
"type": "string",
|
|
7919
|
+
"optional": true,
|
|
7920
|
+
"description": "If the element is a link, the URL it points to. **Note:** Host permission is required."
|
|
7825
7921
|
},
|
|
7826
7922
|
"srcUrl": {
|
|
7827
7923
|
"type": "string",
|
|
7828
|
-
"description": "Host permission is required.",
|
|
7924
|
+
"description": "Will be present for elements with a 'src' URL. **Note:** Host permission is required.",
|
|
7829
7925
|
"optional": true
|
|
7830
7926
|
},
|
|
7831
7927
|
"pageUrl": {
|
|
7832
7928
|
"type": "string",
|
|
7833
|
-
"description": "Host permission is required.",
|
|
7929
|
+
"description": "The URL of the page where the menu item was clicked. This property is not set if the click occurred in a context where there is no current page, such as in a launcher context menu. **Note:** Host permission is required.",
|
|
7834
7930
|
"optional": true
|
|
7835
7931
|
},
|
|
7836
7932
|
"frameUrl": {
|
|
7837
7933
|
"type": "string",
|
|
7838
|
-
"description": "Host permission is required.",
|
|
7934
|
+
"description": "The URL of the frame of the element where the context menu was clicked, if it was in a frame. **Note:** Host permission is required.",
|
|
7839
7935
|
"optional": true
|
|
7840
7936
|
},
|
|
7841
7937
|
"selectionText": {
|
|
7842
7938
|
"type": "string",
|
|
7843
|
-
"description": "Host permission is required.",
|
|
7939
|
+
"description": "The text for the context selection, if any. **Note:** Host permission is required.",
|
|
7844
7940
|
"optional": true
|
|
7845
7941
|
},
|
|
7846
7942
|
"targetElementId": {
|
|
7847
7943
|
"type": "integer",
|
|
7848
|
-
"optional": true
|
|
7944
|
+
"optional": true,
|
|
7945
|
+
"description": "An identifier of the clicked content element, if any. Use menus.getTargetElement in the page to find the corresponding element."
|
|
7849
7946
|
},
|
|
7850
7947
|
"fieldId": {
|
|
7851
7948
|
"type": "string",
|
|
7852
|
-
"optional": true
|
|
7949
|
+
"optional": true,
|
|
7950
|
+
"description": "An identifier of the clicked Thunderbird UI element, if any.",
|
|
7951
|
+
"enum": [
|
|
7952
|
+
"composeSubject",
|
|
7953
|
+
"composeTo",
|
|
7954
|
+
"composeCc",
|
|
7955
|
+
"composeBcc",
|
|
7956
|
+
"composeReplyTo",
|
|
7957
|
+
"composeNewsgroupTo"
|
|
7958
|
+
]
|
|
7853
7959
|
},
|
|
7854
7960
|
"selectedMessages": {
|
|
7855
7961
|
"$ref": "messages.MessageList",
|
|
7856
|
-
"optional": true
|
|
7962
|
+
"optional": true,
|
|
7963
|
+
"description": "The selected messages, if the context menu was opened in the message list. The <permission>messagesRead</permission> permission is required."
|
|
7857
7964
|
},
|
|
7858
7965
|
"displayedFolder": {
|
|
7859
7966
|
"$ref": "folders.MailFolder",
|
|
7860
|
-
"optional": true
|
|
7967
|
+
"optional": true,
|
|
7968
|
+
"description": "The displayed folder, if the context menu was opened in the message list. The <permission>accountsRead</permission> permission is required."
|
|
7861
7969
|
},
|
|
7862
7970
|
"selectedFolder": {
|
|
7863
7971
|
"$ref": "folders.MailFolder",
|
|
7864
|
-
"optional": true
|
|
7972
|
+
"optional": true,
|
|
7973
|
+
"description": "The selected folder, if the context menu was opened in the folder pane. The <permission>accountsRead</permission> permission is required."
|
|
7865
7974
|
},
|
|
7866
7975
|
"selectedAccount": {
|
|
7867
7976
|
"$ref": "accounts.MailAccount",
|
|
7868
|
-
"optional": true
|
|
7977
|
+
"optional": true,
|
|
7978
|
+
"description": "The selected account, if the context menu was opened on an account entry in the folder pane. The <permission>accountsRead</permission> permission is required."
|
|
7869
7979
|
},
|
|
7870
7980
|
"attachments": {
|
|
7871
7981
|
"type": "array",
|
|
7872
7982
|
"optional": true,
|
|
7983
|
+
"description": "The selected attachments. The <permission>compose</permission> permission is required to return attachments of a message being composed. The <permission>messagesRead</permission> permission is required to return attachments of displayed messages.",
|
|
7873
7984
|
"items": {
|
|
7874
|
-
"
|
|
7985
|
+
"choices": [
|
|
7986
|
+
{
|
|
7987
|
+
"$ref": "compose.ComposeAttachment"
|
|
7988
|
+
},
|
|
7989
|
+
{
|
|
7990
|
+
"$ref": "messages.MessageAttachment"
|
|
7991
|
+
}
|
|
7992
|
+
]
|
|
7875
7993
|
}
|
|
7876
7994
|
}
|
|
7877
7995
|
}
|
|
@@ -7904,16 +8022,20 @@
|
|
|
7904
8022
|
"optional": true,
|
|
7905
8023
|
"description": "The parent ID, if any, for the item clicked."
|
|
7906
8024
|
},
|
|
7907
|
-
"
|
|
7908
|
-
"
|
|
7909
|
-
"
|
|
7910
|
-
"description": "The type of view where the menu is clicked. May be unset if the menu is not associated with a view."
|
|
8025
|
+
"editable": {
|
|
8026
|
+
"type": "boolean",
|
|
8027
|
+
"description": "A flag indicating whether the element is editable (text input, textarea, etc.)."
|
|
7911
8028
|
},
|
|
7912
8029
|
"mediaType": {
|
|
7913
8030
|
"type": "string",
|
|
7914
8031
|
"optional": true,
|
|
7915
8032
|
"description": "One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements."
|
|
7916
8033
|
},
|
|
8034
|
+
"viewType": {
|
|
8035
|
+
"$ref": "extension.ViewType",
|
|
8036
|
+
"optional": true,
|
|
8037
|
+
"description": "The type of view where the menu is clicked. May be unset if the menu is not associated with a view."
|
|
8038
|
+
},
|
|
7917
8039
|
"linkText": {
|
|
7918
8040
|
"type": "string",
|
|
7919
8041
|
"optional": true,
|
|
@@ -7950,10 +8072,6 @@
|
|
|
7950
8072
|
"optional": true,
|
|
7951
8073
|
"description": "The text for the context selection, if any."
|
|
7952
8074
|
},
|
|
7953
|
-
"editable": {
|
|
7954
|
-
"type": "boolean",
|
|
7955
|
-
"description": "A flag indicating whether the element is editable (text input, textarea, etc.)."
|
|
7956
|
-
},
|
|
7957
8075
|
"wasChecked": {
|
|
7958
8076
|
"type": "boolean",
|
|
7959
8077
|
"optional": true,
|
|
@@ -8024,9 +8142,16 @@
|
|
|
8024
8142
|
"attachments": {
|
|
8025
8143
|
"type": "array",
|
|
8026
8144
|
"optional": true,
|
|
8027
|
-
"description": "The selected attachments of a message being composed. The <permission>
|
|
8145
|
+
"description": "The selected attachments. The <permission>compose</permission> permission is required to return attachments of a message being composed. The <permission>messagesRead</permission> permission is required to return attachments of displayed messages.",
|
|
8028
8146
|
"items": {
|
|
8029
|
-
"
|
|
8147
|
+
"choices": [
|
|
8148
|
+
{
|
|
8149
|
+
"$ref": "compose.ComposeAttachment"
|
|
8150
|
+
},
|
|
8151
|
+
{
|
|
8152
|
+
"$ref": "messages.MessageAttachment"
|
|
8153
|
+
}
|
|
8154
|
+
]
|
|
8030
8155
|
}
|
|
8031
8156
|
}
|
|
8032
8157
|
}
|
|
@@ -8118,7 +8243,7 @@
|
|
|
8118
8243
|
{
|
|
8119
8244
|
"name": "tab",
|
|
8120
8245
|
"$ref": "tabs.Tab",
|
|
8121
|
-
"description": "The details of the tab where the click took place. Note
|
|
8246
|
+
"description": "The details of the tab where the click took place. **Note:** this parameter only present for extensions."
|
|
8122
8247
|
}
|
|
8123
8248
|
]
|
|
8124
8249
|
},
|
|
@@ -8158,7 +8283,7 @@
|
|
|
8158
8283
|
"command": {
|
|
8159
8284
|
"type": "string",
|
|
8160
8285
|
"optional": true,
|
|
8161
|
-
"description": "Specifies a command to issue for the context click. Currently supports internal
|
|
8286
|
+
"description": "Specifies a command to issue for the context click. Currently supports internal commands ``_execute_browser_action``, ``_execute_compose_action`` and ``_execute_message_display_action``."
|
|
8162
8287
|
}
|
|
8163
8288
|
}
|
|
8164
8289
|
},
|
|
@@ -8247,7 +8372,7 @@
|
|
|
8247
8372
|
{
|
|
8248
8373
|
"name": "tab",
|
|
8249
8374
|
"$ref": "tabs.Tab",
|
|
8250
|
-
"description": "The details of the tab where the click took place. Note
|
|
8375
|
+
"description": "The details of the tab where the click took place. **Note:** this parameter only present for extensions."
|
|
8251
8376
|
}
|
|
8252
8377
|
]
|
|
8253
8378
|
},
|
|
@@ -8261,7 +8386,7 @@
|
|
|
8261
8386
|
}
|
|
8262
8387
|
],
|
|
8263
8388
|
"optional": true,
|
|
8264
|
-
"description": "Note
|
|
8389
|
+
"description": "**Note:** You cannot change an item to be a child of one of its own descendants."
|
|
8265
8390
|
},
|
|
8266
8391
|
"documentUrlPatterns": {
|
|
8267
8392
|
"type": "array",
|
|
@@ -8600,7 +8725,7 @@
|
|
|
8600
8725
|
"items": {
|
|
8601
8726
|
"$ref": "ThemeIcons"
|
|
8602
8727
|
},
|
|
8603
|
-
"description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. Note
|
|
8728
|
+
"description": "Specifies dark and light icons to be used with themes. The ``light`` icon is used on dark backgrounds and vice versa. **Note:** The default theme uses the ``default_icon`` for light backgrounds (if specified)."
|
|
8604
8729
|
},
|
|
8605
8730
|
"default_popup": {
|
|
8606
8731
|
"type": "string",
|
|
@@ -9108,7 +9233,7 @@
|
|
|
9108
9233
|
{
|
|
9109
9234
|
"name": "onClicked",
|
|
9110
9235
|
"type": "function",
|
|
9111
|
-
"description": "Fired when a messageDisplayAction icon is clicked.
|
|
9236
|
+
"description": "Fired when a messageDisplayAction icon 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 <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/User_actions>`__ apply.",
|
|
9112
9237
|
"parameters": [
|
|
9113
9238
|
{
|
|
9114
9239
|
"name": "tab",
|
|
@@ -9365,7 +9490,7 @@
|
|
|
9365
9490
|
}
|
|
9366
9491
|
},
|
|
9367
9492
|
{
|
|
9368
|
-
"id": "
|
|
9493
|
+
"id": "MessageAttachment",
|
|
9369
9494
|
"type": "object",
|
|
9370
9495
|
"description": "Represents an attachment in a message.",
|
|
9371
9496
|
"properties": {
|
|
@@ -9605,7 +9730,7 @@
|
|
|
9605
9730
|
{
|
|
9606
9731
|
"type": "array",
|
|
9607
9732
|
"items": {
|
|
9608
|
-
"$ref": "
|
|
9733
|
+
"$ref": "MessageAttachment"
|
|
9609
9734
|
}
|
|
9610
9735
|
}
|
|
9611
9736
|
]
|
|
@@ -9615,7 +9740,7 @@
|
|
|
9615
9740
|
{
|
|
9616
9741
|
"name": "getAttachmentFile",
|
|
9617
9742
|
"type": "function",
|
|
9618
|
-
"description": "Gets the content of
|
|
9743
|
+
"description": "Gets the content of a :ref:`messages.MessageAttachment` as a DOM <code>File</code> object.",
|
|
9619
9744
|
"async": "callback",
|
|
9620
9745
|
"parameters": [
|
|
9621
9746
|
{
|
|
@@ -11349,7 +11474,7 @@
|
|
|
11349
11474
|
{
|
|
11350
11475
|
"name": "onFocusChanged",
|
|
11351
11476
|
"type": "function",
|
|
11352
|
-
"description": "Fired when the currently focused window changes. Will be :ref:`windows.WINDOW_ID_NONE`) if all browser windows have lost focus. Note
|
|
11477
|
+
"description": "Fired when the currently focused window changes. Will be :ref:`windows.WINDOW_ID_NONE`) if all browser windows have lost focus. **Note:** On some Linux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one browser window to another.",
|
|
11353
11478
|
"filters": [
|
|
11354
11479
|
{
|
|
11355
11480
|
"name": "windowTypes",
|