Gmail
API integration

list_all_gmail_messages

Use this endpoint to retrieve a list of messages from the user's Gmail mailbox.

get_single_gmail_message_by_id

Get the specified message by id for user_id in Gmail. Returns message id, threadId, labelIds, snippet, historyId, internalDate, payload, sizeEstimate, raw, and other message details.

create_a_gmail_message

Send a message to recipients specified in the To, Cc, and Bcc headers in Gmail. Requires user_id. Returns the sent message including id, threadId, labelIds, snippet, and internalDate.

delete_a_gmail_message_by_id

Delete a specific message by id for user_id in Gmail. This operation immediately and permanently deletes the message and cannot be undone. The response is an empty JSON object.

list_all_gmail_threads

List threads in the user's mailbox in Gmail. Requires user_id. Returns threads array with thread details, nextPageToken for pagination, and resultSizeEstimate indicating total results.

get_single_gmail_thread_by_id

Get the specified thread by user_id and id in Gmail. Returns thread messages with fields such as message IDs, labels, headers, and body content depending on the format parameter.

update_a_gmail_thread_by_id

Modify labels applied to a thread in Gmail for user_id and id. Returns the updated thread including id, snippet, historyId, and labelIds fields.

delete_a_gmail_thread_by_id

Delete a specific thread by id for user_id in Gmail. This operation permanently deletes the thread and all its messages and cannot be undone.

create_a_gmail_batch

The batch endpoint allows you to group multiple Gmail API requests (such as sending messages, modifying labels, deleting drafts, etc.) into a single HTTP request. Each request is executed independently, and its responses are returned in a multipart response. This is especially useful for bulk operations such as modifying labels on many messages or sending multiple emails at once.

list_all_gmail_userinfo

Retrieves basic profile information about the currently authenticated user using the access token provided during OAuth 2.0 authentication.

get_single_gmail_attachment_by_id

Get the specified message attachment by user_id, message_id, and id in Gmail. Returns attachment data including size and base64 encoded content.

list_all_gmail_drafts

List drafts in the user's mailbox in Gmail. Requires user_id. Returns drafts with id and threadId.

get_single_gmail_draft_by_id

Get the specified draft by user_id and id in Gmail. Returns the draft's id, message, and labels.

create_a_gmail_draft

Create a new draft for the user identified by user_id in Gmail. Returns the created draft including its id and message details.

update_a_gmail_draft_by_id

Update a draft's content in Gmail using user_id and id. Returns the updated draft including its id and message details.

delete_a_gmail_draft_by_id

Delete a specific draft by id for the user_id in Gmail. The draft is permanently deleted and not moved to trash. The response is an empty JSON object.

gmail_drafts_send

Send the specified draft for user_id in Gmail. Returns the sent message including id, threadId, labelIds, snippet, and internalDate.

list_all_gmail_history

List the history of all changes to the mailbox for user_id after the specified startHistoryId in Gmail. Returns history records with id, messages, messagesAdded, messagesDeleted, labelsAdded, and labelsRemoved fields.

list_all_gmail_labels

List all labels in the user's mailbox in Gmail. Requires user_id. Returns label id, name, messageListVisibility, labelListVisibility, and type for each label.

get_single_gmail_label_by_id

Get the specified label by id for user_id in Gmail. Returns label details including id, name, message list visibility, label list visibility, type, and color.

create_a_gmail_label

Create a new label for the user identified by user_id in Gmail. Returns the created label including id, name, messageListVisibility, and labelListVisibility fields.

delete_a_gmail_label_by_id

Delete a label by id for the user_id in Gmail. This operation permanently removes the label and disassociates it from all messages and threads.

update_a_gmail_label_by_id

Patch the specified label for user_id and id in Gmail. Returns the updated label including its id, name, message list visibility, label list visibility, type, and color properties.

list_all_gmail_settings_sendas

List send-as aliases for the specified user_id in Gmail. Returns the primary send-as address and any custom 'from' aliases in the sendAs array.

get_single_gmail_settings_senda_by_id

Get the specified send-as alias for user_id in Gmail. Returns the send-as alias details including email address and configuration. Fails with 404 if alias is not found.

create_a_gmail_settings_senda

Create a custom 'from' send-as alias for user_id in Gmail. Returns the created alias with fields including verification status and sanitized signature if provided.

update_a_gmail_settings_senda_by_id

Update a send-as alias for user_id and id in Gmail. Returns the updated send-as alias including fields like signature and email address. Note: Only service account clients with domain-wide authority can update non-primary addresses.

delete_a_gmail_settings_senda_by_id

Delete the specified send-as alias for user_id in Gmail. Revokes any verification required for using the alias. Returns an empty JSON object on success.

list_all_gmail_settings_filters

Get message filters for a Gmail user with user_id. Returns a list of filters including criteria and actions for each filter.

get_single_gmail_settings_filter_by_id

Get a filter by id for the user identified by user_id in Gmail. Returns the filter's id, criteria, and action fields.

