[pull] master from KartikTalwar:master

.editorconfig

@@ -0,0 +1,17 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false
+
+[*.{ts,js,json}]
+quote_type = double
+indent_style = space
+indent_size = 4

.github/workflows/node.js.yml

@@ -16,14 +16,20 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x]
+        node-version: [20.x, 22.x, 24.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v5
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm install
+    - run: npm ci
     - run: npm run ci
+
+    - name: Publish Unit Test Results
+      uses: EnricoMi/publish-unit-test-result-action@v2
+      if: always()
+      with:
+        files: junit.xml

.gitignore

@@ -1,4 +1,7 @@
 .DS_Store
+.idea
 node_modules
 **/*~
 **/.#*
+coverage
+junit.xml

CHANGELOG.md

@@ -1,6 +1,113 @@
 
 # Changelog
 
+## Version 1.1.16
+
+- Fix errors in `view_thread` event handler. Thanks @ek23 !
+
+## Version 1.1.15
+
+- Fix errors in typescript type-definitions. Thanks @BasSchoutenTribe !
+  (No changes in runtime code)
+
+## Version 1.1.14
+
+- Fix regression in DOM observers, introduced in 1.1.13. Thanks @kinkoazc!
+
+## Version 1.1.13
+
+- Drop bundled jQuery, support jQuery 4, support explicit no-jQuery mode
+- Fix reply button selector to support Gmail in text labels mode
+- Fix `api.get.user_email()`.
+
+## Version 1.1.12
+
+- Use MutationObserver for DOM Node changes. Thanks @cancan101!
+- Fix issue in `api.dom.compose.is_inline()`.  Thanks @MadcowD!
+
+## Version 1.1.11
+
+- Fix `api.observe.on("view_email", ...)` not working.
+
+## Version 1.1.10
+
+- Fix `api.dom.right_toolbar()`, by @stevepeak.
+
+## Version 1.1.9
+
+- Fix `api.helper.get.is_delegated_inbox`, by @moodsey211.
+
+## Version 1.1.8
+
+- Fix incorrect variable name in GmailCache definition
+
+## Version 1.1.7
+
+- Fix for `api.tools.parse_attachment_url`.
+
+## Version 1.1.6
+
+- Better fix for `view_thread` event not triggeriong, by @cancan101.
+
+## Version 1.1.5
+
+- Improved parsing of embedded json data, by @onestep.
+- Tentative fix for `view_thread` event not triggeriong, by @cancan101.
+
+## Version 1.1.4
+
+- Fix subject-value in `api.observe.on("send_message")` event-data, by @cancan101.
+
+## Version 1.1.3
+
+- Even more fixes for `api.observe.on("send_message")` by @huksley.
+
+## Version 1.1.2
+
+- Try some fixes for `api.observe.on("send_message")`.
+
+## Version 1.1.1
+
+- More fixes for `api.new.get.email_data()` and `api.new.get.thread_data()`.
+
+## Version 1.1.0
+
+- First release to fix new XHR format in Gmail. This fixes
+  `api.new.get.email_data()` and `api.new.get.thread_data()`.
+
+## Version 1.0.23
+
+- Fix error in `insertion_observer()`.
+- Remove no longer working functions: `gmail.get.loggedin_accounts()`,
+  `gmail.get.manager_email()` and `gmail.get.delegated_to_email()`.
+
+## Version 1.0.22
+
+- Fix incompatibility with Mixmax extension. Thanks @DrParanoia!
+
+## Version 1.0.21
+
+- Various typescript type-improvements. Thanks again @cancan101!
+- Fix errors when trying to prefetch email-data. Once again, thanks to @cancan101!
+- Introduce new function `gmail.tools.add_more_send_option()`. Even more thanks to @cancan101!
+- Make `gmail.get.email_source_*()` handle new-style and old-style identifiers natively.
+
+## Version 1.0.20
+
+- Fix error in TypeScript type-definitions. No functional/runtime changes. Thanks @cancan101
+
+## Version 1.0.19
+
+- Fix compose button being duplicated when using `gmail.tools.add_compose_button` more than once.
+
+## Version 1.0.18
+
+- Fix parsing of attachments in emails form embedded JSON. Thanks @onestep!
+
+## Version 1.0.17
+
+- Fix ussyes with `gmail.dom.visible_messages()`. Thanks @mhatvan!
+
 ## Version 1.0.16
 
 - Fix `gmail.observe.on("http_event")` and `gmail.observe.after("http_event")` triggers to receive all XHR requests.

README.md

@@ -1,6 +1,6 @@
 # Gmail.js - JavaScript API for Gmail
 
-![Node.js CI](https://github.com/KartikTalwar/gmail.js/workflows/Node.js%20CI/badge.svg?branch=master)
+![Node.js CI](https://github.com/KartikTalwar/gmail.js/actions/workflows/node.js.yml/badge.svg?branch=master)
 [![npm](https://img.shields.io/npm/v/gmail-js.svg)](https://www.npmjs.com/package/gmail-js)
 
 ### What Gmail.js is and isn't
@@ -44,20 +44,6 @@ For a ready to use example/boilerplate repo, look no further:
 
 - **[GmailJS Node Boilerplate](https://github.com/josteink/gmailjs-node-boilerplate)** - Example for how to create a browser-extension using GmailJS and modern javascript with NodeJS and script-bundling for instant load-times.
 
-### Content Security Policy (legacy advice)
-
-In earlier advice given w.r.t. deployment of GmailJS, where scripts were injected one by
-one, with cumbersome loading and probing mechanisms, CSP could be an
-problem causing your extension to fail if GmailJS was injected incorrectly.
-
-If you use modern javascript and script-bundling in your extension (like in the boilerplate example), CSP will not interfere with loading
-of your extension, nor GmailJS.
-
-If you have any issues with CSP, the general advice is to build your extension using script-bundling and eliminate the cause of the error
-all together.
-
-While you may be able to make it work, legacy loading is no longer considered supported by GmailJS.
-
 ## Typescript
 
 Using gmail-js with TypeScript is relatively easy, but if you use normal `import` syntax it
@@ -69,6 +55,14 @@ const gmail = new GmailFactory.Gmail() as Gmail;
 // working on the gmail-object now provides type-safety.
 ````
 
+You will also have to import the types somewhere, like in a file called `types.d.ts` in your project:
+
+````typescript
+import "gmail-js";
+````
+
+
+
 ## Methods
 
 ### Summary (click for more info)
@@ -158,12 +152,6 @@ const gmail = new GmailFactory.Gmail() as Gmail;
 
 
 #### OBSERVE
-It is considered best practice to wait for the gmail interface to be loaded before observing any XHR actions.
-```js
-gmail.observe.on("load", function(){
-    //... now you can safely register other observers using gmail.observe.on
-});
-```
 
 - [gmail.observe**.http_requests()**](#gmailobservehttp_requests)
 - [gmail.observe**.actions()**](#gmailobserveactions)
@@ -184,7 +172,7 @@ gmail.observe.on("load", function(){
   - **`mark_as_spam`** - When a conversation(s) is marked as spam
   - **`mark_as_not_spam`** - When a conversation(s) is unchecked as spam
   - **`label`** - When a conversation(s) get applied a label
-  - **`archive`** - When a conversation(s) is archieved
+  - **`archive`** - When a conversation(s) is archived
   - **`move_to_inbox`** - When a conversation(s) is moved to the inbox
   - **`delete_forever`** - When a conversation(s) is deleted forever
   - **`star`** - When a conversation(s) is starred
@@ -198,7 +186,7 @@ gmail.observe.on("load", function(){
   - **`add_to_tasks`** - When an item is added to google tasks
   - **`move_label`** - When a conversation(s) is moved to a label folder
   - **`save_draft`** - When a draft is saved
-  - **`discard_draft`** - When a draft is dicarded
+  - **`discard_draft`** - When a draft is discarded
   - **`send_message`** - When a message is sent (except scheduled messages)
   - **`send_scheduled_message`** - When a message is scheduled for sending (but not actually sent)
   - **`expand_categories`** - When a category is expanded from the left nav sidebar
@@ -264,7 +252,8 @@ These are some helper functions that the rest of the methods use. See source for
 - gmail.tools**.toggle_minimize()**
 - [gmail.tools**.add_toolbar_button(content_html, onclick_action, custom_style_class)**](#gmailtoolsadd_toolbar_buttoncontent_html-onclick_action-custom_style_class)
 - [gmail.tools**.add_right_toolbar_button(content_html, onclick_action, custom_style_class)**](#gmailtoolsadd_right_toolbar_buttoncontent_html-onclick_action-custom_style_class)
-- [gmail.tools**.add_compose_button(compose_ref, content_html, onclick_action, custom_style_class)**](#gmailtoolsadd_toolbar_buttoncompose_ref-content_html-onclick_action-custom_style_class)
+- [gmail.tools**.add_compose_button(compose_ref, content_html, onclick_action, custom_style_class)**](#gmailtoolsadd_compose_buttoncompose_ref-content_html-onclick_action-custom_style_class)
+- [gmail.tools**.add_more_send_option(composeWindow, buttonText, onClickFunction, styleClass, imgClass)**](#gmailtoolsadd_more_send_optioncomposewindow-buttontext-onclickfunction-styleclass-imgclass)
 - [gmail.tools**.add_modal_window(title, content_html, onClickOk, onClickCancel, onClickClose)**](#gmailtoolsadd_modal_windowtitle-content_html-onClickOk-onClickCancel-onClickClose)
 - [gmail.tools**.remove_modal_window()**](#gmailtoolsremove_modal_window)
 
@@ -611,7 +600,7 @@ Returns `True` if user has multiple inbox lab enabled, `False` otherwise
 
 #### gmail.check.is_horizontal_split()
 
-Returns `True` if the pane split mode is horiontal `False` otherwise
+Returns `True` if the pane split mode is horizontal `False` otherwise
 
 #### gmail.check.are_shortcuts_enabled()
 
@@ -728,7 +717,7 @@ The items contain the sent requested parameterized data
 #### gmail.observe.actions()
 
 Similar to `gmail.observe.http_requests()` this keeps track of the last 10 gmail actions (vs all http requests).
-Actions here correspond to things like clicking refres, archiving, deleting, starring etc.
+Actions here correspond to things like clicking refresh, archiving, deleting, starring etc.
 
 #### gmail.observe.on(action, callback)
 
@@ -754,7 +743,7 @@ Your callback will be fired directly after Gmail's XMLHttpRequest has been sent
   - **mark_as_spam** - When a conversation(s) is marked as spam
   - **mark_as_not_spam** - When a conversation(s) is unchecked as spam
   - **label** - When a conversation(s) get applied a label
-  - **archive** - When a conversation(s) is archieved
+  - **archive** - When a conversation(s) is archived
   - **move_to_inbox** - When a conversation(s) is moved to the inbox
   - **delete_forever** - When a conversation(s) is deleted forever
   - **star** - When a conversation(s) is starred
@@ -768,23 +757,23 @@ Your callback will be fired directly after Gmail's XMLHttpRequest has been sent
   - **add_to_tasks** - When an item is added to google tasks
   - **move_label** - When a conversation(s) is moved to a label folder
   - **save_draft** - When a draft is saved
-  - **discard_draft** - When a draft is dicarded
+  - **discard_draft** - When a draft is discarded
   - **send_message** - When a message is sent (except scheduled messages)
   - **send_scheduled_message** - When a message is scheduled for sending (but not actually sent)
   - **expand_categories** - When a category is expanded from the left nav sidebar
   - **restore_message_in_thread** - When a deleted message is restored inside a thread
   - **delete_label** - When a label is deleted
   - **show_newly_arrived_message** - When inside an email and a new email arrives in the thread
 
-The on method also supports observering specific DOM events in the Gmail Interface (for example when a new compose window is opened). These are only available via the `on` method (not the `before` or `after` methods).
+The on method also supports observing specific DOM events in the Gmail Interface (for example when a new compose window is opened). These are only available via the `on` method (not the `before` or `after` methods).
 
 **Available DOM Actions/Observers**
 
  - **load** - When the gmail interface has completed loading
  - **compose** - When a new compose window opens, or a message is replied to or forwarded
  - **compose_cancelled** - When an existing compose window is closed.
  - **recipient_change** - When the recipient (to, cc or bcc) is changed when composing a new email or replying/forwarding an email
- - **view_thread** - When a new coversation thread is opened
+ - **view_thread** - When a new conversation thread is opened
  - **view_email** - When an individual email is loaded within a thread (also fires when thread loads displaying the latest email)
  - **load_email_menu** - When the dropdown menu next to the reply button is clicked
 
@@ -1033,7 +1022,7 @@ Simple:
 
 Complex:
   - action - the name of the new DOM observer
-  - args - an object containin properties for each of the supported DOM observer configuration agruments:
+  - args - an object containing properties for each of the supported DOM observer configuration arguments:
     - class - the class of an inserted DOM element that identifies that this action should be triggered
     - selector - if you need to match more than just the className of a specific element to indicate a match, you can use this selector for further checking (uses element.is(selector) on matched element). E.g. if there are multiple elements with a class indicating an observer should fire, but you only want it to fire on a specific id, then you would use this
     - sub_selector - if specified, we do a jquery element.find for the passed selector on the inserted element and ensure we can find a match
@@ -1084,7 +1073,7 @@ Returns basic data for all the messages currently visible in the messages view.
 
 ### gmail.dom.compose(compose_el)
 
-An object used to abstract interation with a compose popup.
+An object used to abstract interaction with a compose popup.
 Represents a compose window in the DOM and provides a bunch of methods and properties to access & interact with the window.
 
 Expects a jQuery DOM element for the compose div.
@@ -1102,6 +1091,7 @@ Compose methods:
 - **.id()** - retrieve the compose id
 - **.email_id()** - retrieve the draft email id
 - **.is_inline()** - is this compose instance inline (as with reply & forwards) or a popup (as with a new compose)
+- **.type()** - retrieve compose type - reply / forward / compose (new)
 - **.recipients(options)** - retrieves `to`, `cc`, `bcc` and returns them in a hash of arrays.
   Options:
   - *.type* - string  `to`, `cc`, or `bcc` to check a specific one
@@ -1292,6 +1282,18 @@ gmail.tools.add_compose_button(compose_ref, 'content_html', function() {
 }, 'Custom Style Classes');
 ```
 
+#### gmail.tools.add_more_send_option(composeWindow, buttonText, onClickFunction, styleClass, imgClass)
+
+Add button to "more send options" menu.
+You can use gmail.dom.composes() to get compose reference.
+
+```js
+var compose_ref = gmail.dom.composes()[0];
+gmail.tools.add_more_send_option(compose_ref, 'buttonText', function() {
+  // Code here
+}, 'Custom Style Classes', 'imgClass');
+```
+
 #### gmail.tools.add_attachment_button(attachment_ref, content_html, customCssClass, tooltip, onclick_action)
 
 Add a button to an attachment in email-view.
@@ -1374,7 +1376,7 @@ individual email IDs.
 **Note: This method can only be used with other deprecated methods,
 and is itself deprecated. Use `gmail.new.get.email_id()` instead.**
 
-Same as `gmail.get.thread_id()`, but kept for compatibilty.
+Same as `gmail.get.thread_id()`, but kept for compatibility.
 Using this method generates a warning!
 
 ```js