Gmail.js - JavaScript API for Gmail

!Node.js CI

$3

Gmail.js is meant to be used for creating WebExtension-based browser-extensions, for Chrome, Firefox and other compatible browsers.

It cannot be used server-side with Node, or from another web-app to interface with Gmail.

Note: This is not an official Gmail API, and isn't affiliated with Google.

Note: Gmail.js requires jQuery to work

$3

- Lots of API methods to work with gmail. See documentation below.
- Easy to use API. Data & DOM.
- Reasonably complete TypeScript-support.
- Compatible with both WebExtension Manifest V2 and V3.
- Many methods are contextual and will work with whatever is on screen when no arguments are given.
- Obtain email data, react to event, etc. No need for OAuth!
- Main methods allow you to observe certain events with gmail.observe.on('lots_of_actions_here', callback()) or similar gmail.observe.before(...) and gmail.observe.after(...)
- Create an issue/pull request for feedback, requests and fixes. See CONTRIBUTING.md for more details.

$3

If you know how to create WebExtensions-based extensions for Firefox and Chrome, you can get started by pulling Gmail.js like this:

``
npm install gmail-js
`

Note: Please ensure that Gmail.js is injected into the regular DOM.

Content-scripts which launch injected script must be configured with "run_at": "document_start".

It's recommended to split injected script to have only gmail.js load first because the size of the injected script impacts the loading time. Gmail.js must be injected and loaded before Gmail loads embedded data.

Gmail.js does not work as a content-script.

For a ready to use example/boilerplate repo, look no further:

- 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.

Typescript

Using gmail-js with TypeScript is relatively easy, but if you use normal import syntax it
will fail. Instead you need to use require-syntax to load it:

``typescript
const GmailFactory = require("gmail-js");
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

$3

#### GET


- gmail.get.user_email()
- gmail.get.manager_email()
- gmail.get.current_page()

- gmail.get.new.email_id()
- gmail.get.new.email_data()
- gmail.get.new.thread_id()
- gmail.get.new.thread_data()

- gmail.get.email_subject()
- gmail.get.compose_ids()
- gmail.get.email_source_async(identifier=undefined, callback, error_callback, preferBinary)
- gmail.get.email_source_promise(identifier=undefined, preferBinary)
- gmail.get.search_query()
- gmail.get.unread_emails()
- gmail.get.unread_inbox_emails()
- gmail.get.unread_draft_emails()
- gmail.get.unread_spam_emails()
- gmail.get.unread_forum_emails()
- gmail.get.unread_update_emails()
- gmail.get.unread_promotion_emails()
- gmail.get.unread_social_emails()
- gmail.get.last_active()
- gmail.get.storage_info()
- gmail.get.loggedin_accounts()
- gmail.get.beta()
- gmail.get.localization()

#### GET (deprecated methods)

- gmail.get.thread_id()
- gmail.get.email_id()
- gmail.get.email_ids()
- gmail.get.email_data(email_id=undefined)
- gmail.get.email_data_async(email_id=undefined, callback)
- gmail.get.displayed_email_data()
- gmail.get.displayed_email_data_async(callback)
- gmail.get.selected_emails_data()
- gmail.get.visible_emails()
- gmail.get.visible_emails_async(callback)

#### CHECK


- gmail.check.is_new_data_layer()
- gmail.check.is_new_gui()
- gmail.check.is_thread()
- gmail.check.is_inside_email()
- gmail.check.is_plain_text()
- gmail.check.is_preview_pane()
- gmail.check.is_multiple_inbox()
- gmail.check.is_horizontal_split()
- gmail.check.are_shortcuts_enabled()
- gmail.check.is_vertical_split()
- gmail.check.is_tabbed_inbox()
- gmail.check.is_right_side_chat()
- gmail.check.should_compose_fullscreen()
- gmail.check.is_conversation_view()
- gmail.check.is_google_apps_user()
- gmail.check.is_priority_inbox()
- gmail.check.is_rapportive_installed()
- gmail.check.is_streak_installed()
- gmail.check.is_anydo_installed()
- gmail.check.is_boomerang_installed()
- gmail.check.is_xobni_installed()
- gmail.check.is_signal_installed()


#### CHAT


- gmail.chat.is_hangouts()

$3

- gmail.compose.start_compose()


#### OBSERVE

- gmail.observe.http_requests()
- gmail.observe.actions()
- gmail.observe.register(action, class/args, parent) - registers a custom DOM observer
- gmail.observe.off(action,type)
- gmail.observe.on(action, callback)
- XHR observers
- load - When the gmail interface has finished loading
- http_event - When gmail any CRUD operation happens on gmail
- poll - When gmail automatically polls the server to check for new emails every few seconds
- new_email - When a new email appears in the inbox
- open_email - When an email is opened from the inbox view
- refresh - When you click the refresh button
- unread - When a conversation(s) is marked unread
- read - When a conversation(s) is marked read
- delete - When a conversation(s) is deleted
- delete_message_in_thread - When a conversation(s) is deleted inside a thread
- 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
- 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
- unstar - When a conversation(s) is unstarred
- undo_send - When the Undo Send button is clicked after trying to send a new email
- mark_as_important - When a conversation(s) is marked as important
- mark_as_not_important - When a conversation(s) is marked as not important
- filter_messages_like_these - When a filter button is triggered for a conversation
- mute - When a conversation(s) is muted
- unmute - When a conversation(s) is unmuted
- 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
- 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
- upload_attachment - When an attachment is being uploaded to an email being composed
- DOM observers
- compose - When a new compose window is opened, or a message is replied to or forwarded
- recipient_change - When an email being written (either new compose, reply or forward) has its to, cc or bcc recipients updated
- view_thread - When a conversation thread is opened to read
- *view_email - When an individual email is loaded within a conversation thread.
It's worth noting this event is only triggered when the email is actually rendered in the DOM. Gmail tends to cache the rendered emails, so it should not be expected to fire reliably for every viewing of the same email. It will most likely fire once, for the initial and possibly only rendering.
- load_email_menu - When the dropdown menu next to the reply button is clicked
- gmail.observe.before(action, callback)
- gmail.observe.after(action, callback)
- gmail.observe.bind(type, action, callback) - implements the on, after, before callbacks
- gmail.observe.on_dom(action, callback) - implements the DOM observers - called by gmail.observe.on
- gmail.observe.bound(action, type) - checks if a specific action and/or type has any bound observers
- gmail.observe.trigger(type, events, xhr) - fires any specified events for this type (on, after, before) with specified parameters

#### DOM

These methods return the DOM data itself

- gmail.dom.inboxes()
- gmail.dom.inbox_content()
- gmail.dom.visible_messages()
- gmail.dom.email_subject()
- gmail.dom.email_body()
- gmail.dom.email_contents()
- gmail.dom.get_left_sidebar_links()
- gmail.dom.header()
- gmail.dom.search_bar()
- gmail.dom.toolbar()
- gmail.dom.right_toolbar()
- gmail.dom.compose() - compose dom object - receives the DOM element for the compose window and provides methods to interact
- gmail.dom.composes() - retrieves an array of gmail.dom.compose objects representing any open compose windows
- gmail.dom.email() - email dom object - receives an email DOM element or email id for an email currently being viewed. Abstracts interaction with that email.
- gmail.dom.thread() - thread dom object - receives a conversation thread DOM element currently being viewed. Abstracts interaction with that thread.

#### TOOLS

These are some helper functions that the rest of the methods use. See source for input params

- gmail.tools.infobox(message, time)
+ Adds the yellow info box on top of gmail with the given message
- gmail.tools.rerender(callback)
+ Re-renders the UI using the available data.
- gmail.tools.xhr_watcher()
- gmail.tools.parse_url()
- gmail.tools.deparam()
- gmail.tools.parse_view_data()
- gmail.tools.parse_email_data()
- gmail.tools.extract_email_address(str)
- gmail.tools.extract_name(str)
- gmail.tools.make_request()
- gmail.tools.make_request_async()
- gmail.tools.make_request_download_promise(url, preferBinary) - function specialized for downloading email MIME messages or attachments.
- gmail.tools.sleep(ms)
- gmail.tools.multitry(ms_delay, tries, func, bool_success_check)
- gmail.tools.i18n(label)
- gmail.tools.toggle_minimize()
- gmail.tools.add_toolbar_button(content_html, onclick_action, custom_style_class)
- gmail.tools.add_right_toolbar_button(content_html, onclick_action, custom_style_class)
- gmail.tools.add_compose_button(compose_ref, content_html, onclick_action, custom_style_class)
- gmail.tools.add_more_send_option(composeWindow, buttonText, onClickFunction, styleClass, imgClass)
- gmail.tools.add_modal_window(title, content_html, onClickOk, onClickCancel, onClickClose)
- gmail.tools.remove_modal_window()

#### TRACKER

These are some of the variables that are tracked and kept in memory while the rest of the methods are in use.

- gmail.version
- gmail.tracker.events
- gmail.tracker.xhr_init
- gmail.tracker.xhr_open
- gmail.tracker.xhr_send
- gmail.tracker.watchdog
- gmail.tracker.view_data
- gmail.tracker.email_data
- gmail.tracker.ik
- gmail.tracker.rid

$3


#### gmail.new.get.email_id()

Obtains the new-style email-ID from the email currently on screen.
Extracted via DOM.

This ID can only be used by gmail.new.get.*-functions.

Can be provided email-element from HTML DOM, or Gmail DOMEmail object
to look up specific email ID.

#### gmail.new.get.thread_id()

Obtains the new-style thread-ID from the email currently on screen.
Extracted via DOM.

This ID can only be used by gmail.new.get.*-functions.

#### gmail.new.get.email_data(identifier)

Returns a data-object for the requested email, if found in the
email-cache.

identifier must be an object or string which uniquely identifies
an email:

- new-style email-id
- legacy-style email-id (will cause warning)
- DomEmail instance
- EmailData instance

If no email-data can be found in Gmail.JS email-cache,
null or undefined is returned instead.

This method returns immediately, uses no XHR, and has no
async-equivalent.

Please note: Email-data is intercepted and stored in the cache
only when Gmail itself has requested or used and email.

This typically happens when loading a label (pre-loading all emails in
view) or when navigating to view a full thread.

That means that calling the same method later may return data even if
the first invocation returned null.


`json
{
"id": "msg-f:1581064946762017791",
"legacy_email_id": "15f1123136926bff",
"thread_id": "thread-f:1581064946762017791",
"smtp_id": "<87zi8wmmhw.fsf@gmail.com>",
"subject": "[PATCH] Flymake support for C/C++",
"timestamp": 1507821032297,
"content_html": "Hi,
\n
\nHere's a proposal for supporting Flymake in C/C++. This patch...",
"date": "2017-10-12T15:10:32.297Z",
"from": {
"address": "joaotavora@gmail.com",
"name": ""
},
"to": [
{
"address": "emacs-devel@gnu.org"
}
],
"cc": [
{
"address": "acm@muc.de"
},
{
"address": "eliz@gnu.org"
}
],
"bcc": [],
"attachments": [
{
"attachment_id": "0.1",
"name": "0001-Add-a-Flymake-backend-for-C.patch",
"type": "application/x-patch",
"url": "https://mail.google.com/mail/?ui=2&ik=94da28fb67&attid=0.1&permmsgid=msg-f:1581064946762017791&th=15f1123136926bff&view=att&zw",
"size": 11225
}
]
}
`

#### gmail.new.get.thread_data(identifier)

Returns a data-object for the requested email-thread, if found in the
email-cache.

identifier must be an object or string which uniquely identifies
a thread:

- a new-style thread-id
- new-style email-id
- legacy-style email-id (will cause warning)
- DomEmail instance
- DomThread instance
- EmailData instance

If no thread-data can be found in Gmail.JS email-cache,
null or undefined is returned instead.

This method returns immediately, uses no XHR, and has no
async-equivalent.

Please note: Email-data is intercepted and stored in the cache
only when Gmail itself has requested or used and email.

This typically happens when loading a label (pre-loading all emails in
view) or when navigating to view a full thread.

That means that calling the same method later may return data even if
the first invocation returned null.


`json
{
"thread_id": "thread-f:1581064946762017791",
"emails": [...email_data elements...]
}
`

#### gmail.get.email_source(identifier=undefined)

Deprecated function. Will be removed. Migrate to
gmail.get.email_source_async or gmail.get.email_source_promise
instead.

#### gmail.get.email_source_async(identifier=undefined, callback, error_callback, preferBinary=false)

Retrieves raw MIME message source from the gmail server for the
specified email identifier.

identifier must be an object or string which uniquely identifies
an email:

- new-style email-id
- legacy-style email-id (will cause warning)
- DomEmail instance
- EmailData instance

If not specified, current email will be resolved automatically.

By default, once retrieved the resulting data will be passed to
callback in text-format. **This may corrupt the actual email
MIME-data, by causing irreversible content-encoding
consistency-errors.**

If you need to parse this data in a proper MIME-parser later, the only
way to avoid this kind of error is to download the data in binary
format and do your own decoding inside your own MIME-parser.

To get the email-source in binary form, you must set the
preferBinary-parameter to true.

#### gmail.get.email_source_promise(identifier=undefined, preferBinary=false)

Does the same as above but implements it using ES6 promises.


#### gmail.get.user_email()

Returns the current user's email address

`js
"california@gmail.com"
`

#### gmail.get.manager_email()

Returns the email address of the user currently managing the account (if the inbox is used by the owner, this function returns the same value as gmail.get.user_email())

`js
"california@gmail.com"
`

#### gmail.get.delegated_to_email()

Returns the email address of the user the account is currently delegated to (if the inbox is used by the owner, this function returns null)

`js
"california@gmail.com"
`

#### gmail.get.storage_info()

Returns current user's file storage stats

`json
{
"used": "0 GB",
"total": "15 GB",
"percent": 0
}
`

#### gmail.get.current_page()

Returns what page of gmail the user is currently on. These are the possible responses

`js
['sent', 'inbox', 'starred', 'drafts', 'imp', 'chats', 'all', 'spam', 'trash', 'circle'] // pages
"email" // inside email conversation
"/search/[.+]" // inside search view
"/label/[.+]" // inside label view
"/category/[.+]" // inside category view
"/settings/[.+]" // settings sub-page (excluding settings root page)
`

#### gmail.get.email_subject()

Returns the opened email's subject from the DOM

`js
"test"
`

$3

Returns the latest/last email id of emails that have been saved as drafts (currently open)

`js
["14469c73bba6ff53", "14469c7b8581ccfa"]
`


#### gmail.get.search_query()

Returns the search bar data

`js
"from:hi@kartikt.com is:unread"
`

#### gmail.get.unread_emails()

Returns a count of total unread emails for the current account.

`json
{
"inbox": 2,
"drafts": 0,
"spam": 0,
"forum": 0,
"notifications": 0,
"promotions": 0,
"social": 0
}
`

You can also request the data individually

- gmail.get.unread_inbox_emails()
- gmail.get.unread_draft_emails()
- gmail.get.unread_spam_emails()
- gmail.get.unread_forum_emails()
- gmail.get.unread_update_emails()
- gmail.get.unread_promotion_emails()
- gmail.get.unread_social_emails()


#### gmail.get.last_active()

Gets user's account activity data

`json
{
"time": "9:41 pm",
"ip": "54.234.192.48",
"mac_address": "2620:101:f000:702:a966:ab42:4a46:195e",
"time_relative": "31 minutes ago"
}
`

#### gmail.get.loggedin_accounts()

Returns a list of signed-in accounts (multiple user accounts setup in gmail)

`json
[{"name":"California","email":"california@gmail.com"}]
`

#### gmail.get.beta()

Although hand picked, this method returns the checks on beta features and deployments

`json
{"new_nav_bar":true}
`

#### gmail.get.localization()

Returns the Gmail localization, e.g. 'US'.

#### gmail.check.is_new_data_layer()

Returns True if the user is running Gmail with the new 2018 data-layer False otherwise

#### gmail.check.is_new_gui()

Returns True if the user is running Gmail with the new 2018 GUI False otherwise

#### gmail.check.is_peoplekit_compose(composeElement)

Returns True if the compose UI uses new UI as announced here False otherwise

#### gmail.check.is_thread()

Returns True if the conversation is threaded False otherwise

#### gmail.check.is_preview_pane()

Returns True if gmail is in split pane mode (vertical or horizontal) False otherwise

#### gmail.check.is_multiple_inbox()

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

#### gmail.check.are_shortcuts_enabled()

Returns True if user has enabled mail action shortcuts, False otherwise

#### gmail.check.is_vertical_split()

Returns True if the pane mode is vertical False otherwise

#### gmail.check.is_tabbed_inbox()

Returns True if tabbed inbox view is enabled False otherwise

#### gmail.check.is_right_side_chat()

Returns True if chat is on the right sidebar False otherwise

#### gmail.check.should_compose_fullscreen()

Returns True if compose is in fullscreen mode False otherwise

#### gmail.check.is_conversation_view()

Returns True if emails are displayed as threads, False otherwise (i.e. displayed individually)

#### gmail.check.is_google_apps_user()

Returns True if the current user is google apps user (email not ending in gmail.com) False otherwise

#### gmail.check.is_inside_email()

Returns True if you are currently inside an email conversation False otherwise

#### gmail.check.is_plain_text()

Returns True if compose is in plain text mode, False if in rich text mode

#### gmail.check.is_priority_inbox()

Returns True if priority inbox is enabled False otherwise

#### gmail.check.is_rapportive_installed()

Returns True if rapportive chrome extension is installed False otherwise

#### gmail.check.is_streak_installed()

Returns True if streak chrome extension is installed False otherwise

#### gmail.check.is_anydo_installed()

Returns True if any.do chrome extension is installed False otherwise

#### gmail.check.is_boomerang_installed()

Returns True if boomerang chrome extension is installed False otherwise

#### gmail.check.is_xobni_installed()

Returns True if xobni chrome extension is installed False otherwise

#### gmail.check.is_signal_installed()

Returns True if Signal chrome extension is installed False otherwise


#### gmail.chat.is_hangouts()

Returns True if the account supports the new hangout UI for chat False otherwise (native chat window)


#### gmail.compose.start_compose()

-Clicks on the compose button making the inbox compose view to popup


#### gmail.observe.http_requests()

After an observer has been bound through gmail.observe.bind() (via a call to events gmail.observe.before(), gmail.observe.on(), or gmail.observe.after()), this method keeps track of the last 50 http events.
The items contain the sent requested parameterized data

`json
[{
"method": "POST",
"url": {
"ui": "2",
"ik": "13fa7f7088",
"rid": "ed0e..",
"view": "tl",
"start": "0",
"num": "30",
"lhop": "169846",
"ltup": "%5Ei",
"slmm": "1427abc6106ac10b",
"scid": "q2h353hw6dv9",
"avw": "1194",
"ntlv": "10",
"auto": "1",
"ver": "-z-h-bKmWwI.en.",
"am": "!6hSPXvkvPMjmReGu2-2BQXCk3IltF-jNSk0J8Cg_jNeaoSbpJgHQYdkXe6T_WPYyyATD3DSiOA",
"vas": "1",
"ari": "120",
"_reqid": "4582876",
"pcd": "1",
"mb": "0",
"rt": "j",
"search": "inbox"
},
"body": "",
"url_raw": "?ui=2&ik=13fa7f7088&rid=ed0e..&view=tl&start=0&num=30&lhop=169846<up=%5Ei&slmm=1427abc6106ac10b&scid=q2h353hw6dv9&avw=1194&ntlv=10&auto=1&ver=-z-h-bKmWwI.en.&am=!6hSPXvkvPMjmReGu2-2BQXCk3IltF-jNSk0J8Cg_jNeaoSbpJgHQYdkXe6T_WPYyyATD3DSiOA&vas=1&ari=120&_reqid=4582876&pcd=1&mb=0&rt=j&search=inbox"
}]
`

#### 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.

#### gmail.observe.on(action, callback)

This is the key feature of gmail.js. This method allows you to add triggers to all of these actions so you can build
your custom extension/tool with this library.

You simply specify the action name and your function that the method will return data to when the actions are triggered
and it does the rest. You can have multiple triggers

Your callback will be fired directly after Gmail's XMLHttpRequest has been sent off the the Gmail servers.

Available Actions

- http_event - When gmail any XHR CRUD operation happens on gmail
- poll - When gmail automatically polls the server to check for new emails every few seconds
- new_email - When a new email appears in the inbox
- open_email - When an email is opened from the inbox view
- refresh - When you click the refresh button
- unread - When a conversation(s) is marked unread
- read - When a conversation(s) is marked read
- delete - When a conversation(s) is deleted
- delete_message_in_thread - When a conversation(s) is deleted inside and is part of a thread
- 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
- 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
- unstar - When a conversation(s) is unstarred
- undo_send - When the Undo Send button is clicked after trying to send a new email
- mark_as_important - When a conversation(s) is marked as important
- mark_as_not_important - When a conversation(s) is marked as not important
- filter_messages_like_these - When a filter button is triggered for a conversation
- mute - When a conversation(s) is muted
- unmute - When a conversation(s) is unmuted
- 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
- 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).

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_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

`js
gmail.observe.on("http_event", function(params, xhr) {
console.log("url data:", params);
})

