Sign up
All data sources

Gmail

Your account

Exact Gmail API v1 operations authorized by the connected gmail.modify grant. The model chooses one direct method. Reads are bounded and raw RFC 2822 base64 is not exposed. Attachments return artifact markers. Sends and drafts use CR/LF-safe MIME construction. Trash is reversible and untrash is exposed. Permanent delete is intentionally absent because Google's messages.delete requires the broader mail.google.com scope that PatchOps does not request.

Set up this sourceGet the full contract and schemas as JSON

Sign in with your Gmail account. Included on Free.

What you can ask

  • “What does Gmail have for the area or asset I'm working on?”
  • “Pull the most recent Gmail records and put them in a table.”
  • “What does Gmail cover, and how fresh is the data?”

About this source

Exact Gmail API v1 operations authorized by the connected gmail.modify grant. The model chooses one direct method. Reads are bounded and raw RFC 2822 base64 is not exposed. Attachments return artifact markers. Sends and drafts use CR/LF-safe MIME construction. Trash is reversible and untrash is exposed. Permanent delete is intentionally absent because Google's messages.delete requires the broader mail.google.com scope that PatchOps does not request.

Connector ID gmail

Provenance

PublisherGmail
API basehttps://www.googleapis.com/

Freshness & coverage

FreshnessFreshness not declared
GeographicNot declared
TemporalNot declared
AuthenticationCredentials required (OAuth)

› Methods (50)