create_a_gmail_settings_filter

Create a filter for the user identified by user_id in Gmail. Returns the created filter including its id, criteria, and action. Note: maximum of 1,000 filters can be created.

delete_a_gmail_settings_filter_by_id

Delete a filter by id for the user_id in Gmail. Returns an empty JSON object on success.

list_all_gmail_settings_forwarding_addresses

Get the list of forwarding addresses for the specified user_id in Gmail. Returns forwardingAddresses array containing addresses that may be used for forwarding.

get_single_gmail_settings_forwarding_address_by_id

Get the specified forwarding address for user_id in Gmail. Returns forwardingEmail and verification status fields.

create_a_gmail_settings_forwarding_address

Create a forwarding address for user_id in Gmail. Returns the forwarding address resource including verification status which may be 'pending' if ownership verification is required.

delete_a_gmail_settings_forwarding_address_by_id

Delete the specified forwarding address for user_id in Gmail. Returns an empty JSON object on success. Requires forwardingEmail as id.

list_all_gmail_settings_delegates

List delegates for the specified userId in Gmail. Returns delegates array with delegate details including verification status.

get_single_gmail_settings_delegate_by_id

Get the specified delegate for user_id in Gmail. Returns delegate's email and related delegate information. Note: delegateEmail must be the primary email address.

create_a_gmail_settings_delegate

Create a delegate for the user identified by user_id in Gmail. Returns the delegate's email address and verification status. The delegate must be in the same Google Workspace organization and is added with status accepted without verification email.

delete_a_gmail_settings_delegate_by_id

Remove the specified delegate by delegate_email for the user identified by user_id in Gmail. The delegate user must be referred to by their primary email address. Response is an empty JSON object.

list_all_gmail_settings_cse_keypairs

List client-side encryption key pairs for a user in Gmail. Requires user_id. Returns cseKeyPairs array with key pair details and nextPageToken for pagination.

get_single_gmail_settings_cse_keypair_by_id

Get an existing client-side encryption key pair by user_id and id in Gmail. Returns key pair details including encryption keys and metadata.

create_a_gmail_settings_cse_keypair

Create and upload a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user in Gmail. Requires user_id. Returns the created CseKeyPair including public key certificate chain and metadata.

list_all_gmail_settings_cse_identities

List client-side encrypted identities for a user in Gmail. Requires user_id. Returns cseIdentities array with identity details and nextPageToken for pagination.

get_single_gmail_settings_cse_identity_by_id

Get client-side encryption identity configuration for user_id and id in Gmail. Returns fields of the CseIdentity resource.

create_a_gmail_settings_cse_identity

Create and configure a client-side encryption identity authorized to send mail from the user account in Gmail. Requires user_id. Returns the created CseIdentity with its configuration details.

update_a_gmail_settings_cse_identity_by_id

Update a client-side encryption identity in Gmail by associating a different key pair. Requires user_id and id (emailAddress). Returns the updated CseIdentity fields including emailAddress and key_pair_configuration.

delete_a_gmail_settings_cse_identity_by_id

Delete a client-side encryption identity for the authenticated user in Gmail. Requires user_id and cse_email_address. The identity cannot be restored after deletion.

get_single_gmail_settings_auto_forwarding_by_id

Get the auto-forwarding setting for the specified account in Gmail. Requires user_id. Returns auto-forwarding configuration including enabled status, email address, and disposition.

update_a_gmail_settings_auto_forwarding_by_id

Update the auto-forwarding setting for the specified user_id in Gmail. Requires a verified forwarding address when auto-forwarding is enabled. Returns the updated AutoForwarding configuration.

get_single_gmail_settings_imap_by_id

Get IMAP settings for the user identified by user_id in Gmail. Returns fields including enabled status, auto-expunge, and folder size limits.

update_a_gmail_settings_imap_by_id

Update IMAP settings for a user in Gmail. Requires userId as the user's email address or 'me'. Returns the updated ImapSettings object.

get_single_gmail_settings_language_by_id

Get language settings for a user in Gmail. Requires user_id. Returns language code and display name fields in the response.

update_a_gmail_settings_language_by_id

Update language settings for a user in Gmail using user_id. Returns the saved displayLanguage which may differ from the requested value if a close variant is used.

get_single_gmail_settings_pop_by_id

Get POP settings for a user in Gmail. Requires user_id. Returns fields including accessWindow, disposition, and enable status.

update_a_gmail_settings_pop_by_id

Update POP settings for the user identified by user_id in Gmail. Returns the updated PopSettings including access window and disposition fields.

get_single_gmail_settings_vacation_by_id

Get vacation responder settings for a user in Gmail. Requires userId. Returns vacation responder configuration including enablement, response subject, message, and time range.

update_a_gmail_settings_vacation_by_id

Update vacation responder settings for a user in Gmail. Requires userId as id. Returns updated vacation settings including response subject, message, and enablement status.