integrations.sh
← all integrations

googleapis.com – gmail

OpenAPI apis-guru analyticsmedia

The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.

Homepage
https://api.apis.guru/v2/specs/googleapis.com:gmail/v1.json
Provider
googleapis.com:gmail / gmail
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/googleapis.com/gmail/v1/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/googleapis.com/gmail/v1/openapi.yaml

Tools (81)

Extracted live via the executor SDK.

  • users.gmailUsersDraftsCreate

    Creates a new draft with the DRAFT label.

  • users.gmailUsersDraftsDelete

    Immediately and permanently deletes the specified draft. Does not simply trash it.

  • users.gmailUsersDraftsGet

    Gets the specified draft.

  • users.gmailUsersDraftsList

    Lists the drafts in the user's mailbox.

  • users.gmailUsersDraftsSend

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

  • users.gmailUsersDraftsUpdate

    Replaces a draft's content.

  • users.gmailUsersGetProfile

    Gets the current user's Gmail profile.

  • users.gmailUsersHistoryList

    Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).

  • users.gmailUsersLabelsCreate

    Creates a new label.

  • users.gmailUsersLabelsDelete

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

  • users.gmailUsersLabelsGet

    Gets the specified label.

  • users.gmailUsersLabelsList

    Lists all labels in the user's mailbox.

  • users.gmailUsersLabelsPatch

    Patch the specified label.

  • users.gmailUsersLabelsUpdate

    Updates the specified label.

  • users.gmailUsersMessagesAttachmentsGet

    Gets the specified message attachment.

  • users.gmailUsersMessagesBatchDelete

    Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.

  • users.gmailUsersMessagesBatchModify

    Modifies the labels on the specified messages.

  • users.gmailUsersMessagesDelete

    Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead.

  • users.gmailUsersMessagesGet

    Gets the specified message.

  • users.gmailUsersMessagesImport

    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: This function doesn't trigger forwarding rules or filters set up by the user.

  • users.gmailUsersMessagesInsert

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

  • users.gmailUsersMessagesList

    Lists the messages in the user's mailbox.

  • users.gmailUsersMessagesModify

    Modifies the labels on the specified message.

  • users.gmailUsersMessagesSend

    Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see .

  • users.gmailUsersMessagesTrash

    Moves the specified message to the trash.

  • users.gmailUsersMessagesUntrash

    Removes the specified message from the trash.

  • users.gmailUsersSettingsCseIdentitiesCreate

    Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity.

  • users.gmailUsersSettingsCseIdentitiesDelete

    Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration.

  • users.gmailUsersSettingsCseIdentitiesGet

    Retrieves a client-side encryption identity configuration.

  • users.gmailUsersSettingsCseIdentitiesList

    Lists the client-side encrypted identities for an authenticated user.

  • users.gmailUsersSettingsCseIdentitiesPatch

    Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's .

  • users.gmailUsersSettingsCseKeypairsCreate

    Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.

  • users.gmailUsersSettingsCseKeypairsDisable

    Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method.

  • users.gmailUsersSettingsCseKeypairsEnable

    Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities.

  • users.gmailUsersSettingsCseKeypairsGet

    Retrieves an existing client-side encryption key pair.

  • users.gmailUsersSettingsCseKeypairsList

    Lists client-side encryption key pairs for an authenticated user.

  • users.gmailUsersSettingsCseKeypairsObliterate

    Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages.

  • users.gmailUsersSettingsDelegatesCreate

    Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same Google Workspace organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a Google Workspace organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority.

  • users.gmailUsersSettingsDelegatesDelete

    Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that 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.

  • users.gmailUsersSettingsDelegatesGet

    Gets the specified delegate. Note that 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.

  • users.gmailUsersSettingsDelegatesList

    Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.

  • users.gmailUsersSettingsFiltersCreate

    Creates a filter. Note: you can only create a maximum of 1,000 filters.

  • users.gmailUsersSettingsFiltersDelete

    Immediately and permanently deletes the specified filter.

  • users.gmailUsersSettingsFiltersGet

    Gets a filter.

  • users.gmailUsersSettingsFiltersList

    Lists the message filters of a Gmail user.

  • users.gmailUsersSettingsForwardingAddressesCreate

    Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. This method is only available to service account clients that have been delegated domain-wide authority.

  • users.gmailUsersSettingsForwardingAddressesDelete

    Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority.

  • users.gmailUsersSettingsForwardingAddressesGet

    Gets the specified forwarding address.

  • users.gmailUsersSettingsForwardingAddressesList

    Lists the forwarding addresses for the specified account.

  • users.gmailUsersSettingsGetAutoForwarding

    Gets the auto-forwarding setting for the specified account.

  • users.gmailUsersSettingsGetImap

    Gets IMAP settings.

  • users.gmailUsersSettingsGetLanguage

    Gets language settings.

  • users.gmailUsersSettingsGetPop

    Gets POP settings.

  • users.gmailUsersSettingsGetVacation

    Gets vacation responder settings.

  • users.gmailUsersSettingsSendAsCreate

    Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority.

  • users.gmailUsersSettingsSendAsDelete

    Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority.

  • users.gmailUsersSettingsSendAsGet

    Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.

  • users.gmailUsersSettingsSendAsList

    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.

  • users.gmailUsersSettingsSendAsPatch

    Patch the specified send-as alias.

  • users.gmailUsersSettingsSendAsSmimeInfoDelete

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

  • users.gmailUsersSettingsSendAsSmimeInfoGet

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

  • users.gmailUsersSettingsSendAsSmimeInfoInsert

    Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.

  • users.gmailUsersSettingsSendAsSmimeInfoList

    Lists S/MIME configs for the specified send-as alias.

  • users.gmailUsersSettingsSendAsSmimeInfoSetDefault

    Sets the default S/MIME config for the specified send-as alias.

  • users.gmailUsersSettingsSendAsUpdate

    Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.

  • users.gmailUsersSettingsSendAsVerify

    Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority.

  • users.gmailUsersSettingsUpdateAutoForwarding

    Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.

  • users.gmailUsersSettingsUpdateImap

    Updates IMAP settings.

  • users.gmailUsersSettingsUpdateLanguage

    Updates language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.

  • users.gmailUsersSettingsUpdatePop

    Updates POP settings.

  • users.gmailUsersSettingsUpdateVacation

    Updates vacation responder settings.

  • users.gmailUsersStop

    Stop receiving push notifications for the given user mailbox.

  • users.gmailUsersThreadsDelete

    Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer threads.trash instead.

  • users.gmailUsersThreadsGet

    Gets the specified thread.

  • users.gmailUsersThreadsList

    Lists the threads in the user's mailbox.

  • users.gmailUsersThreadsModify

    Modifies the labels applied to the thread. This applies to all messages in the thread.

  • users.gmailUsersThreadsTrash

    Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash.

  • users.gmailUsersThreadsUntrash

    Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash.

  • users.gmailUsersWatch

    Set up or update a push notification watch on the given user mailbox.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools