Knowledge Base
Admin

Gmail API

The Gmail API is a RESTful API that allows access to Gmail mailboxes and the ability to send mail, view, and manage Gmail mailbox data like threads, messages, and labels.

Active

Capabilities (83)

Get Message

Lists the messages in the user's mailbox

gmail_users_messages_list()

Get Attachments

Gets the specified message attachment

gmail_users_messages_attachments_get()

Send As Alias

Lists the send-as aliases for the specified account

gmail_users_settings_send_as_list()

Get Alias

Gets the specified send-as alias

gmail_users_settings_send_as_get()

Autoforwarding

Creates autoforwarding via the API.

autoforwarding()

Users Drafts

Creates users drafts via the API.

users_drafts()

Format

Creates format via the API.

format()

Users History

Creates users history via the API.

users_history()

V1/users Settings Delegates/get

Creates v1/users settings delegates/create via the API.

v1_users_settings_delegates_get()

V1/imapsettings

Creates v1/imapsettings via the API.

v1_imapsettings()

V1/users Settings Cse Identities

Creates v1/users settings cse identities/create via the API.

v1_users_settings_cse_identities()

V1/users Settings Sendas/verify

Creates v1/users settings sendas/verify via the API.

v1_users_settings_sendas_verify()

V1/users Settings/updatevacation

Creates v1/users settings/updatevacation via the API.

v1_users_settings_updatevacation()

V1/users Settings Cse Keypairs/get

Creates v1/users settings cse keypairs/create via the API.

v1_users_settings_cse_keypairs_get()

V1/users Messages/import

Creates v1/users messages/import via the API.

v1_users_messages_import()

V1/users

Creates v1/users via the API.

v1_users()

V1/users Settings Sendas Smimeinfo/delete

Creates v1/users settings sendas smimeinfo/delete via the API.

v1_users_settings_sendas_smimeinfo_delete()

V1/users Settings Forwardingaddresses/create

Creates v1/users settings forwardingaddresses/create via the API.

v1_users_settings_forwardingaddresses_create()

V1/users Settings Cse Keypairs/obliterate

Creates v1/users settings cse keypairs/obliterate via the API.

v1_users_settings_cse_keypairs_obliterate()

V1/users Settings Sendas/patch

Creates v1/users settings sendas/update via the API.

v1_users_settings_sendas_patch()

V1/users Settings Filters/list

Creates v1/users settings filters/create via the API.

v1_users_settings_filters_list()

V1/users Settings Cse Keypairs/disable

Creates v1/users settings cse keypairs/disable via the API.

v1_users_settings_cse_keypairs_disable()

V1/internaldatesource

Creates v1/internaldatesource via the API.

v1_internaldatesource()

V1/users/watch

Creates v1/users/watch via the API.

v1_users_watch()

V1/users/getprofile

Creates v1/users/getprofile via the API.

v1_users_getprofile()

V1/autoforwarding

Creates v1/autoforwarding via the API.

v1_autoforwarding()

V1/users Settings/getpop

Creates v1/users settings/updatepop via the API.

v1_users_settings_getpop()

V1/languagesettings

Creates v1/languagesettings via the API.

v1_languagesettings()

V1/popsettings

Creates v1/popsettings via the API.

v1_popsettings()

V1/users Settings Cse Keypairs/enable

Creates v1/users settings cse keypairs/enable via the API.

v1_users_settings_cse_keypairs_enable()

V1/users/stop

Creates v1/users/stop via the API.

v1_users_stop()

V1/users Settings/getimap

Creates v1/users settings/updateimap via the API.

v1_users_settings_getimap()

V1/users Messages/batchdelete

Creates v1/users messages/batchdelete via the API.

v1_users_messages_batchdelete()

V1/users Settings/getlanguage

Creates v1/users settings/updatelanguage via the API.

v1_users_settings_getlanguage()

V1/users Messages Attachments

Creates v1/users messages attachments/get via the API.

v1_users_messages_attachments()

V1/vacationsettings

Creates v1/vacationsettings via the API.

