googleapis.com – gmail
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.gmailUsersDraftsCreateCreates a new draft with the
DRAFTlabel. -
users.gmailUsersDraftsDeleteImmediately and permanently deletes the specified draft. Does not simply trash it.
-
users.gmailUsersDraftsGetGets the specified draft.
-
users.gmailUsersDraftsListLists the drafts in the user's mailbox.
-
users.gmailUsersDraftsSendSends the specified, existing draft to the recipients in the
To,Cc, andBccheaders. -
users.gmailUsersDraftsUpdateReplaces a draft's content.
-
users.gmailUsersGetProfileGets the current user's Gmail profile.
-
users.gmailUsersHistoryListLists the history of all changes to the given mailbox. History results are returned in chronological order (increasing
historyId). -
users.gmailUsersLabelsCreateCreates a new label.
-
users.gmailUsersLabelsDeleteImmediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.
-
users.gmailUsersLabelsGetGets the specified label.
-
users.gmailUsersLabelsListLists all labels in the user's mailbox.
-
users.gmailUsersLabelsPatchPatch the specified label.
-
users.gmailUsersLabelsUpdateUpdates the specified label.
-
users.gmailUsersMessagesAttachmentsGetGets the specified message attachment.
-
users.gmailUsersMessagesBatchDeleteDeletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.
-
users.gmailUsersMessagesBatchModifyModifies the labels on the specified messages.
-
users.gmailUsersMessagesDeleteImmediately and permanently deletes the specified message. This operation cannot be undone. Prefer
messages.trashinstead. -
users.gmailUsersMessagesGetGets the specified message.
-
users.gmailUsersMessagesImportImports 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.gmailUsersMessagesInsertDirectly inserts a message into only this user's mailbox similar to
IMAP APPEND, bypassing most scanning and classification. Does not send a message. -
users.gmailUsersMessagesListLists the messages in the user's mailbox.
-
users.gmailUsersMessagesModifyModifies the labels on the specified message.
-
users.gmailUsersMessagesSendSends the specified message to the recipients in the
To,Cc, andBccheaders. For example usage, see . -
users.gmailUsersMessagesTrashMoves the specified message to the trash.
-
users.gmailUsersMessagesUntrashRemoves the specified message from the trash.
-
users.gmailUsersSettingsCseIdentitiesCreateCreates 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.gmailUsersSettingsCseIdentitiesDeleteDeletes 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.gmailUsersSettingsCseIdentitiesGetRetrieves a client-side encryption identity configuration.
-
users.gmailUsersSettingsCseIdentitiesListLists the client-side encrypted identities for an authenticated user.
-
users.gmailUsersSettingsCseIdentitiesPatchAssociates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's .
-
users.gmailUsersSettingsCseKeypairsCreateCreates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.
-
users.gmailUsersSettingsCseKeypairsDisableTurns 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.gmailUsersSettingsCseKeypairsEnableTurns 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.gmailUsersSettingsCseKeypairsGetRetrieves an existing client-side encryption key pair.
-
users.gmailUsersSettingsCseKeypairsListLists client-side encryption key pairs for an authenticated user.
-
users.gmailUsersSettingsCseKeypairsObliterateDeletes 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.gmailUsersSettingsDelegatesCreateAdds 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.gmailUsersSettingsDelegatesDeleteRemoves 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.gmailUsersSettingsDelegatesGetGets 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.gmailUsersSettingsDelegatesListLists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.
-
users.gmailUsersSettingsFiltersCreateCreates a filter. Note: you can only create a maximum of 1,000 filters.
-
users.gmailUsersSettingsFiltersDeleteImmediately and permanently deletes the specified filter.
-
users.gmailUsersSettingsFiltersGetGets a filter.
-
users.gmailUsersSettingsFiltersListLists the message filters of a Gmail user.
-
users.gmailUsersSettingsForwardingAddressesCreateCreates 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 toaccepted. This method is only available to service account clients that have been delegated domain-wide authority. -
users.gmailUsersSettingsForwardingAddressesDeleteDeletes 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.gmailUsersSettingsForwardingAddressesGetGets the specified forwarding address.
-
users.gmailUsersSettingsForwardingAddressesListLists the forwarding addresses for the specified account.
-
users.gmailUsersSettingsGetAutoForwardingGets the auto-forwarding setting for the specified account.
-
users.gmailUsersSettingsGetImapGets IMAP settings.
-
users.gmailUsersSettingsGetLanguageGets language settings.
-
users.gmailUsersSettingsGetPopGets POP settings.
-
users.gmailUsersSettingsGetVacationGets vacation responder settings.
-
users.gmailUsersSettingsSendAsCreateCreates 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 toaccepted. 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.gmailUsersSettingsSendAsDeleteDeletes 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.gmailUsersSettingsSendAsGetGets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.
-
users.gmailUsersSettingsSendAsListLists 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.gmailUsersSettingsSendAsPatchPatch the specified send-as alias.
-
users.gmailUsersSettingsSendAsSmimeInfoDeleteDeletes the specified S/MIME config for the specified send-as alias.
-
users.gmailUsersSettingsSendAsSmimeInfoGetGets the specified S/MIME config for the specified send-as alias.
-
users.gmailUsersSettingsSendAsSmimeInfoInsertInsert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.
-
users.gmailUsersSettingsSendAsSmimeInfoListLists S/MIME configs for the specified send-as alias.
-
users.gmailUsersSettingsSendAsSmimeInfoSetDefaultSets the default S/MIME config for the specified send-as alias.
-
users.gmailUsersSettingsSendAsUpdateUpdates 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.gmailUsersSettingsSendAsVerifySends 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.gmailUsersSettingsUpdateAutoForwardingUpdates 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.gmailUsersSettingsUpdateImapUpdates IMAP settings.
-
users.gmailUsersSettingsUpdateLanguageUpdates language settings. If successful, the return object contains the
displayLanguagethat was saved for the user, which may differ from the value passed into the request. This is because the requesteddisplayLanguagemay not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. -
users.gmailUsersSettingsUpdatePopUpdates POP settings.
-
users.gmailUsersSettingsUpdateVacationUpdates vacation responder settings.
-
users.gmailUsersStopStop receiving push notifications for the given user mailbox.
-
users.gmailUsersThreadsDeleteImmediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer
threads.trashinstead. -
users.gmailUsersThreadsGetGets the specified thread.
-
users.gmailUsersThreadsListLists the threads in the user's mailbox.
-
users.gmailUsersThreadsModifyModifies the labels applied to the thread. This applies to all messages in the thread.
-
users.gmailUsersThreadsTrashMoves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash.
-
users.gmailUsersThreadsUntrashRemoves the specified thread from the trash. Any messages that belong to the thread are also removed from the trash.
-
users.gmailUsersWatchSet up or update a push notification watch on the given user mailbox.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools