Scheduling (KartikTalwar#567)

* Add support for send scheduled message event

* Update README.md

Add more info about `send_message` and `send_scheduled_message` events

Author: andrii-lavreniuk

README.md

@@ -210,7 +210,8 @@ gmail.observe.on("load", function(){
   - **`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
-  - **`send_message`** - When a message is sent
+  - **`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
@@ -774,7 +775,8 @@ Your callback will be fired directly after Gmail's XMLHttpRequest has been sent
   - **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
-  - **send_message** - When a message is sent
+  - **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
@@ -893,6 +895,10 @@ gmail.observe.on("send_message", function(url, body, data, xhr) {
   console.log("url:", url, 'body', body, 'email_data', data, 'xhr', xhr);
 })
 
+gmail.observe.on("send_scheduled_message", function(url, body, data, xhr) {
+  console.log("url:", url, 'body', body, 'email_data', data, 'xhr', xhr);
+})
+
 gmail.observe.on("expand_categories", function(url, body, data, xhr) {
   console.log("url:", url, 'body', body, 'expanded_data', data, 'xhr', xhr);
 })

src/gmail.d.ts

@@ -717,7 +717,7 @@ declare type GmailBindAction =
     | 'label' | 'archive' | 'move_to_inbox' | 'delete_forver' | 'delete_message_in_thread'
     | 'restore_message_in_thread' | 'star' | 'unstar' | 'mark_as_important' | "load"
     | 'mark_as_not_important' | 'filter_messages_like_these' | 'mute' | 'unmute'
-    | 'add_to_tasks' | 'move_label' | 'save_draft' | 'discard_draft' | 'send_message'
+    | 'add_to_tasks' | 'move_label' | 'save_draft' | 'discard_draft' | 'send_message' | 'send_scheduled_message'
     | 'expand_categories' | 'delete_label' | 'show_newly_arrived_message' | 'poll'
     | 'new_email' | 'refresh' | 'open_email' | 'upload_attachment' | 'compose'
     | 'compose_cancelled' | 'recipient_change' | 'view_thread' | 'view_email'

src/gmail.js

@@ -1366,10 +1366,12 @@ var Gmail = function(localJQuery) {
             for (let key in email) {
                 let prop = email[key];
                 if (api.check.data.is_smartlabels_array(prop)) {
+                    // TODO: parse `email` for contents, and provide a better strucutred
+                    // object
                     if (prop.indexOf("^pfg") !== -1) {
-                        // TODO: parse `email` for contents, and provide a better strucutred
-                        // object
                         events.send_message = [params.url, params.body, email];
+                    } else if (prop.indexOf("^scheduled") > -1) {
+                        events.send_scheduled_message = [params.url, params.body, email];
                     }
                 }
             }