Technical detail for developers: parameters, pagination, units, and freshness per method.

  • listMessages

    read

    List one bounded page of Gmail message IDs using exact Gmail search and label filters.

    Paginationtoken (tokenField: nextPageToken, limitField: maxResults)

  • getMessage

    read

    Get one message as bounded metadata, minimal IDs/labels, or parsed full MIME structure; raw base64 is not exposed.

    Required paramsid
    Paginationnone

  • listThreads

    read

    List one bounded page of Gmail thread IDs using exact Gmail search and label filters.

    Paginationtoken (tokenField: nextPageToken, limitField: maxResults)

  • getThread

    read

    Get one exact Gmail thread in metadata, minimal, or parsed full format.

    Required paramsid
    Paginationnone

  • downloadAttachment

    read

    Download one bounded attachment discovered in a parsed message part to a token-safe artifact marker.

    Required paramsmessageIdattachmentIdfilenamecontentType
    Paginationnone

  • listLabels

    read

    List all labels in the authenticated mailbox.

    Paginationnone

  • getProfile

    read

    Get the authenticated Gmail profile and mailbox totals.

    Paginationnone

  • sendEmail

    write

    Send one plain-text or HTML email using a CR/LF-safe RFC 2822 message.

    Required paramstosubjectbody
    Paginationnone

  • createDraft

    write

    Create one unsent plain-text or HTML Gmail draft.

    Required paramstosubjectbody
    Paginationnone

  • trashMessage

    write

    Move one exact Gmail message to Trash; this is reversible.

    Required paramsid
    Paginationnone

  • untrashMessage

    write

    Restore one exact Gmail message from Trash.

    Required paramsid
    Paginationnone

  • modifyLabels

    write

    Add and/or remove up to 100 exact label IDs on one message.

    Required paramsidaddLabelIds or removeLabelIds
    Paginationnone

  • users_drafts_delete

    write

    Official gmail.users.drafts.delete operation. Immediately and permanently deletes the specified draft. Does not simply trash it. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).

    Required paramsid
    Paginationnone

  • users_drafts_get

    read

    Official gmail.users.drafts.get operation. Gets the specified draft. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).

    Required paramsid
    Paginationnone

  • users_drafts_list

    read

    Official gmail.users.drafts.list operation. Lists the drafts in the user's mailbox. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).

    Paginationtoken (tokenField: nextPageToken, limitField: maxResults)

  • users_drafts_send

    write

    Official gmail.users.drafts.send operation. Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).

    Required paramsbody
    Paginationnone

  • users_drafts_update

    write

    Official gmail.users.drafts.update operation. Replaces a draft's content. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).

    Required paramsidbody
    Paginationnone

  • users_history_list

    read

    Official gmail.users.history.list operation. Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`). For more information, see [Synchronize clients with Gmail](https://developers.google.com/workspace/gmail/api/guides/sync).

    Paginationtoken (tokenField: nextPageToken, limitField: maxResults)

  • users_labels_create

    write

    Official gmail.users.labels.create operation. Creates a label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).

    Required paramsbody
    Paginationnone

  • users_labels_delete

    write

    Official gmail.users.labels.delete operation. Immediately and permanently deletes the specified label and removes it from any messages and threads that it's applied to. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).

    Required paramsid
    Paginationnone

  • users_labels_get

    read

    Official gmail.users.labels.get operation. Gets the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).

    Required paramsid
    Paginationnone

  • users_labels_patch

    write

    Official gmail.users.labels.patch operation. Patch the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).

    Required paramsidbody
    Paginationnone

  • users_labels_update

    write

    Official gmail.users.labels.update operation. Updates the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).

    Required paramsidbody
    Paginationnone

  • users_messages_batchmodify

    write

    Official gmail.users.messages.batchModify operation. Modifies the labels and the Classification Label values on the specified messages. For administrators modifying messages for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.modify.restricted` scope.

    Required paramsbody
    Paginationnone

  • users_messages_import

    write

    Official gmail.users.messages.import operation. Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Note that the maximum size of the message is 150 MB.

    Required paramsbody
    Paginationnone

  • users_messages_insert

    write

    Official gmail.users.messages.insert operation. Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending).

    Required paramsbody
    Paginationnone

  • users_settings_cse_identities_get

    read

    Official gmail.users.settings.cse.identities.get operation. Retrieves a client-side encryption identity configuration. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.

    Required paramscseEmailAddress
    Paginationnone

  • users_settings_cse_identities_list

    read

    Official gmail.users.settings.cse.identities.list operation. Lists the client-side encrypted identities for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.

    Paginationtoken (tokenField: nextPageToken, limitField: maxResults)

  • users_settings_cse_keypairs_get

    read

    Official gmail.users.settings.cse.keypairs.get operation. Retrieves an existing client-side encryption key pair. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.

    Required paramskeyPairId
    Paginationnone

  • users_settings_cse_keypairs_list

    read

    Official gmail.users.settings.cse.keypairs.list operation. Lists client-side encryption key pairs for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.

    Paginationtoken (tokenField: nextPageToken, limitField: maxResults)

  • users_settings_delegates_get

    read

    Official gmail.users.settings.delegates.get operation. Gets the specified delegate. For more information, see [Manage delegates](https://developers.google.com/workspace/gmail/api/guides/delegate_settings). A delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.

    Required paramsdelegateEmail
    Paginationnone

  • users_settings_delegates_list

    read

    Official gmail.users.settings.delegates.list operation. Lists the delegates for the specified account. For more information, see [Manage delegates](https://developers.google.com/workspace/gmail/api/guides/delegate_settings). This method is only available to service account clients that have been delegated domain-wide authority.

    Paginationnone

  • users_settings_filters_get

    read

    Official gmail.users.settings.filters.get operation. Gets a filter. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).

    Required paramsid
    Paginationnone

  • users_settings_filters_list

    read

    Official gmail.users.settings.filters.list operation. Lists the message filters of a Gmail user. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).

    Paginationnone

  • users_settings_forwardingaddresses_get

    read

    Official gmail.users.settings.forwardingAddresses.get operation. Gets the specified forwarding address. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).

    Required paramsforwardingEmail
    Paginationnone

  • users_settings_forwardingaddresses_list

    read

    Official gmail.users.settings.forwardingAddresses.list operation. Lists the forwarding addresses for the specified account. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).

    Paginationnone

  • users_settings_getautoforwarding

    read

    Official gmail.users.settings.getAutoForwarding operation. Gets the auto-forwarding setting for the specified account. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).

    Paginationnone

  • users_settings_getimap

    read

    Official gmail.users.settings.getImap operation. Gets IMAP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).

    Paginationnone

  • users_settings_getlanguage

    read

    Official gmail.users.settings.getLanguage operation. Gets language settings. For more information, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings).

    Paginationnone

  • users_settings_getpop

    read

    Official gmail.users.settings.getPop operation. Gets POP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).

    Paginationnone

  • users_settings_getvacation

    read

    Official gmail.users.settings.getVacation operation. Gets vacation responder settings. For more information, see [Manage vacation settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/vacation_settings).

    Paginationnone

  • users_settings_sendas_get

    read

    Official gmail.users.settings.sendAs.get operation. Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings).

    Required paramssendAsEmail
    Paginationnone

  • users_settings_sendas_list

    read

    Official gmail.users.settings.sendAs.list operation. Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings).

    Paginationnone

  • users_settings_sendas_smimeinfo_get

    read

    Official gmail.users.settings.sendAs.smimeInfo.get operation. Gets the specified S/MIME config for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).

    Required paramsidsendAsEmail
    Paginationnone

  • users_settings_sendas_smimeinfo_list

    read

    Official gmail.users.settings.sendAs.smimeInfo.list operation. Lists S/MIME configs for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).

    Required paramssendAsEmail
    Paginationnone

  • users_stop

    write

    Official gmail.users.stop operation. Turn off push notification delivery for the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).

    Paginationnone

  • users_threads_modify

    write

    Official gmail.users.threads.modify operation. Modifies the labels applied to the thread. This applies to all messages in the thread. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).

    Required paramsidbody
    Paginationnone

  • users_threads_trash

    write

    Official gmail.users.threads.trash operation. Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).

    Required paramsid
    Paginationnone

  • users_threads_untrash

    write

    Official gmail.users.threads.untrash operation. Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).

    Required paramsid
    Paginationnone

  • users_watch

    write

    Official gmail.users.watch operation. Set up or update a push notification watch on the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).

    Required paramsbody
    Paginationnone