gmail.observe.on("unread", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("read", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("delete", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("mark_as_spam", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("mark_as_not_spam", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("label", function(id, url, body, label, xhr) {
console.log("id:", id, "url:", url, 'body', body, "label", label, 'xhr', xhr);
})

gmail.observe.on("archive", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("move_to_inbox", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("delete_forever", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("delete_message_in_thread", function(id, url, body) {
console.log("id:", id, "url:", url, 'body', body);
})

gmail.observe.on("restore_message_in_thread", function(id, url, body) {
console.log("id:", id, "url:", url, 'body', body);
})

gmail.observe.on("star", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("unstar", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("undo_send", function(url, body, data, xhr) {
console.log('body', body, 'xhr', xhr, 'msg_id : ', body.m);
})

gmail.observe.on("mark_as_important", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("mark_as_not_important", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("filter_messages_like_these", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("mute", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("unmute", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("add_to_tasks", function(url, body, data, xhr) {
console.log("url:", url, 'body', body, 'task_data', data, 'xhr', xhr);
})

gmail.observe.on("move_label", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("save_draft", function(url, body, data, xhr) {
console.log("url:", url, 'body', body, 'email_data', data, 'xhr', xhr);
})

gmail.observe.on("discard_draft", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

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);
})

gmail.observe.on("delete_label", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("show_newly_arrived_message", function(id, url, body) {
console.log("id:", id, "url:", url, 'body', body);
})

gmail.observe.on("poll", function(url, body, data, xhr) {
console.log("url:", url, 'body', body, 'data', data, 'xhr', xhr);
})

gmail.observe.on("new_email", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
})

gmail.observe.on("refresh", function(url, body, data, xhr) {
console.log("url:", url, 'body', body, 'data', data, 'xhr', xhr);
})

gmail.observe.on("open_email", function(id, url, body, xhr) {
console.log("id:", id, "url:", url, 'body', body, 'xhr', xhr);
console.log(gmail.get.email_data(id));
})

gmail.observe.on("upload_attachment", function(file, xhr) {
console.log("file", file, 'xhr', xhr);
})

// DOM observers
gmail.observe.on("compose", function(compose, type) {

// type can be compose, reply or forward
console.log('api.dom.compose object:', compose, 'type is:', type ); // gmail.dom.compose object
});

gmail.observe.on('recipient_change', function(match, recipients) {
console.log('recipients changed', match, recipients);
});

gmail.observe.on('view_thread', function(obj) {
console.log('conversation thread opened', obj); // gmail.dom.thread object
});

gmail.observe.on('view_email', function(obj) {
console.log('individual email opened', obj); // gmail.dom.email object
});

gmail.observe.on('load_email_menu', function(match) {
console.log('Menu loaded',match);

// insert a new element into the menu
$('