{"openapi":"3.0.0","info":{"description":"Email service","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Email service","url":"https://api.apirails.com/gmail"}],"paths":{"/batch":{"post":{"tags":["Batch"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/guides/batch","api_endpoint":"https://gmail.googleapis.com/batch"},"summary":"Batch requests","description":"Combines multiple API calls into a single HTTP request to reduce the number of HTTP connections","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"requests":{"type":"array","description":"Array of API requests to batch process. Each request should include method, path, and body/params as needed","required":true,"items":{"type":"object","properties":{"method":{"type":"string","description":"HTTP method for the batch request"},"path":{"type":"string","description":"API endpoint path for the request"},"params":{"type":"object","description":"Query parameters for the request"},"body":{"type":"object","description":"Request body for POST/PUT requests"}}}}}},"example":{"requests":[{"method":"GET","params":{"maxResults":10},"path":"/gmail/v1/users/me/messages"}]}}}}}},"/v1/users/{userId}/messages/send":{"post":{"tags":["Send"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/send"},"summary":"Send email","description":"Send email Gamil uses RFC 2822 formatted, base64url encoded string as a payload for sending email. To, From, Subject, CC, BCC, ReplyTo gets formatted as per RFC 2822 and gets converted to base64string ``` // RFC2822 payload format From: Name<send@example.com> To: hello@example.com Content-Type: text/html; charset=utf-8 MIME-Version: 1.0 Subject: =?utf-8?B?SGVsbG8=?= <p>This is email</p> ``` ### Sending Quota You can send 100* email per day on free gmail account. You can send 1500 - 2000* email per day on Google workspace account.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"raw":{"type":"string","description":"RFC 2822 formatted and base64url encoded string","required":true},"snippet":{"type":"string","description":"A short part of the message text","required":true}}},"example":{"raw":"","snippet":""}}}}}},"/upload/gmail/v1/users/{userId}/messages/send":{"post":{"tags":["Send"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send","api_endpoint":"https://gmail.googleapis.com/upload/gmail/v1/users/{userId}/messages/send"},"summary":"Send email with attachement","description":"Send email with attachments Gamil uses RFC 2822 formatted, base64url encoded string as a payload for sending email. To, From, Subject, CC, BCC, ReplyTo gets formatted as per RFC 2822 and gets converted to base64string ``` // RFC2822 payload format From: Name<send@example.com> To: hello@example.com Content-Type: text/html; charset=utf-8 MIME-Version: 1.0 Subject: =?utf-8?B?SGVsbG8=?= <p>This is email</p> ``` ### Sending Quota You can send 100* email per day on free gmail account. You can send 1500 - 2000* email per day on Google workspace account.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"payload":{"type":"object","description":"The parsed email structure in the message parts","required":true,"properties":{"partId":{"type":"string","description":"The immutable ID of the message part"},"mimeType":{"type":"string","description":"The MIME type of the message part"},"filename":{"type":"string","description":"The filename of the attachment. Only present if this message part represents an attachment"},"headers":{"type":"array","description":"List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject"},"body":{"type":"object","description":"The message part body for this part, which may be empty for container MIME message parts"},"parts":{"type":"array","description":"The child MIME message parts of this part. Only applies to container MIME message parts, for example multipart/*"}}},"raw":{"type":"string","description":"RFC 2822 formatted and base64url encoded string","required":true},"snippet":{"type":"string","description":"A short part of the message text","required":true}}},"example":{"payload":{},"raw":"","snippet":""}}}}}},"/v1/users/{userId}/profile":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users/getProfile","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/profile"},"summary":"Gets the current user's Gmail profile","description":"Gets the current user's Gmail profile","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/stop":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users/stop","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/stop"},"summary":"Stop push notifications for mailbox","description":"Stop receiving push notifications for the given user mailbox","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/watch":{"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users/watch","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/watch"},"summary":"Configure push notification for user mailbox","description":"Set up or update a push notification watch on the given user mailbox.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labelFilterAction":{"type":"enum","description":"Filtering behavior of labelIds list specified","enum":["include","exclude"]},"labelFilterBehavior":{"type":"enum","description":"Filtering behavior of labelIds list specified","enum":["include","exclude"]},"labelIds[]":{"type":"string","description":"List of labelIds to restrict notifications about"},"topicName":{"type":"string","description":"A fully qualified Google Cloud Pub/Sub API topic name to publish the events to"}}},"example":{"labelFilterAction":"","labelFilterBehavior":"","labelIds[]":"","topicName":""}}}}}},"/v1/users/{userId}/history":{"get":{"tags":["Users"],"parameters":[{"name":"historyTypes","in":"query","description":"History types to be returned by the function","schema":{"type":"enum","example":"","items":{"type":"string","enum":["messageAdded","messageDeleted","labelAdded","labelRemoved"]}}},{"name":"labelId","in":"query","description":"Only return messages with a label matching the ID.","schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"Maximum number of history records to return","schema":{"type":"integer","example":"","items":{"type":"string","enum":["defaults-100"]}}},{"name":"pageToken","in":"query","description":"Page token to retrieve a specific page of results in the list","schema":{"type":"string","example":""}},{"name":"startHistoryId","in":"query","description":"Returns history records after the specified startHistoryId","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.history/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/history"},"summary":"Mailbox change history list","description":"Lists the history of all changes to the given mailbox","security":[{"bearerAuth":[]}]}},"/upload/gmail/v1/users/{userId}/drafts":{"post":{"tags":["Draft"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/create","api_endpoint":"https://gmail.googleapis.com/upload/gmail/v1/users/{userId}/drafts"},"summary":"Creates draft with DRAFT label","description":"Creates a new draft with the DRAFT label.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/drafts/{id}":{"delete":{"tags":["Draft"],"parameters":[{"name":"id","in":"path","description":"The ID of the draft to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/drafts/{id}"},"summary":"Deletes the specified draft","description":"Deletes the specified draft","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Draft"],"parameters":[{"name":"id","in":"path","description":"The ID of the draft to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"format","in":"query","description":"The format to return the draft in","schema":{"type":"enum","example":"","items":{"type":"string","enum":["minimal","full","raw","metadata"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/drafts/{id}"},"summary":"Gets the specified draft","description":"Gets the specified draft.","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/drafts":{"get":{"tags":["Draft"],"parameters":[{"name":"includeSpamTrash","in":"query","description":"Include drafts from SPAM and TRASH in the results","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"maxResults","in":"query","description":"Maximum number of drafts to return","schema":{"type":"integer","example":"","items":{"type":"string","enum":["defaults-100"]}}},{"name":"pageToken","in":"query","description":"Page token to retrieve a specific page of results in the list","schema":{"type":"string","example":""}},{"name":"q","in":"query","description":"Only return draft messages matching the specified query","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/drafts"},"summary":"Lists the drafts in the user's mailbox","description":"Lists the drafts in the user's mailbox","security":[{"bearerAuth":[]}]}},"/upload/gmail/v1/users/{userId}/drafts/send":{"post":{"tags":["Draft"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/send","api_endpoint":"https://gmail.googleapis.com/upload/gmail/v1/users/{userId}/drafts/send"},"summary":"Send draft to specified recipients","description":"Sends the specified, existing draft to the recipients","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/upload/gmail/v1/users/{userId}/drafts/{id}":{"put":{"tags":["Draft"],"parameters":[{"name":"id","in":"path","description":"The ID of the draft to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/update","api_endpoint":"https://gmail.googleapis.com/upload/gmail/v1/users/{userId}/drafts/{id}"},"summary":"Replaces a draft's content","description":"Replaces a draft's content","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/labels":{"post":{"tags":["Labels"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.labels/create","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/labels"},"summary":"Creates a new label","description":"Creates a new label","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Labels"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.labels/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/labels"},"summary":"Lists all labels in the user's mailbox","description":"Lists all labels in the user's mailbox","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/labels/{id}":{"delete":{"tags":["Labels"],"parameters":[{"name":"id","in":"path","description":"The ID of the label to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.labels/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/labels/{id}"},"summary":"Delete label, remove permanently","description":"Immediately and permanently deletes the specified label and removes","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Labels"],"parameters":[{"name":"id","in":"path","description":"The ID of the label to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.labels/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/labels/{id}"},"summary":"Gets the specified label","description":"Gets the specified label.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Labels"],"parameters":[{"name":"id","in":"path","description":"The ID of the label to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.labels/patch","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/labels/{id}"},"summary":"Patch the specified label","description":"Patch the specified label.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Labels"],"parameters":[{"name":"id","in":"path","description":"The ID of the label to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.labels/update","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/labels/{id}"},"summary":"Updates the specified label","description":"Updates the specified label.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/messages/batchDelete":{"post":{"tags":["Messages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/batchDelete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchDelete"},"summary":"Delete messages by message ID","description":"Deletes many messages by message ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ids":{"type":"array","description":"The IDs of the messages to delete","required":true,"items":{"type":"string"}}}},"example":{"ids":[]}}}}}},"/v1/users/{userId}/messages/batchModify":{"post":{"tags":["Messages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/batchModify","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify"},"summary":"Label modification for specified messages","description":"Modifies the labels on the specified messages.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ids":{"type":"array","description":"The IDs of the messages to modify","required":true,"items":{"type":"string"}},"addLabelIds":{"type":"array","description":"A list of label IDs to add to the messages","items":{"type":"string"}},"removeLabelIds":{"type":"array","description":"A list of label IDs to remove from the messages","items":{"type":"string"}}}},"example":{"ids":[],"addLabelIds":[],"removeLabelIds":[]}}}}}},"/v1/users/{userId}/messages/{id}":{"delete":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"The ID of the message to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}"},"summary":"Instantly erases specified message, permanently","description":"Immediately and permanently deletes the specified message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"The ID of the message to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"format","in":"query","description":"The format to return the message in","schema":{"type":"enum","example":"","items":{"type":"string","enum":["minimal","full","raw","metadata"]}}},{"name":"metadataHeaders[]","in":"query","description":"When given and format is METADATA, only include headers specified","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}"},"summary":"Gets the specified message.","description":"Gets the specified message.","security":[{"bearerAuth":[]}]}},"/upload/gmail/v1/users/{userId}/messages/import":{"post":{"tags":["Messages"],"parameters":[{"name":"deleted","in":"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.","schema":{"type":"boolean","example":""}},{"name":"internalDateSource","in":"query","description":"Source for Gmail's internal date of the message","schema":{"type":"string","example":"","items":{"type":"string","enum":["receivedTime","dateHeader"]}}},{"name":"neverMarkSpam","in":"query","description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox","schema":{"type":"boolean","example":""}},{"name":"processForCalendar","in":"query","description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user","schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/import","api_endpoint":"https://gmail.googleapis.com/upload/gmail/v1/users/{userId}/messages/import"},"summary":"Message imported to user's mailbox","description":"Imports a message into only this user's mailbox","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"labelIds":{"type":"array","description":"List of IDs of labels to apply to this message","items":{"type":"string"}},"payload":{"type":"object","description":"The parsed email structure in the message parts","properties":{"partId":{"type":"string","description":"The immutable ID of the message part"},"mimeType":{"type":"string","description":"The MIME type of the message part"},"filename":{"type":"string","description":"The filename of the attachment. Only present if this message part represents an attachment"},"headers":{"type":"array","description":"List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject"},"body":{"type":"object","description":"The message part body for this part, which may be empty for container MIME message parts"},"parts":{"type":"array","description":"The child MIME message parts of this part. Only applies to container MIME message parts, for example multipart/*"}}},"raw":{"type":"string","description":"RFC 2822 formatted and base64url encoded string"},"snippet":{"type":"string","description":"A short part of the message text"},"threadId":{"type":"string","description":"The ID of the thread the message belongs to"}}},"example":{"labelIds":[],"payload":{},"raw":"","snippet":"","threadId":""}}}}}},"/upload/gmail/v1/users/{userId}/messages":{"post":{"tags":["Messages"],"parameters":[{"name":"deleted","in":"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.","schema":{"type":"boolean","example":""}},{"name":"internalDateSource","in":"query","description":"Source for Gmail's internal date of the message","schema":{"type":"string","example":"","items":{"type":"string","enum":["receivedTime","dateHeader"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/insert","api_endpoint":"https://gmail.googleapis.com/upload/gmail/v1/users/{userId}/messages"},"summary":"Message insertion into user's mailbox","description":"Directly inserts a message into only this user's mailbox","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"labelIds":{"type":"array","description":"List of IDs of labels to apply to this message","items":{"type":"string"}},"payload":{"type":"object","description":"The parsed email structure in the message parts","properties":{"partId":{"type":"string","description":"The immutable ID of the message part"},"mimeType":{"type":"string","description":"The MIME type of the message part"},"filename":{"type":"string","description":"The filename of the attachment. Only present if this message part represents an attachment"},"headers":{"type":"array","description":"List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject"},"body":{"type":"object","description":"The message part body for this part, which may be empty for container MIME message parts"},"parts":{"type":"array","description":"The child MIME message parts of this part. Only applies to container MIME message parts, for example multipart/*"}}},"raw":{"type":"string","description":"RFC 2822 formatted and base64url encoded string"},"snippet":{"type":"string","description":"A short part of the message text"},"threadId":{"type":"string","description":"The ID of the thread the message belongs to"}}},"example":{"labelIds":[],"payload":{},"raw":"","snippet":"","threadId":""}}}}}},"/v1/users/{userId}/messages":{"get":{"tags":["Messages"],"parameters":[{"name":"includeSpamTrash","in":"query","description":"Include messages from SPAM and TRASH in the results","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"labelIds","in":"query","description":"Only return messages with labels that match all of the specified label IDs","schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"Maximum number of messages to return defaults-100 maximum-500","schema":{"type":"integer","example":""}},{"name":"pageToken","in":"query","description":"Page token to retrieve a specific page of results in the list","schema":{"type":"string","example":""}},{"name":"q","in":"query","description":"Only return messages matching the specified query","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages"},"summary":"Listing user's mailbox messages","description":"Lists the messages in the user's mailbox.","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/messages/{id}/modify":{"post":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"The ID of the message to modify","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify"},"summary":"Message label modification","description":"Modifies the labels on the specified message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"addLabelIds":{"type":"array","description":"A list of IDs of labels to add to this message","items":{"type":"string"}},"removeLabelIds":{"type":"array","description":"A list of IDs of labels to remove from this message","items":{"type":"string"}}}},"example":{"addLabelIds":[],"removeLabelIds":[]}}}}}},"/v1/users/{userId}/messages/{id}/trash":{"post":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"The ID of the message to trash","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/trash","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/trash"},"summary":"Moves message to the trash","description":"Moves the specified message to the trash","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/messages/{id}/untrash":{"post":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"The ID of the message to remove from trash","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages/untrash","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/untrash"},"summary":"Remove message from trash","description":"Removes the specified message from the trash","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/messages/{messageId}/attachments/{id}":{"get":{"tags":["Messages"],"parameters":[{"name":"id","in":"path","description":"The ID of the attachment","required":true,"schema":{"type":"string","example":""}},{"name":"messageId","in":"path","description":"The ID of the message containing the attachment","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.messages.attachments/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}"},"summary":"Gets the specified message attachment","description":"Gets the specified message attachment","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/autoForwarding":{"get":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/getAutoForwarding","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/autoForwarding"},"summary":"Retrieve auto-forwarding setting for account","description":"Gets the auto-forwarding setting for the specified account","security":[{"bearerAuth":[]}]},"put":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updateAutoForwarding","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/autoForwarding"},"summary":"Update auto-forwarding setting","description":"Updates the auto-forwarding setting for the specified account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/imap":{"get":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/getImap","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/imap"},"summary":"Gets IMAP settings","description":"Gets IMAP settings","security":[{"bearerAuth":[]}]},"put":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updateImap","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/imap"},"summary":"Updates IMAP settings","description":"Updates IMAP settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/language":{"get":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/getLanguage","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/language"},"summary":"Gets language settings","description":"Gets language settings","security":[{"bearerAuth":[]}]},"put":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updateLanguage","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/language"},"summary":"Updates language settings","description":"Updates language settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/pop":{"get":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/getPop","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/pop"},"summary":"Gets POP settings","description":"Gets POP settings","security":[{"bearerAuth":[]}]},"put":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updatePop","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/pop"},"summary":"Updates POP settings","description":"Updates POP settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/vacation":{"get":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/getVacation","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/vacation"},"summary":"Gets vacation responder settings","description":"Gets vacation responder settings","security":[{"bearerAuth":[]}]},"put":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updateVacation","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/vacation"},"summary":"Updates vacation responder settings","description":"Updates vacation responder settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/delegates":{"post":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.delegates/create","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates"},"summary":"Adds a delegate","description":"Adds a delegate","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.delegates/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates"},"summary":"Account delegates listing","description":"Lists the delegates for the specified account","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/delegates/{delegateEmail}":{"delete":{"tags":["Settings"],"parameters":[{"name":"delegateEmail","in":"path","description":"The email address of the user to be removed as a delegate","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.delegates/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}"},"summary":"Removes the specified delegate","description":"Removes the specified delegate","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[{"name":"delegateEmail","in":"path","description":"The email address of the user whose delegate relationship is to be retrieved","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.delegates/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}"},"summary":"Gets the specified delegate","description":"Gets the specified delegate","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/filters":{"post":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.filters/create","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters"},"summary":"Creates a filter","description":"Creates a filter","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[{"name":"userId","in":"path","description":"The user's email address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.filters/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters"},"summary":"Lists the message filters of a Gmail user","description":"Lists the message filters of a Gmail user","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/filters/{id}":{"delete":{"tags":["Settings"],"parameters":[{"name":"id","in":"path","description":"The ID of the filter to be deleted","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.filters/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters/{id}"},"summary":"Delete filter permanently","description":"Immediately and permanently deletes the specified filter","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[{"name":"id","in":"path","description":"The ID of the filter to be fetched","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.filters/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters/{id}"},"summary":"Gets a filter","description":"Gets a filter","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/forwardingAddresses":{"post":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.forwardingAddresses/create","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses"},"summary":"Creates a forwarding address","description":"Creates a forwarding address","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.forwardingAddresses/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses"},"summary":"Forwarding address list for specified account","description":"Lists the forwarding addresses for the specified account","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}":{"delete":{"tags":["Settings"],"parameters":[{"name":"forwardingEmail","in":"path","description":"The forwarding address to be deleted","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.forwardingAddresses/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}"},"summary":"Deletes the specified forwarding address","description":"Deletes the specified forwarding address","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[{"name":"forwardingEmail","in":"path","description":"The forwarding address to be retrieved","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.forwardingAddresses/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}"},"summary":"Gets the specified forwarding address","description":"Gets the specified forwarding address","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/sendAs":{"post":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/create","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs"},"summary":"Creates a custom \"from\" send-as alias","description":"Creates a custom \"from\" send-as alias","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[{"name":"userId","in":"path","description":"The user's email address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs"},"summary":"Send-as aliases listed for account","description":"Lists the send-as aliases for the specified account","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/sendAs/{sendAsEmail}":{"delete":{"tags":["Settings"],"parameters":[{"name":"sendAsEmail","in":"path","description":"The send-as alias to be deleted","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}"},"summary":"Deletes the specified send-as alias","description":"Deletes the specified send-as alias","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[{"name":"sendAsEmail","in":"path","description":"The send-as alias to be retrieved","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}"},"summary":"Gets the specified send-as alias","description":"Gets the specified send-as alias","security":[{"bearerAuth":[]}]},"patch":{"tags":["Settings"],"parameters":[{"name":"sendAsEmail","in":"path","description":"The send-as alias to be updated","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/patch","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}"},"summary":"Patch the specified send-as alias","description":"Patch the specified send-as alias","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Settings"],"parameters":[{"name":"sendAsEmail","in":"path","description":"The send-as alias to be updated","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/update","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}"},"summary":"Updates a send-as alias","description":"Updates a send-as alias","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify":{"post":{"tags":["Settings"],"parameters":[{"name":"sendAsEmail","in":"path","description":"The send-as alias to be verified","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/verify","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify"},"summary":"Verify send-as alias with email","description":"Sends a verification email to the specified send-as alias address","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}":{"delete":{"tags":["Settings"],"parameters":[{"name":"id","in":"path","description":"The immutable ID for the SmimeInfo","required":true,"schema":{"type":"string","example":""}},{"name":"sendAsEmail","in":"path","description":"The email address that appears in the \"From\" header for mail sent using this alias","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}"},"summary":"S/MIME config deletion for send-as alias","description":"Deletes the specified S/MIME config for the specified send-as alias","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[{"name":"id","in":"path","description":"The immutable ID for the SmimeInfo","required":true,"schema":{"type":"string","example":""}},{"name":"sendAsEmail","in":"path","description":"The email address that appears in the \"From\" header for mail sent using this alias","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}"},"summary":"Gets S/MIME config for send-as alias","description":"Gets the specified S/MIME config for the specified send-as alias","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo":{"post":{"tags":["Settings"],"parameters":[{"name":"sendAsEmail","in":"path","description":"The email address that appears in the \"From\" header for mail sent using this alias","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/insert","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo"},"summary":"Upload S/MIME config for send-as alias","description":"Insert (upload) the given S/MIME config for the specified send-as alias","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Settings"],"parameters":[{"name":"sendAsEmail","in":"path","description":"The email address that appears in the \"From\" header for mail sent using this alias","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo"},"summary":"Lists S/MIME configs for send-as alias","description":"Lists S/MIME configs for the specified send-as alias","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault":{"post":{"tags":["Settings"],"parameters":[{"name":"id","in":"path","description":"The immutable ID for the SmimeInfo","required":true,"schema":{"type":"string","example":""}},{"name":"sendAsEmail","in":"path","description":"The email address that appears in the \"From\" header for mail sent using this alias","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/setDefault","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault"},"summary":"Set default S/MIME config for send-as alias","description":"Sets the default S/MIME config for the specified send-as alias","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/threads/{id}":{"delete":{"tags":["Thread"],"parameters":[{"name":"id","in":"path","description":"The ID of the thread to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.threads/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}"},"summary":"Permanently delete specified thread","description":"Immediately and permanently deletes the specified thread","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Thread"],"parameters":[{"name":"id","in":"path","description":"The ID of the thread to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"format","in":"query","description":"The format to return the messages in","schema":{"type":"enum","example":"","items":{"type":"string","enum":["full","metadata","minimal"]}}},{"name":"metadataHeaders","in":"query","description":"When given and format is METADATA, only include headers specified","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.threads/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}"},"summary":"Gets the specified thread","description":"Gets the specified thread","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/threads":{"get":{"tags":["Thread"],"parameters":[{"name":"includeSpamTrash","in":"query","description":"Include messages from SPAM and TRASH in the results","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"labelIds","in":"query","description":"Only return messages with labels that match all of the specified label IDs","schema":{"type":"string","example":""}},{"name":"maxResults","in":"query","description":"Maximum number of threads to return defaults-100 maximum-500","schema":{"type":"integer","example":""}},{"name":"pageToken","in":"query","description":"Page token to retrieve a specific page of results in the list","schema":{"type":"string","example":""}},{"name":"q","in":"query","description":"Only return threads matching the specified query","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.threads/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/threads"},"summary":"Lists the threads in the user's mailbox","description":"Lists the threads in the user's mailbox","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/threads/{id}/modify":{"post":{"tags":["Thread"],"parameters":[{"name":"id","in":"path","description":"The ID of the thread to modify","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.threads/modify","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}/modify"},"summary":"Modifies the labels applied to the thread","description":"Modifies the labels applied to the thread","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"addLabelIds":{"type":"array","description":"A list of IDs of labels to add to this thread","items":{"type":"string"}},"removeLabelIds":{"type":"array","description":"A list of IDs of labels to remove from this thread","items":{"type":"string"}}}},"example":{"addLabelIds":[],"removeLabelIds":[]}}}}}},"/v1/users/{userId}/threads/{id}/trash":{"post":{"tags":["Thread"],"parameters":[{"name":"id","in":"path","description":"The ID of the thread to Trash","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.threads/trash","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}/trash"},"summary":"Moves the specified thread to the trash","description":"Moves the specified thread to the trash","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/threads/{id}/untrash":{"post":{"tags":["Thread"],"parameters":[{"name":"id","in":"path","description":"The ID of the thread to remove from Trash","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.threads/untrash","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}/untrash"},"summary":"Removes the specified thread from the trash","description":"Removes the specified thread from the trash","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/cse/identities":{"post":{"tags":["CSE"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/create","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities"},"summary":"Create CSE identity","description":"Creates and configures a client-side encryption identity that's authorized to send mail from the user account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["CSE"],"parameters":[{"name":"pageToken","in":"query","description":"Pagination token","schema":{"type":"string","example":""}},{"name":"pageSize","in":"query","description":"Number of identities to return","schema":{"type":"integer","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities"},"summary":"List CSE identities","description":"Lists the client-side encrypted identities for an authenticated user","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}":{"delete":{"tags":["CSE"],"parameters":[{"name":"cseEmailAddress","in":"path","description":"The email address to remove from the CSE identity","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/delete","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}"},"summary":"Delete CSE identity","description":"Deletes a client-side encryption identity","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["CSE"],"parameters":[{"name":"cseEmailAddress","in":"path","description":"The email address of the CSE identity to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}"},"summary":"Get CSE identity","description":"Retrieves a client-side encryption identity configuration","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/cse/identities/{emailAddress}":{"patch":{"tags":["CSE"],"parameters":[{"name":"emailAddress","in":"path","description":"The email address of the identity to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/patch","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}"},"summary":"Patch CSE identity","description":"Associates a different key pair with an existing client-side encryption identity","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/cse/keypairs":{"post":{"tags":["CSE"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/create","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs"},"summary":"Create CSE keypair","description":"Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the user","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["CSE"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/list","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs"},"summary":"List CSE keypairs","description":"Lists client-side encryption key pairs for an authenticated user","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/cse/keypairs/{keyPairId}/disable":{"post":{"tags":["CSE"],"parameters":[{"name":"keyPairId","in":"path","description":"The ID of the key pair to disable","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/disable","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable"},"summary":"Disable CSE keypair","description":"Turns off a client-side encryption key pair","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/cse/keypairs/{keyPairId}/enable":{"post":{"tags":["CSE"],"parameters":[{"name":"keyPairId","in":"path","description":"The ID of the key pair to enable","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/enable","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable"},"summary":"Enable CSE keypair","description":"Turns on a client-side encryption key pair that was turned off","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/users/{userId}/settings/cse/keypairs/{keyPairId}":{"get":{"tags":["CSE"],"parameters":[{"name":"keyPairId","in":"path","description":"The ID of the key pair to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/get","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}"},"summary":"Get CSE keypair","description":"Retrieves an existing client-side encryption key pair","security":[{"bearerAuth":[]}]}},"/v1/users/{userId}/settings/cse/keypairs/{keyPairId}/obliterate":{"post":{"tags":["CSE"],"parameters":[{"name":"keyPairId","in":"path","description":"The ID of the key pair to obliterate","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/obliterate","api_endpoint":"https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate"},"summary":"Permanently delete CSE keypair","description":"Deletes a client-side encryption key pair permanently and immediately","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}