| Index: discovery/googleapis/gmail__v1.json
|
| diff --git a/discovery/googleapis/gmail__v1.json b/discovery/googleapis/gmail__v1.json
|
| index ec423402fafc97d8e30125adbe3b46ddb899b5a6..8862e09dfc7fea08fcd92e012338c18dc6ff4636 100644
|
| --- a/discovery/googleapis/gmail__v1.json
|
| +++ b/discovery/googleapis/gmail__v1.json
|
| @@ -22,6 +22,12 @@
|
| },
|
| "https://www.googleapis.com/auth/gmail.send": {
|
| "description": "Send email on your behalf"
|
| + },
|
| + "https://www.googleapis.com/auth/gmail.settings.basic": {
|
| + "description": "Manage your basic mail settings"
|
| + },
|
| + "https://www.googleapis.com/auth/gmail.settings.sharing": {
|
| + "description": "Manage your sensitive mail settings, including who can manage your mail"
|
| }
|
| }
|
| }
|
| @@ -32,7 +38,7 @@
|
| "description": "Access Gmail mailboxes including sending user email.",
|
| "discoveryVersion": "v1",
|
| "documentationLink": "https://developers.google.com/gmail/api/",
|
| - "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/LkMck3hBuxqAAX2hwDLpkoyTBGM\"",
|
| + "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/c9szhoCXYrKaLKrzYGmZhJZBHUc\"",
|
| "icons": {
|
| "x16": "https://www.google.com/images/icons/product/googlemail-16.png",
|
| "x32": "https://www.google.com/images/icons/product/googlemail-32.png"
|
| @@ -1206,317 +1212,1153 @@
|
| }
|
| }
|
| },
|
| - "threads": {
|
| + "settings": {
|
| "methods": {
|
| - "delete": {
|
| - "description": "Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.",
|
| - "httpMethod": "DELETE",
|
| - "id": "gmail.users.threads.delete",
|
| + "getAutoForwarding": {
|
| + "description": "Gets the auto-forwarding setting for the specified account.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.settings.getAutoForwarding",
|
| "parameterOrder": [
|
| - "userId",
|
| - "id"
|
| + "userId"
|
| ],
|
| "parameters": {
|
| - "id": {
|
| - "description": "ID of the Thread to delete.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| "userId": {
|
| "default": "me",
|
| - "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "{userId}/threads/{id}",
|
| + "path": "{userId}/settings/autoForwarding",
|
| + "response": {
|
| + "$ref": "AutoForwarding"
|
| + },
|
| "scopes": [
|
| - "https://mail.google.com/"
|
| + "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"
|
| ]
|
| },
|
| - "get": {
|
| - "description": "Gets the specified thread.",
|
| + "getImap": {
|
| + "description": "Gets IMAP settings.",
|
| "httpMethod": "GET",
|
| - "id": "gmail.users.threads.get",
|
| + "id": "gmail.users.settings.getImap",
|
| "parameterOrder": [
|
| - "userId",
|
| - "id"
|
| + "userId"
|
| ],
|
| "parameters": {
|
| - "format": {
|
| - "default": "full",
|
| - "description": "The format to return the messages in.",
|
| - "enum": [
|
| - "full",
|
| - "metadata",
|
| - "minimal"
|
| - ],
|
| - "enumDescriptions": [
|
| - "",
|
| - "",
|
| - ""
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "The ID of the thread to retrieve.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "metadataHeaders": {
|
| - "description": "When given and format is METADATA, only include headers specified.",
|
| - "location": "query",
|
| - "repeated": true,
|
| - "type": "string"
|
| - },
|
| "userId": {
|
| "default": "me",
|
| - "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "{userId}/threads/{id}",
|
| + "path": "{userId}/settings/imap",
|
| "response": {
|
| - "$ref": "Thread"
|
| + "$ref": "ImapSettings"
|
| },
|
| "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.readonly",
|
| + "https://www.googleapis.com/auth/gmail.settings.basic"
|
| ]
|
| },
|
| - "list": {
|
| - "description": "Lists the threads in the user's mailbox.",
|
| + "getPop": {
|
| + "description": "Gets POP settings.",
|
| "httpMethod": "GET",
|
| - "id": "gmail.users.threads.list",
|
| + "id": "gmail.users.settings.getPop",
|
| "parameterOrder": [
|
| "userId"
|
| ],
|
| "parameters": {
|
| - "includeSpamTrash": {
|
| - "default": "false",
|
| - "description": "Include threads from SPAM and TRASH in the results.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "labelIds": {
|
| - "description": "Only return threads with labels that match all of the specified label IDs.",
|
| - "location": "query",
|
| - "repeated": true,
|
| - "type": "string"
|
| - },
|
| - "maxResults": {
|
| - "default": "100",
|
| - "description": "Maximum number of threads to return.",
|
| - "format": "uint32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "pageToken": {
|
| - "description": "Page token to retrieve a specific page of results in the list.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "q": {
|
| - "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: is:unread\".",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "userId": {
|
| "default": "me",
|
| - "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "{userId}/threads",
|
| + "path": "{userId}/settings/pop",
|
| "response": {
|
| - "$ref": "ListThreadsResponse"
|
| + "$ref": "PopSettings"
|
| },
|
| "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.readonly",
|
| + "https://www.googleapis.com/auth/gmail.settings.basic"
|
| ]
|
| },
|
| - "modify": {
|
| - "description": "Modifies the labels applied to the thread. This applies to all messages in the thread.",
|
| - "httpMethod": "POST",
|
| - "id": "gmail.users.threads.modify",
|
| + "getVacation": {
|
| + "description": "Gets vacation responder settings.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.settings.getVacation",
|
| "parameterOrder": [
|
| - "userId",
|
| - "id"
|
| + "userId"
|
| ],
|
| "parameters": {
|
| - "id": {
|
| - "description": "The ID of the thread to modify.",
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| + }
|
| + },
|
| + "path": "{userId}/settings/vacation",
|
| + "response": {
|
| + "$ref": "VacationSettings"
|
| + },
|
| + "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"
|
| + ]
|
| + },
|
| + "updateAutoForwarding": {
|
| + "description": "Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.",
|
| + "httpMethod": "PUT",
|
| + "id": "gmail.users.settings.updateAutoForwarding",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| "userId": {
|
| "default": "me",
|
| - "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "{userId}/threads/{id}/modify",
|
| + "path": "{userId}/settings/autoForwarding",
|
| "request": {
|
| - "$ref": "ModifyThreadRequest"
|
| + "$ref": "AutoForwarding"
|
| },
|
| "response": {
|
| - "$ref": "Thread"
|
| + "$ref": "AutoForwarding"
|
| },
|
| "scopes": [
|
| - "https://mail.google.com/",
|
| - "https://www.googleapis.com/auth/gmail.modify"
|
| + "https://www.googleapis.com/auth/gmail.settings.sharing"
|
| ]
|
| },
|
| - "trash": {
|
| - "description": "Moves the specified thread to the trash.",
|
| - "httpMethod": "POST",
|
| - "id": "gmail.users.threads.trash",
|
| + "updateImap": {
|
| + "description": "Updates IMAP settings.",
|
| + "httpMethod": "PUT",
|
| + "id": "gmail.users.settings.updateImap",
|
| "parameterOrder": [
|
| - "userId",
|
| - "id"
|
| + "userId"
|
| ],
|
| "parameters": {
|
| - "id": {
|
| - "description": "The ID of the thread to Trash.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| "userId": {
|
| "default": "me",
|
| - "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "{userId}/threads/{id}/trash",
|
| + "path": "{userId}/settings/imap",
|
| + "request": {
|
| + "$ref": "ImapSettings"
|
| + },
|
| "response": {
|
| - "$ref": "Thread"
|
| + "$ref": "ImapSettings"
|
| },
|
| "scopes": [
|
| - "https://mail.google.com/",
|
| - "https://www.googleapis.com/auth/gmail.modify"
|
| + "https://www.googleapis.com/auth/gmail.settings.basic"
|
| ]
|
| },
|
| - "untrash": {
|
| - "description": "Removes the specified thread from the trash.",
|
| - "httpMethod": "POST",
|
| - "id": "gmail.users.threads.untrash",
|
| + "updatePop": {
|
| + "description": "Updates POP settings.",
|
| + "httpMethod": "PUT",
|
| + "id": "gmail.users.settings.updatePop",
|
| "parameterOrder": [
|
| - "userId",
|
| - "id"
|
| + "userId"
|
| ],
|
| "parameters": {
|
| - "id": {
|
| - "description": "The ID of the thread to remove from Trash.",
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| + }
|
| + },
|
| + "path": "{userId}/settings/pop",
|
| + "request": {
|
| + "$ref": "PopSettings"
|
| + },
|
| + "response": {
|
| + "$ref": "PopSettings"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.basic"
|
| + ]
|
| + },
|
| + "updateVacation": {
|
| + "description": "Updates vacation responder settings.",
|
| + "httpMethod": "PUT",
|
| + "id": "gmail.users.settings.updateVacation",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| "userId": {
|
| "default": "me",
|
| - "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "{userId}/threads/{id}/untrash",
|
| + "path": "{userId}/settings/vacation",
|
| + "request": {
|
| + "$ref": "VacationSettings"
|
| + },
|
| "response": {
|
| - "$ref": "Thread"
|
| + "$ref": "VacationSettings"
|
| },
|
| "scopes": [
|
| - "https://mail.google.com/",
|
| - "https://www.googleapis.com/auth/gmail.modify"
|
| + "https://www.googleapis.com/auth/gmail.settings.basic"
|
| ]
|
| }
|
| - }
|
| - }
|
| - }
|
| - }
|
| - },
|
| - "revision": "20160621",
|
| - "rootUrl": "https://www.googleapis.com/",
|
| - "schemas": {
|
| - "BatchDeleteMessagesRequest": {
|
| - "id": "BatchDeleteMessagesRequest",
|
| - "properties": {
|
| - "ids": {
|
| - "description": "The IDs of the messages to delete.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Draft": {
|
| - "description": "A draft email in the user's mailbox.",
|
| - "id": "Draft",
|
| - "properties": {
|
| - "id": {
|
| - "annotations": {
|
| - "required": [
|
| - "gmail.users.drafts.send"
|
| - ]
|
| - },
|
| - "description": "The immutable ID of the draft.",
|
| - "type": "string"
|
| - },
|
| - "message": {
|
| - "$ref": "Message",
|
| - "description": "The message content of the draft."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "History": {
|
| - "description": "A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.",
|
| - "id": "History",
|
| - "properties": {
|
| - "id": {
|
| - "description": "The mailbox sequence ID.",
|
| - "format": "uint64",
|
| - "type": "string"
|
| - },
|
| - "labelsAdded": {
|
| - "description": "Labels added to messages in this history record.",
|
| - "items": {
|
| - "$ref": "HistoryLabelAdded"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "labelsRemoved": {
|
| - "description": "Labels removed from messages in this history record.",
|
| - "items": {
|
| - "$ref": "HistoryLabelRemoved"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "messages": {
|
| - "description": "List of messages changed in this history record. The fields for specific change types, such as messagesAdded may duplicate messages in this field. We recommend using the specific change-type fields instead of this.",
|
| - "items": {
|
| - "$ref": "Message"
|
| },
|
| - "type": "array"
|
| - },
|
| - "messagesAdded": {
|
| + "resources": {
|
| + "filters": {
|
| + "methods": {
|
| + "create": {
|
| + "description": "Creates a filter.",
|
| + "httpMethod": "POST",
|
| + "id": "gmail.users.settings.filters.create",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/filters",
|
| + "request": {
|
| + "$ref": "Filter"
|
| + },
|
| + "response": {
|
| + "$ref": "Filter"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.basic"
|
| + ]
|
| + },
|
| + "delete": {
|
| + "description": "Deletes a filter.",
|
| + "httpMethod": "DELETE",
|
| + "id": "gmail.users.settings.filters.delete",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "The ID of the filter to be deleted.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/filters/{id}",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.basic"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Gets a filter.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.settings.filters.get",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "The ID of the filter to be fetched.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/filters/{id}",
|
| + "response": {
|
| + "$ref": "Filter"
|
| + },
|
| + "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"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Lists the message filters of a Gmail user.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.settings.filters.list",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/filters",
|
| + "response": {
|
| + "$ref": "ListFiltersResponse"
|
| + },
|
| + "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"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "forwardingAddresses": {
|
| + "methods": {
|
| + "create": {
|
| + "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.",
|
| + "httpMethod": "POST",
|
| + "id": "gmail.users.settings.forwardingAddresses.create",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/forwardingAddresses",
|
| + "request": {
|
| + "$ref": "ForwardingAddress"
|
| + },
|
| + "response": {
|
| + "$ref": "ForwardingAddress"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.sharing"
|
| + ]
|
| + },
|
| + "delete": {
|
| + "description": "Deletes the specified forwarding address and revokes any verification that may have been required.",
|
| + "httpMethod": "DELETE",
|
| + "id": "gmail.users.settings.forwardingAddresses.delete",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "forwardingEmail"
|
| + ],
|
| + "parameters": {
|
| + "forwardingEmail": {
|
| + "description": "The forwarding address to be deleted.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/forwardingAddresses/{forwardingEmail}",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.sharing"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Gets the specified forwarding address.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.settings.forwardingAddresses.get",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "forwardingEmail"
|
| + ],
|
| + "parameters": {
|
| + "forwardingEmail": {
|
| + "description": "The forwarding address to be retrieved.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/forwardingAddresses/{forwardingEmail}",
|
| + "response": {
|
| + "$ref": "ForwardingAddress"
|
| + },
|
| + "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"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Lists the forwarding addresses for the specified account.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.settings.forwardingAddresses.list",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/forwardingAddresses",
|
| + "response": {
|
| + "$ref": "ListForwardingAddressesResponse"
|
| + },
|
| + "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"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "sendAs": {
|
| + "methods": {
|
| + "create": {
|
| + "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 verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.",
|
| + "httpMethod": "POST",
|
| + "id": "gmail.users.settings.sendAs.create",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/sendAs",
|
| + "request": {
|
| + "$ref": "SendAs"
|
| + },
|
| + "response": {
|
| + "$ref": "SendAs"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.sharing"
|
| + ]
|
| + },
|
| + "delete": {
|
| + "description": "Deletes the specified send-as alias. Revokes any verification that may have been required for using it.",
|
| + "httpMethod": "DELETE",
|
| + "id": "gmail.users.settings.sendAs.delete",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "sendAsEmail"
|
| + ],
|
| + "parameters": {
|
| + "sendAsEmail": {
|
| + "description": "The send-as alias to be deleted.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/sendAs/{sendAsEmail}",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.sharing"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.settings.sendAs.get",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "sendAsEmail"
|
| + ],
|
| + "parameters": {
|
| + "sendAsEmail": {
|
| + "description": "The send-as alias to be retrieved.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/sendAs/{sendAsEmail}",
|
| + "response": {
|
| + "$ref": "SendAs"
|
| + },
|
| + "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"
|
| + ]
|
| + },
|
| + "list": {
|
| + "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.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.settings.sendAs.list",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/sendAs",
|
| + "response": {
|
| + "$ref": "ListSendAsResponse"
|
| + },
|
| + "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"
|
| + ]
|
| + },
|
| + "patch": {
|
| + "description": "Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method supports patch semantics.",
|
| + "httpMethod": "PATCH",
|
| + "id": "gmail.users.settings.sendAs.patch",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "sendAsEmail"
|
| + ],
|
| + "parameters": {
|
| + "sendAsEmail": {
|
| + "description": "The send-as alias to be updated.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/sendAs/{sendAsEmail}",
|
| + "request": {
|
| + "$ref": "SendAs"
|
| + },
|
| + "response": {
|
| + "$ref": "SendAs"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.basic",
|
| + "https://www.googleapis.com/auth/gmail.settings.sharing"
|
| + ]
|
| + },
|
| + "update": {
|
| + "description": "Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.",
|
| + "httpMethod": "PUT",
|
| + "id": "gmail.users.settings.sendAs.update",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "sendAsEmail"
|
| + ],
|
| + "parameters": {
|
| + "sendAsEmail": {
|
| + "description": "The send-as alias to be updated.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/sendAs/{sendAsEmail}",
|
| + "request": {
|
| + "$ref": "SendAs"
|
| + },
|
| + "response": {
|
| + "$ref": "SendAs"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.basic",
|
| + "https://www.googleapis.com/auth/gmail.settings.sharing"
|
| + ]
|
| + },
|
| + "verify": {
|
| + "description": "Sends a verification email to the specified send-as alias address. The verification status must be pending.",
|
| + "httpMethod": "POST",
|
| + "id": "gmail.users.settings.sendAs.verify",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "sendAsEmail"
|
| + ],
|
| + "parameters": {
|
| + "sendAsEmail": {
|
| + "description": "The send-as alias to be verified.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "User's email address. The special value \"me\" can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/settings/sendAs/{sendAsEmail}/verify",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/gmail.settings.sharing"
|
| + ]
|
| + }
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "threads": {
|
| + "methods": {
|
| + "delete": {
|
| + "description": "Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.",
|
| + "httpMethod": "DELETE",
|
| + "id": "gmail.users.threads.delete",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "ID of the Thread to delete.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/threads/{id}",
|
| + "scopes": [
|
| + "https://mail.google.com/"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Gets the specified thread.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.threads.get",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "format": {
|
| + "default": "full",
|
| + "description": "The format to return the messages in.",
|
| + "enum": [
|
| + "full",
|
| + "metadata",
|
| + "minimal"
|
| + ],
|
| + "enumDescriptions": [
|
| + "",
|
| + "",
|
| + ""
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "The ID of the thread to retrieve.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "metadataHeaders": {
|
| + "description": "When given and format is METADATA, only include headers specified.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/threads/{id}",
|
| + "response": {
|
| + "$ref": "Thread"
|
| + },
|
| + "scopes": [
|
| + "https://mail.google.com/",
|
| + "https://www.googleapis.com/auth/gmail.modify",
|
| + "https://www.googleapis.com/auth/gmail.readonly"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Lists the threads in the user's mailbox.",
|
| + "httpMethod": "GET",
|
| + "id": "gmail.users.threads.list",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "includeSpamTrash": {
|
| + "default": "false",
|
| + "description": "Include threads from SPAM and TRASH in the results.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "labelIds": {
|
| + "description": "Only return threads with labels that match all of the specified label IDs.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "maxResults": {
|
| + "default": "100",
|
| + "description": "Maximum number of threads to return.",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "pageToken": {
|
| + "description": "Page token to retrieve a specific page of results in the list.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "q": {
|
| + "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: is:unread\".",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/threads",
|
| + "response": {
|
| + "$ref": "ListThreadsResponse"
|
| + },
|
| + "scopes": [
|
| + "https://mail.google.com/",
|
| + "https://www.googleapis.com/auth/gmail.modify",
|
| + "https://www.googleapis.com/auth/gmail.readonly"
|
| + ]
|
| + },
|
| + "modify": {
|
| + "description": "Modifies the labels applied to the thread. This applies to all messages in the thread.",
|
| + "httpMethod": "POST",
|
| + "id": "gmail.users.threads.modify",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "The ID of the thread to modify.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/threads/{id}/modify",
|
| + "request": {
|
| + "$ref": "ModifyThreadRequest"
|
| + },
|
| + "response": {
|
| + "$ref": "Thread"
|
| + },
|
| + "scopes": [
|
| + "https://mail.google.com/",
|
| + "https://www.googleapis.com/auth/gmail.modify"
|
| + ]
|
| + },
|
| + "trash": {
|
| + "description": "Moves the specified thread to the trash.",
|
| + "httpMethod": "POST",
|
| + "id": "gmail.users.threads.trash",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "The ID of the thread to Trash.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/threads/{id}/trash",
|
| + "response": {
|
| + "$ref": "Thread"
|
| + },
|
| + "scopes": [
|
| + "https://mail.google.com/",
|
| + "https://www.googleapis.com/auth/gmail.modify"
|
| + ]
|
| + },
|
| + "untrash": {
|
| + "description": "Removes the specified thread from the trash.",
|
| + "httpMethod": "POST",
|
| + "id": "gmail.users.threads.untrash",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "The ID of the thread to remove from Trash.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "default": "me",
|
| + "description": "The user's email address. The special value me can be used to indicate the authenticated user.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "{userId}/threads/{id}/untrash",
|
| + "response": {
|
| + "$ref": "Thread"
|
| + },
|
| + "scopes": [
|
| + "https://mail.google.com/",
|
| + "https://www.googleapis.com/auth/gmail.modify"
|
| + ]
|
| + }
|
| + }
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "revision": "20160711",
|
| + "rootUrl": "https://www.googleapis.com/",
|
| + "schemas": {
|
| + "AutoForwarding": {
|
| + "description": "Auto-forwarding settings for an account.",
|
| + "id": "AutoForwarding",
|
| + "properties": {
|
| + "disposition": {
|
| + "description": "The state that a message should be left in after it has been forwarded.",
|
| + "enum": [
|
| + "archive",
|
| + "dispositionUnspecified",
|
| + "leaveInInbox",
|
| + "markRead",
|
| + "trash"
|
| + ],
|
| + "enumDescriptions": [
|
| + "",
|
| + "",
|
| + "",
|
| + "",
|
| + ""
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "emailAddress": {
|
| + "description": "Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.",
|
| + "type": "string"
|
| + },
|
| + "enabled": {
|
| + "description": "Whether all incoming mail is automatically forwarded to another address.",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "BatchDeleteMessagesRequest": {
|
| + "id": "BatchDeleteMessagesRequest",
|
| + "properties": {
|
| + "ids": {
|
| + "description": "The IDs of the messages to delete.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Draft": {
|
| + "description": "A draft email in the user's mailbox.",
|
| + "id": "Draft",
|
| + "properties": {
|
| + "id": {
|
| + "annotations": {
|
| + "required": [
|
| + "gmail.users.drafts.send"
|
| + ]
|
| + },
|
| + "description": "The immutable ID of the draft.",
|
| + "type": "string"
|
| + },
|
| + "message": {
|
| + "$ref": "Message",
|
| + "description": "The message content of the draft."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Filter": {
|
| + "description": "Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.",
|
| + "id": "Filter",
|
| + "properties": {
|
| + "action": {
|
| + "$ref": "FilterAction",
|
| + "description": "Action that the filter performs."
|
| + },
|
| + "criteria": {
|
| + "$ref": "FilterCriteria",
|
| + "description": "Matching criteria for the filter."
|
| + },
|
| + "id": {
|
| + "description": "The server assigned ID of the filter.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "FilterAction": {
|
| + "description": "A set of actions to perform on a message.",
|
| + "id": "FilterAction",
|
| + "properties": {
|
| + "addLabelIds": {
|
| + "description": "List of labels to add to the message.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "forward": {
|
| + "description": "Email address that the message should be forwarded to.",
|
| + "type": "string"
|
| + },
|
| + "removeLabelIds": {
|
| + "description": "List of labels to remove from the message.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "FilterCriteria": {
|
| + "description": "Message matching criteria.",
|
| + "id": "FilterCriteria",
|
| + "properties": {
|
| + "excludeChats": {
|
| + "description": "Whether the response should exclude chats.",
|
| + "type": "boolean"
|
| + },
|
| + "from": {
|
| + "description": "The sender's display name or email address.",
|
| + "type": "string"
|
| + },
|
| + "hasAttachment": {
|
| + "description": "Whether the message has any attachment.",
|
| + "type": "boolean"
|
| + },
|
| + "negatedQuery": {
|
| + "description": "Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, \"from:someuser@example.com rfc822msgid: is:unread\".",
|
| + "type": "string"
|
| + },
|
| + "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: is:unread\".",
|
| + "type": "string"
|
| + },
|
| + "size": {
|
| + "description": "The size of the entire RFC822 message in bytes, including all headers and attachments.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "sizeComparison": {
|
| + "description": "How the message size in bytes should be in relation to the size field.",
|
| + "enum": [
|
| + "larger",
|
| + "smaller",
|
| + "unspecified"
|
| + ],
|
| + "enumDescriptions": [
|
| + "",
|
| + "",
|
| + ""
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "subject": {
|
| + "description": "Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.",
|
| + "type": "string"
|
| + },
|
| + "to": {
|
| + "description": "The recipient's display name or email address. Includes recipients in the \"to\", \"cc\", and \"bcc\" header fields. You can use simply the local part of the email address. For example, \"example\" and \"example@\" both match \"example@gmail.com\". This field is case-insensitive.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ForwardingAddress": {
|
| + "description": "Settings for a forwarding address.",
|
| + "id": "ForwardingAddress",
|
| + "properties": {
|
| + "forwardingEmail": {
|
| + "description": "An email address to which messages can be forwarded.",
|
| + "type": "string"
|
| + },
|
| + "verificationStatus": {
|
| + "description": "Indicates whether this address has been verified and is usable for forwarding. Read-only.",
|
| + "enum": [
|
| + "accepted",
|
| + "pending",
|
| + "verificationStatusUnspecified"
|
| + ],
|
| + "enumDescriptions": [
|
| + "",
|
| + "",
|
| + ""
|
| + ],
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "History": {
|
| + "description": "A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.",
|
| + "id": "History",
|
| + "properties": {
|
| + "id": {
|
| + "description": "The mailbox sequence ID.",
|
| + "format": "uint64",
|
| + "type": "string"
|
| + },
|
| + "labelsAdded": {
|
| + "description": "Labels added to messages in this history record.",
|
| + "items": {
|
| + "$ref": "HistoryLabelAdded"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "labelsRemoved": {
|
| + "description": "Labels removed from messages in this history record.",
|
| + "items": {
|
| + "$ref": "HistoryLabelRemoved"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "messages": {
|
| + "description": "List of messages changed in this history record. The fields for specific change types, such as messagesAdded may duplicate messages in this field. We recommend using the specific change-type fields instead of this.",
|
| + "items": {
|
| + "$ref": "Message"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "messagesAdded": {
|
| "description": "Messages added to the mailbox in this history record.",
|
| "items": {
|
| "$ref": "HistoryMessageAdded"
|
| @@ -1583,6 +2425,42 @@
|
| },
|
| "type": "object"
|
| },
|
| + "ImapSettings": {
|
| + "description": "IMAP settings for an account.",
|
| + "id": "ImapSettings",
|
| + "properties": {
|
| + "autoExpunge": {
|
| + "description": "If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.",
|
| + "type": "boolean"
|
| + },
|
| + "enabled": {
|
| + "description": "Whether IMAP is enabled for the account.",
|
| + "type": "boolean"
|
| + },
|
| + "expungeBehavior": {
|
| + "description": "The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.",
|
| + "enum": [
|
| + "archive",
|
| + "deleteForever",
|
| + "expungeBehaviorUnspecified",
|
| + "trash"
|
| + ],
|
| + "enumDescriptions": [
|
| + "",
|
| + "",
|
| + "",
|
| + ""
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "maxFolderSize": {
|
| + "description": "An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "Label": {
|
| "description": "Labels are used to categorize messages and threads within the user's mailbox.",
|
| "id": "Label",
|
| @@ -1701,6 +2579,34 @@
|
| },
|
| "type": "object"
|
| },
|
| + "ListFiltersResponse": {
|
| + "description": "Response for the ListFilters method.",
|
| + "id": "ListFiltersResponse",
|
| + "properties": {
|
| + "filter": {
|
| + "description": "List of a user's filters.",
|
| + "items": {
|
| + "$ref": "Filter"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListForwardingAddressesResponse": {
|
| + "description": "Response for the ListForwardingAddresses method.",
|
| + "id": "ListForwardingAddressesResponse",
|
| + "properties": {
|
| + "forwardingAddresses": {
|
| + "description": "List of addresses that may be used for forwarding.",
|
| + "items": {
|
| + "$ref": "ForwardingAddress"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "ListHistoryResponse": {
|
| "id": "ListHistoryResponse",
|
| "properties": {
|
| @@ -1758,6 +2664,20 @@
|
| },
|
| "type": "object"
|
| },
|
| + "ListSendAsResponse": {
|
| + "description": "Response for the ListSendAs method.",
|
| + "id": "ListSendAsResponse",
|
| + "properties": {
|
| + "sendAs": {
|
| + "description": "List of send-as aliases.",
|
| + "items": {
|
| + "$ref": "SendAs"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "ListThreadsResponse": {
|
| "id": "ListThreadsResponse",
|
| "properties": {
|
| @@ -1950,6 +2870,47 @@
|
| },
|
| "type": "object"
|
| },
|
| + "PopSettings": {
|
| + "description": "POP settings for an account.",
|
| + "id": "PopSettings",
|
| + "properties": {
|
| + "accessWindow": {
|
| + "description": "The range of messages which are accessible via POP.",
|
| + "enum": [
|
| + "accessWindowUnspecified",
|
| + "allMail",
|
| + "disabled",
|
| + "fromNowOn"
|
| + ],
|
| + "enumDescriptions": [
|
| + "",
|
| + "",
|
| + "",
|
| + ""
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "disposition": {
|
| + "description": "The action that will be executed on a message after it has been fetched via POP.",
|
| + "enum": [
|
| + "archive",
|
| + "dispositionUnspecified",
|
| + "leaveInInbox",
|
| + "markRead",
|
| + "trash"
|
| + ],
|
| + "enumDescriptions": [
|
| + "",
|
| + "",
|
| + "",
|
| + "",
|
| + ""
|
| + ],
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "Profile": {
|
| "description": "Profile for a Gmail user.",
|
| "id": "Profile",
|
| @@ -1976,6 +2937,99 @@
|
| },
|
| "type": "object"
|
| },
|
| + "SendAs": {
|
| + "description": "Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom \"from\" address. Send-as aliases correspond to the \"Send Mail As\" feature in the web interface. See for more details.",
|
| + "id": "SendAs",
|
| + "properties": {
|
| + "displayName": {
|
| + "description": "A name that appears in the \"From:\" header for mail sent using this alias. For custom \"from\" addresses, when this is empty, Gmail will populate the \"From:\" header with the name that is used for the primary address associated with the account.",
|
| + "type": "string"
|
| + },
|
| + "isDefault": {
|
| + "description": "Whether this address is selected as the default \"From:\" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.",
|
| + "type": "boolean"
|
| + },
|
| + "isPrimary": {
|
| + "description": "Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.",
|
| + "type": "boolean"
|
| + },
|
| + "replyToAddress": {
|
| + "description": "An optional email address that is included in a \"Reply-To:\" header for mail sent using this alias. If this is empty, Gmail will not generate a \"Reply-To:\" header.",
|
| + "type": "string"
|
| + },
|
| + "sendAsEmail": {
|
| + "description": "The email address that appears in the \"From:\" header for mail sent using this alias. This is read-only for all operations except create.",
|
| + "type": "string"
|
| + },
|
| + "signature": {
|
| + "description": "An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.",
|
| + "type": "string"
|
| + },
|
| + "smtpMsa": {
|
| + "$ref": "SmtpMsa",
|
| + "description": "An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom \"from\" aliases."
|
| + },
|
| + "treatAsAlias": {
|
| + "description": "Whether Gmail should treat this address as an alias for the user's primary email address. See for more details. This setting only applies to custom \"from\" aliases.",
|
| + "type": "boolean"
|
| + },
|
| + "verificationStatus": {
|
| + "description": "Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom \"from\" aliases.",
|
| + "enum": [
|
| + "accepted",
|
| + "pending",
|
| + "verificationStatusUnspecified"
|
| + ],
|
| + "enumDescriptions": [
|
| + "",
|
| + "",
|
| + ""
|
| + ],
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SmtpMsa": {
|
| + "description": "Configuration for communication with an SMTP service.",
|
| + "id": "SmtpMsa",
|
| + "properties": {
|
| + "host": {
|
| + "description": "The hostname of the SMTP service. Required.",
|
| + "type": "string"
|
| + },
|
| + "password": {
|
| + "description": "The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.",
|
| + "type": "string"
|
| + },
|
| + "port": {
|
| + "description": "The port of the SMTP service. Required.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "securityMode": {
|
| + "description": "The protocol that will be used to secure communication with the SMTP service. Required.",
|
| + "enum": [
|
| + "none",
|
| + "securityModeUnspecified",
|
| + "ssl",
|
| + "starttls"
|
| + ],
|
| + "enumDescriptions": [
|
| + "",
|
| + "",
|
| + "",
|
| + ""
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "username": {
|
| + "description": "The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "Thread": {
|
| "description": "A collection of messages representing a conversation.",
|
| "id": "Thread",
|
| @@ -2003,6 +3057,47 @@
|
| },
|
| "type": "object"
|
| },
|
| + "VacationSettings": {
|
| + "description": "Vacation auto-reply settings for an account. These settings correspond to the \"Vacation responder\" feature in the web interface. See for more details.",
|
| + "id": "VacationSettings",
|
| + "properties": {
|
| + "enableAutoReply": {
|
| + "description": "Flag that controls whether Gmail automatically replies to messages.",
|
| + "type": "boolean"
|
| + },
|
| + "endTime": {
|
| + "description": "An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "responseBodyHtml": {
|
| + "description": "Response body in HTML format. Gmail will sanitize the HTML before storing it.",
|
| + "type": "string"
|
| + },
|
| + "responseBodyPlainText": {
|
| + "description": "Response body in plain text format.",
|
| + "type": "string"
|
| + },
|
| + "responseSubject": {
|
| + "description": "Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.",
|
| + "type": "string"
|
| + },
|
| + "restrictToContacts": {
|
| + "description": "Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.",
|
| + "type": "boolean"
|
| + },
|
| + "restrictToDomain": {
|
| + "description": "Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users.",
|
| + "type": "boolean"
|
| + },
|
| + "startTime": {
|
| + "description": "An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "WatchRequest": {
|
| "description": "Set up or update a new push notification watch on this user's mailbox.",
|
| "id": "WatchRequest",
|
|
|