{"name":"gmail","version":"v1","revision":"20261005","title":"Gmail API","rootUrl":"https://gmail.googleapis.com/","servicePath":"","basePath":"","batchPath":"batch","methods":[{"id":"users.drafts.create","httpMethod":"POST","path":"gmail/v1/users/{userId}/drafts","flatPath":"gmail/v1/users/{userId}/drafts","description":"Creates a draft with the `DRAFT` label. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.addons.current.action.compose","https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.drafts.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/drafts/{id}","flatPath":"gmail/v1/users/{userId}/drafts/{id}","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.addons.current.action.compose","https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the draft to delete.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.drafts.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/drafts/{id}","flatPath":"gmail/v1/users/{userId}/drafts/{id}","description":"Gets the specified draft. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId","id"],"parameters":[{"name":"format","type":"string","required":false,"repeated":false,"location":"query","description":"The format to return the draft in.","enum":["minimal","full","raw","metadata"]},{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the draft to retrieve.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.drafts.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/drafts","flatPath":"gmail/v1/users/{userId}/drafts","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId"],"parameters":[{"name":"includeSpamTrash","type":"boolean","required":false,"repeated":false,"location":"query","description":"Include drafts from `SPAM` and `TRASH` in the results.","enum":null},{"name":"maxResults","type":"integer","required":false,"repeated":false,"location":"query","description":"Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Page token to retrieve a specific page of results in the list.","enum":null},{"name":"q","type":"string","required":false,"repeated":false,"location":"query","description":"Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.drafts.send","httpMethod":"POST","path":"gmail/v1/users/{userId}/drafts/send","flatPath":"gmail/v1/users/{userId}/drafts/send","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.addons.current.action.compose","https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.drafts.update","httpMethod":"PUT","path":"gmail/v1/users/{userId}/drafts/{id}","flatPath":"gmail/v1/users/{userId}/drafts/{id}","description":"Replaces a draft's content. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.addons.current.action.compose","https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the draft to update.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.getProfile","httpMethod":"GET","path":"gmail/v1/users/{userId}/profile","flatPath":"gmail/v1/users/{userId}/profile","description":"Gets the current user's Gmail profile.","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.history.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/history","flatPath":"gmail/v1/users/{userId}/history","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId"],"parameters":[{"name":"historyTypes","type":"string","required":false,"repeated":true,"location":"query","description":"History types to be returned by the function","enum":["messageAdded","messageDeleted","labelAdded","labelRemoved"]},{"name":"labelId","type":"string","required":false,"repeated":false,"location":"query","description":"Only return messages with a label matching the ID.","enum":null},{"name":"maxResults","type":"integer","required":false,"repeated":false,"location":"query","description":"Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Page token to retrieve a specific page of results in the list.","enum":null},{"name":"startHistoryId","type":"string","required":false,"repeated":false,"location":"query","description":"Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thre","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.labels.create","httpMethod":"POST","path":"gmail/v1/users/{userId}/labels","flatPath":"gmail/v1/users/{userId}/labels","description":"Creates a label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.modify"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.labels.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/labels/{id}","flatPath":"gmail/v1/users/{userId}/labels/{id}","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the label to delete.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.labels.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/labels/{id}","flatPath":"gmail/v1/users/{userId}/labels/{id}","description":"Gets the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the label to retrieve.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.labels.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/labels","flatPath":"gmail/v1/users/{userId}/labels","description":"Lists all labels in the user's mailbox. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.labels.patch","httpMethod":"PATCH","path":"gmail/v1/users/{userId}/labels/{id}","flatPath":"gmail/v1/users/{userId}/labels/{id}","description":"Patch the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the label to update.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.labels.update","httpMethod":"PUT","path":"gmail/v1/users/{userId}/labels/{id}","flatPath":"gmail/v1/users/{userId}/labels/{id}","description":"Updates the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the label to update.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.attachments.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}","flatPath":"gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}","description":"Gets the specified message attachment.","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.addons.current.message.action","https://www.googleapis.com/auth/gmail.addons.current.message.readonly","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId","messageId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the attachment.","enum":null},{"name":"messageId","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the message containing the attachment.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.batchDelete","httpMethod":"POST","path":"gmail/v1/users/{userId}/messages/batchDelete","flatPath":"gmail/v1/users/{userId}/messages/batchDelete","description":"Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.","scopes":["https://mail.google.com/"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.batchModify","httpMethod":"POST","path":"gmail/v1/users/{userId}/messages/batchModify","flatPath":"gmail/v1/users/{userId}/messages/batchModify","description":"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-wi","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/messages/{id}","flatPath":"gmail/v1/users/{userId}/messages/{id}","description":"Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.","scopes":["https://mail.google.com/"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the message to delete.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/messages/{id}","flatPath":"gmail/v1/users/{userId}/messages/{id}","description":"Gets the specified message.","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.addons.current.message.action","https://www.googleapis.com/auth/gmail.addons.current.message.metadata","https://www.googleapis.com/auth/gmail.addons.current.message.readonly","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId","id"],"parameters":[{"name":"format","type":"string","required":false,"repeated":false,"location":"query","description":"The format to return the message in.","enum":["minimal","full","raw","metadata"]},{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messa","enum":null},{"name":"metadataHeaders","type":"string","required":false,"repeated":true,"location":"query","description":"When given and format is `METADATA`, only include headers specified.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.import","httpMethod":"POST","path":"gmail/v1/users/{userId}/messages/import","flatPath":"gmail/v1/users/{userId}/messages/import","description":"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","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.insert","https://www.googleapis.com/auth/gmail.modify"],"required":["userId"],"parameters":[{"name":"deleted","type":"boolean","required":false,"repeated":false,"location":"query","description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","enum":null},{"name":"internalDateSource","type":"string","required":false,"repeated":false,"location":"query","description":"Source for Gmail's internal date of the message.","enum":["receivedTime","dateHeader"]},{"name":"neverMarkSpam","type":"boolean","required":false,"repeated":false,"location":"query","description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.","enum":null},{"name":"processForCalendar","type":"boolean","required":false,"repeated":false,"location":"query","description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.insert","httpMethod":"POST","path":"gmail/v1/users/{userId}/messages","flatPath":"gmail/v1/users/{userId}/messages","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.insert","https://www.googleapis.com/auth/gmail.modify"],"required":["userId"],"parameters":[{"name":"deleted","type":"boolean","required":false,"repeated":false,"location":"query","description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","enum":null},{"name":"internalDateSource","type":"string","required":false,"repeated":false,"location":"query","description":"Source for Gmail's internal date of the message.","enum":["receivedTime","dateHeader"]},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/messages","flatPath":"gmail/v1/users/{userId}/messages","description":"Lists the messages in the user's mailbox. For more information, see [List Gmail messages](https://developers.google.com/workspace/gmail/api/guides/list-messages).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId"],"parameters":[{"name":"includeSpamTrash","type":"boolean","required":false,"repeated":false,"location":"query","description":"Include messages from `SPAM` and `TRASH` in the results.","enum":null},{"name":"labelIds","type":"string","required":false,"repeated":true,"location":"query","description":"Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't ","enum":null},{"name":"maxResults","type":"integer","required":false,"repeated":false,"location":"query","description":"Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Page token to retrieve a specific page of results in the list.","enum":null},{"name":"q","type":"string","required":false,"repeated":false,"location":"query","description":"Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid:","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.modify","httpMethod":"POST","path":"gmail/v1/users/{userId}/messages/{id}/modify","flatPath":"gmail/v1/users/{userId}/messages/{id}/modify","description":"Modifies the labels and the Classification Label values on the specified message. For administrators modifying message for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the message to modify.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.send","httpMethod":"POST","path":"gmail/v1/users/{userId}/messages/send","flatPath":"gmail/v1/users/{userId}/messages/send","description":"Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.addons.current.action.compose","https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.send"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.trash","httpMethod":"POST","path":"gmail/v1/users/{userId}/messages/{id}/trash","flatPath":"gmail/v1/users/{userId}/messages/{id}/trash","description":"Moves the specified message to the trash.","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the message to Trash.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.messages.untrash","httpMethod":"POST","path":"gmail/v1/users/{userId}/messages/{id}/untrash","flatPath":"gmail/v1/users/{userId}/messages/{id}/untrash","description":"Removes the specified message from the trash.","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the message to remove from Trash.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.cse.identities.create","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/cse/identities","flatPath":"gmail/v1/users/{userId}/settings/cse/identities","description":"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. For administrators","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.identities.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}","flatPath":"gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}","description":"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. For administrators manag","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","cseEmailAddress"],"parameters":[{"name":"cseEmailAddress","type":"string","required":true,"repeated":false,"location":"path","description":"The primary email address associated with the client-side encryption identity configuration that's removed.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.identities.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}","flatPath":"gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}","description":"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 delegat","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","cseEmailAddress"],"parameters":[{"name":"cseEmailAddress","type":"string","required":true,"repeated":false,"location":"path","description":"The primary email address associated with the client-side encryption identity configuration that's retrieved.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.identities.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/cse/identities","flatPath":"gmail/v1/users/{userId}/settings/cse/identities","description":"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-w","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"query","description":"The number of identities to return. If not provided, the page size will default to 20 entries.","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.identities.patch","httpMethod":"PATCH","path":"gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}","flatPath":"gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}","description":"Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's [S/MIME certificate profiles](https://support.google.com/a/answer/7300887). For administrators managing identities and keypairs for users in their organization, reque","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","emailAddress"],"parameters":[{"name":"emailAddress","type":"string","required":true,"repeated":false,"location":"path","description":"The email address of the client-side encryption identity to update.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.keypairs.create","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/cse/keypairs","flatPath":"gmail/v1/users/{userId}/settings/cse/keypairs","description":"Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId"],"parameters":[{"name":"chainValidation","type":"string","required":false,"repeated":false,"location":"query","description":"The type of certificate chain validation to perform at creation. The request will be rejected if the uploaded chain fails to satisfy the requested validation ch","enum":["all","none"]},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.keypairs.disable","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable","flatPath":"gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable","description":"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 ","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","keyPairId"],"parameters":[{"name":"keyPairId","type":"string","required":true,"repeated":false,"location":"path","description":"The identifier of the key pair to turn off.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.keypairs.enable","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable","flatPath":"gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable","description":"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. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https:/","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","keyPairId"],"parameters":[{"name":"keyPairId","type":"string","required":true,"repeated":false,"location":"path","description":"The identifier of the key pair to turn on.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.keypairs.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}","flatPath":"gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}","description":"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 ","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","keyPairId"],"parameters":[{"name":"keyPairId","type":"string","required":true,"repeated":false,"location":"path","description":"The identifier of the key pair to retrieve.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.keypairs.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/cse/keypairs","flatPath":"gmail/v1/users/{userId}/settings/cse/keypairs","description":"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 ","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"query","description":"The number of key pairs to return. If not provided, the page size will default to 20 entries.","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.cse.keypairs.obliterate","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate","flatPath":"gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate","description":"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 obliterate","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","keyPairId"],"parameters":[{"name":"keyPairId","type":"string","required":true,"repeated":false,"location":"path","description":"The identifier of the key pair to obliterate.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","enum":null}]},{"id":"users.settings.delegates.create","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/delegates","flatPath":"gmail/v1/users/{userId}/settings/delegates","description":"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. For more information, see [Manage delegates](https://developers.google.com/workspace/gm","scopes":["https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.delegates.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/settings/delegates/{delegateEmail}","flatPath":"gmail/v1/users/{userId}/settings/delegates/{delegateEmail}","description":"Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. For more information, see [Manage delegates](https://developers.google.com/workspace/gmail/api/guides/delegate_settings). A delegate user must be referred ","scopes":["https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","delegateEmail"],"parameters":[{"name":"delegateEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The email address of the user to be removed as a delegate.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.delegates.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/delegates/{delegateEmail}","flatPath":"gmail/v1/users/{userId}/settings/delegates/{delegateEmail}","description":"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 ","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId","delegateEmail"],"parameters":[{"name":"delegateEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The email address of the user whose delegate relationship is to be retrieved.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.delegates.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/delegates","flatPath":"gmail/v1/users/{userId}/settings/delegates","description":"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.","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.filters.create","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/filters","flatPath":"gmail/v1/users/{userId}/settings/filters","description":"Creates a filter. Note: you can only create a maximum of 1,000 filters. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","scopes":["https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.filters.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/settings/filters/{id}","flatPath":"gmail/v1/users/{userId}/settings/filters/{id}","description":"Immediately and permanently deletes the specified filter. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","scopes":["https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the filter to be deleted.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.filters.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/filters/{id}","flatPath":"gmail/v1/users/{userId}/settings/filters/{id}","description":"Gets a filter. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the filter to be fetched.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.filters.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/filters","flatPath":"gmail/v1/users/{userId}/settings/filters","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.forwardingAddresses.create","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/forwardingAddresses","flatPath":"gmail/v1/users/{userId}/settings/forwardingAddresses","description":"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`. For more information, see [Manage email fo","scopes":["https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.forwardingAddresses.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}","flatPath":"gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}","description":"Deletes the specified forwarding address and revokes any verification that may have been required. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings). This method is only available to service account clients that have bee","scopes":["https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","forwardingEmail"],"parameters":[{"name":"forwardingEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The forwarding address to be deleted.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.forwardingAddresses.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}","flatPath":"gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}","description":"Gets the specified forwarding address. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId","forwardingEmail"],"parameters":[{"name":"forwardingEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The forwarding address to be retrieved.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.forwardingAddresses.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/forwardingAddresses","flatPath":"gmail/v1/users/{userId}/settings/forwardingAddresses","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.getAutoForwarding","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/autoForwarding","flatPath":"gmail/v1/users/{userId}/settings/autoForwarding","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.getImap","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/imap","flatPath":"gmail/v1/users/{userId}/settings/imap","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.getLanguage","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/language","flatPath":"gmail/v1/users/{userId}/settings/language","description":"Gets language settings. For more information, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.getPop","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/pop","flatPath":"gmail/v1/users/{userId}/settings/pop","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.getVacation","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/vacation","flatPath":"gmail/v1/users/{userId}/settings/vacation","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.create","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/sendAs","flatPath":"gmail/v1/users/{userId}/settings/sendAs","description":"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 verificat","scopes":["https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}","description":"Deletes the specified send-as alias. Revokes any verification that may have been required for using it. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings). This method is only available t","scopes":["https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","sendAsEmail"],"parameters":[{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The send-as alias to be deleted.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId","sendAsEmail"],"parameters":[{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The send-as alias to be retrieved.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/sendAs","flatPath":"gmail/v1/users/{userId}/settings/sendAs","description":"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","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.patch","httpMethod":"PATCH","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}","description":"Patch the specified send-as alias. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings).","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","sendAsEmail"],"parameters":[{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The send-as alias to be updated.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.smimeInfo.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}","description":"Deletes 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).","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","sendAsEmail","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The immutable ID for the SmimeInfo.","enum":null},{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The email address that appears in the \"From:\" header for mail sent using this alias.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.smimeInfo.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","sendAsEmail","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The immutable ID for the SmimeInfo.","enum":null},{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The email address that appears in the \"From:\" header for mail sent using this alias.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.smimeInfo.insert","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo","description":"Insert (upload) the given S/MIME config for the specified send-as alias. Note that `pkcs12` format is required for the key. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","sendAsEmail"],"parameters":[{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The email address that appears in the \"From:\" header for mail sent using this alias.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.smimeInfo.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","sendAsEmail"],"parameters":[{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The email address that appears in the \"From:\" header for mail sent using this alias.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.smimeInfo.setDefault","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault","description":"Sets the default 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).","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","sendAsEmail","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The immutable ID for the SmimeInfo.","enum":null},{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The email address that appears in the \"From:\" header for mail sent using this alias.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.update","httpMethod":"PUT","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}","description":"Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings). Addresses other than","scopes":["https://www.googleapis.com/auth/gmail.settings.basic","https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","sendAsEmail"],"parameters":[{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The send-as alias to be updated.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.sendAs.verify","httpMethod":"POST","path":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify","flatPath":"gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify","description":"Sends a verification email to the specified send-as alias address. The verification status must be `pending`. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings). This method is only avail","scopes":["https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId","sendAsEmail"],"parameters":[{"name":"sendAsEmail","type":"string","required":true,"repeated":false,"location":"path","description":"The send-as alias to be verified.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.updateAutoForwarding","httpMethod":"PUT","path":"gmail/v1/users/{userId}/settings/autoForwarding","flatPath":"gmail/v1/users/{userId}/settings/autoForwarding","description":"Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings). This method is only avail","scopes":["https://www.googleapis.com/auth/gmail.settings.sharing"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.updateImap","httpMethod":"PUT","path":"gmail/v1/users/{userId}/settings/imap","flatPath":"gmail/v1/users/{userId}/settings/imap","description":"Updates 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).","scopes":["https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.updateLanguage","httpMethod":"PUT","path":"gmail/v1/users/{userId}/settings/language","flatPath":"gmail/v1/users/{userId}/settings/language","description":"Updates language settings. For more information, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/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 re","scopes":["https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.updatePop","httpMethod":"PUT","path":"gmail/v1/users/{userId}/settings/pop","flatPath":"gmail/v1/users/{userId}/settings/pop","description":"Updates 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).","scopes":["https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.settings.updateVacation","httpMethod":"PUT","path":"gmail/v1/users/{userId}/settings/vacation","flatPath":"gmail/v1/users/{userId}/settings/vacation","description":"Updates vacation responder settings. For more information, see [Manage vacation settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/vacation_settings).","scopes":["https://www.googleapis.com/auth/gmail.settings.basic"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","enum":null}]},{"id":"users.stop","httpMethod":"POST","path":"gmail/v1/users/{userId}/stop","flatPath":"gmail/v1/users/{userId}/stop","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.threads.delete","httpMethod":"DELETE","path":"gmail/v1/users/{userId}/threads/{id}","flatPath":"gmail/v1/users/{userId}/threads/{id}","description":"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. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","scopes":["https://mail.google.com/"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"ID of the Thread to delete.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.threads.get","httpMethod":"GET","path":"gmail/v1/users/{userId}/threads/{id}","flatPath":"gmail/v1/users/{userId}/threads/{id}","description":"Gets the specified thread. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.addons.current.message.action","https://www.googleapis.com/auth/gmail.addons.current.message.metadata","https://www.googleapis.com/auth/gmail.addons.current.message.readonly","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId","id"],"parameters":[{"name":"format","type":"string","required":false,"repeated":false,"location":"query","description":"The format to return the messages in.","enum":["full","metadata","minimal"]},{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the thread to retrieve.","enum":null},{"name":"metadataHeaders","type":"string","required":false,"repeated":true,"location":"query","description":"When given and format is METADATA, only include headers specified.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.threads.list","httpMethod":"GET","path":"gmail/v1/users/{userId}/threads","flatPath":"gmail/v1/users/{userId}/threads","description":"Lists the threads in the user's mailbox. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId"],"parameters":[{"name":"includeSpamTrash","type":"boolean","required":false,"repeated":false,"location":"query","description":"Include threads from `SPAM` and `TRASH` in the results.","enum":null},{"name":"labelIds","type":"string","required":false,"repeated":true,"location":"query","description":"Only return threads with labels that match all of the specified label IDs.","enum":null},{"name":"maxResults","type":"integer","required":false,"repeated":false,"location":"query","description":"Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500.","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Page token to retrieve a specific page of results in the list.","enum":null},{"name":"q","type":"string","required":false,"repeated":false,"location":"query","description":"Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: ","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.threads.modify","httpMethod":"POST","path":"gmail/v1/users/{userId}/threads/{id}/modify","flatPath":"gmail/v1/users/{userId}/threads/{id}/modify","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the thread to modify.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.threads.trash","httpMethod":"POST","path":"gmail/v1/users/{userId}/threads/{id}/trash","flatPath":"gmail/v1/users/{userId}/threads/{id}/trash","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the thread to Trash.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.threads.untrash","httpMethod":"POST","path":"gmail/v1/users/{userId}/threads/{id}/untrash","flatPath":"gmail/v1/users/{userId}/threads/{id}/untrash","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.modify"],"required":["userId","id"],"parameters":[{"name":"id","type":"string","required":true,"repeated":false,"location":"path","description":"The ID of the thread to remove from Trash.","enum":null},{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]},{"id":"users.watch","httpMethod":"POST","path":"gmail/v1/users/{userId}/watch","flatPath":"gmail/v1/users/{userId}/watch","description":"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).","scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly"],"required":["userId"],"parameters":[{"name":"userId","type":"string","required":true,"repeated":false,"location":"path","description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","enum":null}]}]}