webext-schema 5.2.8 → 5.2.10

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.
@@ -1704,6 +1704,24 @@
1704
1704
  "os_update",
1705
1705
  "periodic"
1706
1706
  ]
1707
+ },
1708
+ {
1709
+ "id": "OnPerformanceWarningCategory",
1710
+ "type": "string",
1711
+ "enum": [
1712
+ "content_script"
1713
+ ],
1714
+ "description": "The performance warning event category, e.g. 'content_script'."
1715
+ },
1716
+ {
1717
+ "id": "OnPerformanceWarningSeverity",
1718
+ "type": "string",
1719
+ "enum": [
1720
+ "low",
1721
+ "medium",
1722
+ "high"
1723
+ ],
1724
+ "description": "The performance warning event severity. Will be 'high' for serious and user-visible issues."
1707
1725
  }
1708
1726
  ],
1709
1727
  "properties": {
@@ -2281,6 +2299,36 @@
2281
2299
  "description": "The reason that the event is being dispatched."
2282
2300
  }
2283
2301
  ]
2302
+ },
2303
+ {
2304
+ "name": "onPerformanceWarning",
2305
+ "type": "function",
2306
+ "description": "Fired when a runtime performance issue is detected with the extension. Observe this event to be proactively notified of runtime performance problems with the extension.",
2307
+ "parameters": [
2308
+ {
2309
+ "type": "object",
2310
+ "name": "details",
2311
+ "properties": {
2312
+ "category": {
2313
+ "$ref": "OnPerformanceWarningCategory",
2314
+ "description": "The performance warning event category, e.g. 'content_script'."
2315
+ },
2316
+ "severity": {
2317
+ "$ref": "OnPerformanceWarningSeverity",
2318
+ "description": "The performance warning event severity, e.g. 'high'."
2319
+ },
2320
+ "tabId": {
2321
+ "type": "integer",
2322
+ "optional": true,
2323
+ "description": "The $(ref:tabs.Tab) that the performance warning relates to, if any."
2324
+ },
2325
+ "description": {
2326
+ "type": "string",
2327
+ "description": "An explanation of what the warning means, and hopefully how to address it."
2328
+ }
2329
+ }
2330
+ }
2331
+ ]
2284
2332
  }
2285
2333
  ]
2286
2334
  }
@@ -5760,51 +5808,6 @@
5760
5808
  "type": "object",
5761
5809
  "description": "Used by various functions to represent the state of a message being composed. Note that functions using this type may have a partial implementation.",
5762
5810
  "properties": {
5763
- "identityId": {
5764
- "type": "string",
5765
- "description": "The ID of an identity from the :doc:`accounts`. The settings from the identity will be used in the composed message. If ``replyTo`` is also specified, the ``replyTo`` property of the identity is overridden. The permission <permission>accountsRead</permission> is required to include the ``identityId``.",
5766
- "optional": true
5767
- },
5768
- "from": {
5769
- "$ref": "ComposeRecipient",
5770
- "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.",
5771
- "optional": true
5772
- },
5773
- "to": {
5774
- "$ref": "ComposeRecipientList",
5775
- "optional": true
5776
- },
5777
- "cc": {
5778
- "$ref": "ComposeRecipientList",
5779
- "optional": true
5780
- },
5781
- "bcc": {
5782
- "$ref": "ComposeRecipientList",
5783
- "optional": true
5784
- },
5785
- "overrideDefaultFcc": {
5786
- "type": "boolean",
5787
- "optional": true,
5788
- "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."
5789
- },
5790
- "overrideDefaultFccFolder": {
5791
- "choices": [
5792
- {
5793
- "$ref": "folders.MailFolderId"
5794
- },
5795
- {
5796
- "$ref": "folders.MailFolder"
5797
- },
5798
- {
5799
- "type": "string",
5800
- "enum": [
5801
- ""
5802
- ]
5803
- }
5804
- ],
5805
- "optional": true,
5806
- "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."
5807
- },
5808
5811
  "additionalFccFolder": {
5809
5812
  "choices": [
5810
5813
  {
@@ -5823,58 +5826,80 @@
5823
5826
  "description": "An additional fcc folder which can be selected while composing the message, an empty string if not used.",
5824
5827
  "optional": true
5825
5828
  },
5826
- "replyTo": {
5827
- "$ref": "ComposeRecipientList",
5829
+ "attachVCard": {
5830
+ "type": "boolean",
5831
+ "optional": true,
5832
+ "description": "Whether or not the vCard of the used identity will be attached to the message during send. **Note:** If the value has not been modified, selecting a different identity will load the default value of the new identity."
5833
+ },
5834
+ "attachments": {
5835
+ "type": "array",
5836
+ "items": {
5837
+ "choices": [
5838
+ {
5839
+ "$ref": "FileAttachment"
5840
+ },
5841
+ {
5842
+ "$ref": "ComposeAttachment"
5843
+ }
5844
+ ]
5845
+ },
5846
+ "description": "Only used in the begin* functions. Attachments to add to the message.",
5828
5847
  "optional": true
5829
5848
  },
5830
- "followupTo": {
5849
+ "bcc": {
5831
5850
  "$ref": "ComposeRecipientList",
5832
5851
  "optional": true
5833
5852
  },
5834
- "newsgroups": {
5835
- "description": "A single newsgroup name or an array of newsgroup names.",
5836
- "choices": [
5837
- {
5838
- "type": "string"
5839
- },
5840
- {
5841
- "type": "array",
5842
- "items": {
5843
- "type": "string"
5844
- }
5845
- }
5846
- ],
5853
+ "body": {
5854
+ "type": "string",
5855
+ "description": "The HTML content of the message.",
5847
5856
  "optional": true
5848
5857
  },
5849
- "relatedMessageId": {
5850
- "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.",
5851
- "$ref": "messages.MessageId",
5858
+ "cc": {
5859
+ "$ref": "ComposeRecipientList",
5852
5860
  "optional": true
5853
5861
  },
5854
- "subject": {
5855
- "type": "string",
5862
+ "customHeaders": {
5863
+ "type": "array",
5864
+ "items": {
5865
+ "$ref": "CustomHeader"
5866
+ },
5867
+ "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.",
5856
5868
  "optional": true
5857
5869
  },
5858
- "type": {
5870
+ "deliveryFormat": {
5859
5871
  "type": "string",
5860
- "description": "Read-only. The type of the message being composed, depending on how the compose window was opened by the user.",
5861
5872
  "enum": [
5862
- "draft",
5863
- "new",
5864
- "redirect",
5865
- "reply",
5866
- "forward"
5873
+ "auto",
5874
+ "plaintext",
5875
+ "html",
5876
+ "both"
5867
5877
  ],
5878
+ "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).",
5868
5879
  "optional": true
5869
5880
  },
5870
- "body": {
5871
- "type": "string",
5872
- "description": "The HTML content of the message.",
5881
+ "deliveryStatusNotification": {
5882
+ "type": "boolean",
5883
+ "optional": true,
5884
+ "description": "Let the sender know when the recipient's server received the message. Not supported by all servers."
5885
+ },
5886
+ "followupTo": {
5887
+ "$ref": "ComposeRecipientList",
5873
5888
  "optional": true
5874
5889
  },
5875
- "plainTextBody": {
5890
+ "from": {
5891
+ "$ref": "ComposeRecipient",
5892
+ "description": "*Caution*: Setting a value for ``from`` does not change the used identity, it overrides the <value>From</value> header. Many email servers do not accept emails where the <value>From</value> header does not match the sender identity. Must be set to exactly one valid email address.",
5893
+ "optional": true
5894
+ },
5895
+ "identityId": {
5876
5896
  "type": "string",
5877
- "description": "The plain text content of the message.",
5897
+ "description": "The ID of an identity from the :doc:`accounts`. The settings from the identity will be used in the composed message. If ``replyTo`` is also specified, the ``replyTo`` property of the identity is overridden. The permission <permission>accountsRead</permission> is required to include the ``identityId``.",
5898
+ "optional": true
5899
+ },
5900
+ "isModified": {
5901
+ "type": "boolean",
5902
+ "description": "Whether the composer is considered modified by the user. A modified composer asks for confirmation, when it is closed.",
5878
5903
  "optional": true
5879
5904
  },
5880
5905
  "isPlainText": {
@@ -5882,23 +5907,47 @@
5882
5907
  "description": "Whether the message is an HTML message or a plain text message.",
5883
5908
  "optional": true
5884
5909
  },
5885
- "deliveryFormat": {
5886
- "type": "string",
5887
- "enum": [
5888
- "auto",
5889
- "plaintext",
5890
- "html",
5891
- "both"
5910
+ "newsgroups": {
5911
+ "description": "A single newsgroup name or an array of newsgroup names.",
5912
+ "choices": [
5913
+ {
5914
+ "type": "string"
5915
+ },
5916
+ {
5917
+ "type": "array",
5918
+ "items": {
5919
+ "type": "string"
5920
+ }
5921
+ }
5892
5922
  ],
5893
- "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).",
5894
5923
  "optional": true
5895
5924
  },
5896
- "customHeaders": {
5897
- "type": "array",
5898
- "items": {
5899
- "$ref": "CustomHeader"
5900
- },
5901
- "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.",
5925
+ "overrideDefaultFcc": {
5926
+ "type": "boolean",
5927
+ "optional": true,
5928
+ "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."
5929
+ },
5930
+ "overrideDefaultFccFolder": {
5931
+ "choices": [
5932
+ {
5933
+ "$ref": "folders.MailFolderId"
5934
+ },
5935
+ {
5936
+ "$ref": "folders.MailFolder"
5937
+ },
5938
+ {
5939
+ "type": "string",
5940
+ "enum": [
5941
+ ""
5942
+ ]
5943
+ }
5944
+ ],
5945
+ "optional": true,
5946
+ "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."
5947
+ },
5948
+ "plainTextBody": {
5949
+ "type": "string",
5950
+ "description": "The plain text content of the message.",
5902
5951
  "optional": true
5903
5952
  },
5904
5953
  "priority": {
@@ -5913,34 +5962,38 @@
5913
5962
  "description": "The priority of the message.",
5914
5963
  "optional": true
5915
5964
  },
5965
+ "relatedMessageId": {
5966
+ "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.",
5967
+ "$ref": "messages.MessageId",
5968
+ "optional": true
5969
+ },
5970
+ "replyTo": {
5971
+ "$ref": "ComposeRecipientList",
5972
+ "optional": true
5973
+ },
5916
5974
  "returnReceipt": {
5917
5975
  "type": "boolean",
5918
5976
  "optional": true,
5919
5977
  "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."
5920
5978
  },
5921
- "deliveryStatusNotification": {
5922
- "type": "boolean",
5923
- "optional": true,
5924
- "description": "Let the sender know when the recipient's server received the message. Not supported by all servers."
5979
+ "subject": {
5980
+ "type": "string",
5981
+ "optional": true
5925
5982
  },
5926
- "attachVCard": {
5927
- "type": "boolean",
5928
- "optional": true,
5929
- "description": "Whether or not the vCard of the used identity will be attached to the message during send. **Note:** If the value has not been modified, selecting a different identity will load the default value of the new identity."
5983
+ "to": {
5984
+ "$ref": "ComposeRecipientList",
5985
+ "optional": true
5930
5986
  },
5931
- "attachments": {
5932
- "type": "array",
5933
- "items": {
5934
- "choices": [
5935
- {
5936
- "$ref": "FileAttachment"
5937
- },
5938
- {
5939
- "$ref": "ComposeAttachment"
5940
- }
5941
- ]
5942
- },
5943
- "description": "Only used in the begin* functions. Attachments to add to the message.",
5987
+ "type": {
5988
+ "type": "string",
5989
+ "description": "Read-only. The type of the message being composed, depending on how the compose window was opened by the user.",
5990
+ "enum": [
5991
+ "draft",
5992
+ "new",
5993
+ "redirect",
5994
+ "reply",
5995
+ "forward"
5996
+ ],
5944
5997
  "optional": true
5945
5998
  }
5946
5999
  }
@@ -5992,8 +6045,7 @@
5992
6045
  "properties": {
5993
6046
  "name": {
5994
6047
  "type": "string",
5995
- "description": "Name of a custom header, must have a <value>X-</value> prefix.",
5996
- "pattern": "^X-.*$"
6048
+ "description": "Name of a custom header, must be prefixed by <value>X-</value> (but not by <value>X-Mozilla-</value>) or be one of the explicitly allowed headers (<value>MSIP_Labels</value>)"
5997
6049
  },
5998
6050
  "value": {
5999
6051
  "type": "string"
@@ -6109,6 +6161,7 @@
6109
6161
  "type": "string",
6110
6162
  "description": "The used save mode.",
6111
6163
  "enum": [
6164
+ "autoSave",
6112
6165
  "draft",
6113
6166
  "template"
6114
6167
  ]
@@ -9767,7 +9820,7 @@
9767
9820
  }
9768
9821
  },
9769
9822
  {
9770
- "id": "SingleMenuIconPath",
9823
+ "id": "MenuIconPath",
9771
9824
  "choices": [
9772
9825
  {
9773
9826
  "type": "string",
@@ -9775,27 +9828,20 @@
9775
9828
  },
9776
9829
  {
9777
9830
  "type": "string",
9778
- "pattern": "^(moz-extension|blob):.*$"
9831
+ "pattern": "^(moz-extension|blob|http|https):.*$"
9779
9832
  }
9780
9833
  ],
9781
- "description": "The provided path may be a relative path to an icon file, an image <value>data:</value> URL, a <value>blob:</value> URL or a <value>moz-extension:<value> URL. The <value>data:</value> or <value>blob:</value> URLs can be retrieved as follows: <literalinclude>includes/DataBlobUrls.js<lang>JavaScript</lang></literalinclude>,"
9834
+ "description": "The path for a menu icon may be a relative path to an icon file, a <value>moz-extension:</value> URL, an image <value>data:</value> URL, a <value>blob:</value> URL, or a remote <value>http(s):</value> URL."
9782
9835
  },
9783
9836
  {
9784
- "id": "MenuIconPath",
9785
- "choices": [
9786
- {
9787
- "$ref": "SingleMenuIconPath"
9788
- },
9789
- {
9790
- "type": "object",
9791
- "patternProperties": {
9792
- "^[1-9]\\d*$": {
9793
- "$ref": "SingleMenuIconPath"
9794
- }
9795
- }
9837
+ "id": "MenuIconDictionary",
9838
+ "type": "object",
9839
+ "patternProperties": {
9840
+ "^[1-9]\\d*$": {
9841
+ "$ref": "MenuIconPath"
9796
9842
  }
9797
- ],
9798
- "description": "Either a <em>string</em> to specify a single icon path to be used for all sizes, or a <em>dictionary object</em> to specify paths for multiple icons 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>name</em> being a size and <em>value</em> being a path to the icon for the specified size. Example: <literalinclude>includes/IconPath.json<lang>JSON</lang></literalinclude>See the `MDN documentation about choosing icon sizes <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_action#choosing_icon_sizes>`__ for more information on this. "
9843
+ },
9844
+ "description": "A <em>dictionary object</em> to specify paths for multiple icons in different sizes, so the best matching icon can be used, instead of scaling a standard icon to fit the pixel density of the user's display. Each entry is a <em>name-value</em> pair, with <em>name</em> being a size and <em>value</em> being a :ref:`menus.MenuIconPath`. Example: <literalinclude>includes/IconPath.json<lang>JSON</lang></literalinclude>See the `MDN documentation about choosing icon sizes <https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_action#choosing_icon_sizes>`__ for more information on this. "
9799
9845
  }
9800
9846
  ],
9801
9847
  "functions": [
@@ -9830,7 +9876,14 @@
9830
9876
  "description": "The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension."
9831
9877
  },
9832
9878
  "icons": {
9833
- "$ref": "MenuIconPath",
9879
+ "choices": [
9880
+ {
9881
+ "$ref": "MenuIconPath"
9882
+ },
9883
+ {
9884
+ "$ref": "MenuIconDictionary"
9885
+ }
9886
+ ],
9834
9887
  "optional": true,
9835
9888
  "description": "Custom icons to display next to the menu item. Custom icons can only be set for items appearing in submenus."
9836
9889
  },
@@ -9971,7 +10024,14 @@
9971
10024
  "optional": true
9972
10025
  },
9973
10026
  "icons": {
9974
- "$ref": "MenuIconPath",
10027
+ "choices": [
10028
+ {
10029
+ "$ref": "MenuIconPath"
10030
+ },
10031
+ {
10032
+ "$ref": "MenuIconDictionary"
10033
+ }
10034
+ ],
9975
10035
  "optional": "omit-key-if-missing"
9976
10036
  },
9977
10037
  "title": {
@@ -11284,9 +11344,20 @@
11284
11344
  "type": "string",
11285
11345
  "optional": true
11286
11346
  },
11347
+ "decryptionStatus": {
11348
+ "type": "string",
11349
+ "optional": true,
11350
+ "description": "The decryption status, only available for the root part.",
11351
+ "enum": [
11352
+ "none",
11353
+ "skipped",
11354
+ "success",
11355
+ "fail"
11356
+ ]
11357
+ },
11287
11358
  "headers": {
11288
11359
  "type": "object",
11289
- "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>",
11360
+ "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>.",
11290
11361
  "optional": true,
11291
11362
  "additionalProperties": {
11292
11363
  "type": "array",
@@ -11595,6 +11666,18 @@
11595
11666
  "name": "messageId",
11596
11667
  "$ref": "messages.MessageId"
11597
11668
  },
11669
+ {
11670
+ "name": "options",
11671
+ "type": "object",
11672
+ "properties": {
11673
+ "decrypt": {
11674
+ "type": "boolean",
11675
+ "description": "Whether the message should be decrypted. If the message could not be decrypted, its parts are omitted. Defaults to true.",
11676
+ "optional": true
11677
+ }
11678
+ },
11679
+ "optional": true
11680
+ },
11598
11681
  {
11599
11682
  "type": "function",
11600
11683
  "name": "callback",
@@ -11621,6 +11704,11 @@
11621
11704
  "name": "options",
11622
11705
  "type": "object",
11623
11706
  "properties": {
11707
+ "decrypt": {
11708
+ "type": "boolean",
11709
+ "description": "Whether the message should be decrypted. Throws, if the message could not be decrypted.",
11710
+ "optional": true
11711
+ },
11624
11712
  "data_format": {
11625
11713
  "choices": [
11626
11714
  {
@@ -11641,7 +11729,8 @@
11641
11729
  "BinaryString"
11642
11730
  ]
11643
11731
  }
11644
- ]
11732
+ ],
11733
+ "optional": true
11645
11734
  }
11646
11735
  },
11647
11736
  "optional": true
@@ -11737,7 +11826,7 @@
11737
11826
  {
11738
11827
  "name": "partNames",
11739
11828
  "type": "array",
11740
- "description": "An array of attachments, identifiying the to be detached attachments by their <value>partName</value>.",
11829
+ "description": "An array of attachments, identifying the to be deleted attachments by their <value>partName</value>.",
11741
11830
  "items": {
11742
11831
  "type": "string",
11743
11832
  "pattern": "^\\d+(\\.\\d+)*$"
@@ -12032,7 +12121,7 @@
12032
12121
  {
12033
12122
  "name": "delete",
12034
12123
  "type": "function",
12035
- "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>",
12124
+ "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.",
12036
12125
  "async": true,
12037
12126
  "permissions": [
12038
12127
  "messagesDelete"
@@ -12168,15 +12257,15 @@
12168
12257
  {
12169
12258
  "type": "string",
12170
12259
  "name": "color",
12171
- "description": "Tag color in hex format (i.e.: <value>#000080</value> for navy blue)",
12172
- "pattern": "^#[0-9a-f]{6}"
12260
+ "description": "Tag color in hex format (i.e.: <value>#000080</value> for navy blue). Value will be stored as upper case.",
12261
+ "pattern": "^#[0-9a-fA-F]{6}"
12173
12262
  }
12174
12263
  ]
12175
12264
  },
12176
12265
  {
12177
12266
  "name": "updateTag",
12178
12267
  "type": "function",
12179
- "description": "Updates a message tag.",
12268
+ "description": "Updates a message tag. Throws if the specified tag key does not exist.",
12180
12269
  "async": true,
12181
12270
  "permissions": [
12182
12271
  "messagesTags"
@@ -12201,8 +12290,8 @@
12201
12290
  },
12202
12291
  "color": {
12203
12292
  "type": "string",
12204
- "pattern": "^#[0-9a-f]{6}",
12205
- "description": "Tag color in hex format (i.e.: #000080 for navy blue).",
12293
+ "pattern": "^#[0-9a-fA-F]{6}",
12294
+ "description": "Tag color in hex format (i.e.: #000080 for navy blue). Value will be stored as upper case.",
12206
12295
  "optional": "true"
12207
12296
  }
12208
12297
  }
@@ -12328,15 +12417,15 @@
12328
12417
  {
12329
12418
  "type": "string",
12330
12419
  "name": "color",
12331
- "description": "Tag color in hex format (i.e.: #000080 for navy blue)",
12332
- "pattern": "^#[0-9a-f]{6}"
12420
+ "description": "Tag color in hex format (i.e.: #000080 for navy blue). Value will be stored as upper case.",
12421
+ "pattern": "^#[0-9a-fA-F]{6}"
12333
12422
  }
12334
12423
  ]
12335
12424
  },
12336
12425
  {
12337
12426
  "name": "update",
12338
12427
  "type": "function",
12339
- "description": "Updates a message tag.",
12428
+ "description": "Updates a message tag. Throws if the specified tag key does not exist.",
12340
12429
  "async": true,
12341
12430
  "permissions": [
12342
12431
  "messagesTags"
@@ -12359,8 +12448,8 @@
12359
12448
  },
12360
12449
  "color": {
12361
12450
  "type": "string",
12362
- "pattern": "^#[0-9a-f]{6}",
12363
- "description": "Tag color in hex format (i.e.: #000080 for navy blue).",
12451
+ "pattern": "^#[0-9a-fA-F]{6}",
12452
+ "description": "Tag color in hex format (i.e.: #000080 for navy blue). Value will be stored as upper case.",
12364
12453
  "optional": "true"
12365
12454
  }
12366
12455
  }
@@ -13293,7 +13382,7 @@
13293
13382
  "url": {
13294
13383
  "type": "string",
13295
13384
  "optional": true,
13296
- "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."
13385
+ "description": "The URL to navigate the tab to initially. If the URL points to a content page (a web page, an extension page or a registered WebExtension protocol handler page), the tab will navigate to the requested page. All other URLs will be opened externally after creating an empty tab. 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 root of the extension. "
13297
13386
  },
13298
13387
  "active": {
13299
13388
  "type": "boolean",
@@ -13947,6 +14036,95 @@
13947
14036
  ]
13948
14037
  }
13949
14038
  ],
14039
+ "utilities.json": [
14040
+ {
14041
+ "namespace": "messengerUtilities",
14042
+ "types": [
14043
+ {
14044
+ "id": "ParsedMailbox",
14045
+ "type": "object",
14046
+ "description": "Representation of a parsed mailbox string (see RFC 5322, section 3.4).",
14047
+ "properties": {
14048
+ "name": {
14049
+ "type": "string",
14050
+ "optional": true,
14051
+ "description": "The <value>display-name</value> associated with the provided address or group, if available."
14052
+ },
14053
+ "email": {
14054
+ "type": "string",
14055
+ "optional": true,
14056
+ "description": "The <value>addr-spec</value> associated with the provided address, if available."
14057
+ },
14058
+ "group": {
14059
+ "type": "array",
14060
+ "optional": true,
14061
+ "items": {
14062
+ "$ref": "messengerUtilities.ParsedMailbox"
14063
+ },
14064
+ "description": "The members of the group, if available."
14065
+ }
14066
+ }
14067
+ }
14068
+ ],
14069
+ "functions": [
14070
+ {
14071
+ "name": "formatFileSize",
14072
+ "type": "function",
14073
+ "description": "Returns the provided file size in a human readable format (e.g. <value>12 bytes</value> or <value>11,4 GB</value>).",
14074
+ "async": "callback",
14075
+ "parameters": [
14076
+ {
14077
+ "type": "integer",
14078
+ "name": "sizeInBytes",
14079
+ "description": "The size in bytes."
14080
+ },
14081
+ {
14082
+ "type": "function",
14083
+ "name": "callback",
14084
+ "optional": true,
14085
+ "parameters": [
14086
+ {
14087
+ "type": "string"
14088
+ }
14089
+ ]
14090
+ }
14091
+ ]
14092
+ },
14093
+ {
14094
+ "name": "parseMailboxString",
14095
+ "type": "function",
14096
+ "description": "Parse a mailbox string containing one or more email addresses (see RFC 5322, section 3.4).",
14097
+ "async": "callback",
14098
+ "parameters": [
14099
+ {
14100
+ "type": "string",
14101
+ "name": "mailboxString",
14102
+ "description": "The string to be parsed (e.g. <value>User <user@example.com>, other-user@example.com</value>)"
14103
+ },
14104
+ {
14105
+ "type": "boolean",
14106
+ "name": "preserveGroups",
14107
+ "optional": true,
14108
+ "description": "Keep grouped hierachies. Groups may be specified in a mailbox string as follows: <value>GroupName : user1 <user1@example.com>, user2@example,com ;</value>."
14109
+ },
14110
+ {
14111
+ "type": "function",
14112
+ "name": "callback",
14113
+ "optional": true,
14114
+ "parameters": [
14115
+ {
14116
+ "type": "array",
14117
+ "items": {
14118
+ "$ref": "messengerUtilities.ParsedMailbox"
14119
+ }
14120
+ }
14121
+ ]
14122
+ }
14123
+ ]
14124
+ }
14125
+ ]
14126
+ }
14127
+ ],
13950
14128
  "windows.json": [
13951
14129
  {
13952
14130
  "namespace": "windows",
@@ -14198,7 +14376,7 @@
14198
14376
  "default": {},
14199
14377
  "properties": {
14200
14378
  "url": {
14201
- "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.",
14379
+ "description": "A URL to be opened in a popup window, ignored in all other window types. This may also be an array, but only the first element is used (popup windows may not have multiple tabs). If the URL points to a content page (a web page, an extension page or a registered WebExtension protocol handler page), the popup window will navigate to the requested page. All other URLs will be opened externally after creating an empty popup 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 root of the extension. Defaults to the New Tab Page.",
14202
14380
  "optional": true,
14203
14381
  "choices": [
14204
14382
  {