v1_vacationsettings()

V1/users Threads/get

Creates v1/users threads/untrash via the API.

v1_users_threads_get()

V1/users Labels/create

Creates v1/users labels/create via the API.

v1_users_labels_create()

V1/users Messages/send

Creates v1/users messages/untrash via the API.

v1_users_messages_send()

V1/users Settings Sendas Smimeinfo/setdefault

Creates v1/users settings sendas smimeinfo/setdefault via the API.

v1_users_settings_sendas_smimeinfo_setdefault()

V1/users History

Creates v1/users history/list via the API.

v1_users_history()

V1/users Drafts/list

Creates v1/users drafts/delete via the API.

v1_users_drafts_list()

V1/users Settings/updateautoforwarding

Creates v1/users settings/updateautoforwarding via the API.

v1_users_settings_updateautoforwarding()

V1/users Settings

Creates v1/users settings via the API.

v1_users_settings()

V1/users Messages/batchmodify

Creates v1/users messages/batchmodify via the API.

v1_users_messages_batchmodify()

V1/format

Creates v1/format via the API.

v1_format()

Get S/MIME Configuration

Gets the specified S/MIME config for the specified send-as alias

gmail_users_settings_send_as_smime_info_get()

Get Threads

Lists the threads in the user's mailbox

gmail_users_threads_list()

Get Threads

Gets the specified thread

gmail_users_threads_get()

Update Label

Updates the specified label

gmail_users_labels_patch()

Update Alias

Updates a send-as alias

gmail_users_settings_send_as_patch()

Send Draft

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers

gmail_users_drafts_send()

Create Label

Creates a new label

gmail_users_labels_create()

Create Message

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification

gmail_users_messages_insert()

Delete Messages

Deletes many messages by message ID

gmail_users_messages_batch_delete()

Import Message

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP

gmail_users_messages_import()

Modify message

Modifies the labels on the specified message

gmail_users_messages_modify()

Create Alias

Creates a custom "from" send-as alias

gmail_users_settings_send_as_create()

Modify Thread labels

Removes the specified thread from the trash

gmail_users_threads_modify()

Update Label

Updates the specified label

gmail_users_labels_update()

Update Alias

Updates a send-as alias

gmail_users_settings_send_as_update()

Delete Lbel

Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to

gmail_users_labels_delete()

Delete Alias

Deletes the specified send-as alias

gmail_users_settings_send_as_delete()

Delete S/MIME Configurations

Deletes the specified S/MIME config for the specified send-as alias

gmail_users_settings_send_as_smime_info_delete()

Delete Threads

Immediately and permanently deletes the specified thread

gmail_users_threads_delete()

Get Labels

Lists all labels in the user's mailbox

gmail_users_labels_list()

Get Label

Gets the specified label

gmail_users_labels_get()

Imapsettings

Creates imapsettings via the API.

imapsettings()

Internaldatesource

Creates internaldatesource via the API.

internaldatesource()

Users Labels

Creates users labels via the API.

users_labels()

Languagesettings

Creates languagesettings via the API.

languagesettings()

Users Messages

Creates users messages/untrash via the API.

users_messages()

Users Messages/batchdelete

Creates users messages/batchdelete via the API.

users_messages_batchdelete()

Users Messages/import

Creates users messages/import via the API.

users_messages_import()

Users Messages/batchmodify

Creates users messages/batchmodify via the API.

users_messages_batchmodify()

Popsettings

Creates popsettings via the API.

popsettings()

Users/getprofile

Creates users/getprofile via the API.

users_getprofile()

Users Settings

Creates users settings via the API.

users_settings()

Users/stop

Creates users/stop via the API.

users_stop()

Users Threads

Creates users threads/untrash via the API.

users_threads()

Users

Creates users via the API.

users()

Vacationsettings

Creates vacationsettings via the API.

vacationsettings()

Users/watch

Creates users/watch via the API.

users_watch()

Links

Authentication

  • Oauth2_authorization_code (Primary)
  • Oauth2_client_credentials (Primary)