From b6d30245316aae9de8b208e9afd7ebfc812ea36e Mon Sep 17 00:00:00 2001 From: yoshi-automation Date: Thu, 11 Jun 2020 04:36:18 -0700 Subject: [PATCH] feat(gmail)!: update the API BREAKING CHANGE: This release has breaking changes. #### gmail:v1 The following keys were deleted: - etag - parameters.userIp.description - parameters.userIp.location - parameters.userIp.type - resources.users.resources.drafts.methods.get.parameters.format.enumDescriptions - resources.users.resources.history.methods.list.parameters.historyTypes.enumDescriptions - resources.users.resources.messages.methods.get.parameters.format.enumDescriptions - resources.users.resources.messages.methods.import.parameters.internalDateSource.enumDescriptions - resources.users.resources.messages.methods.insert.parameters.internalDateSource.enumDescriptions - resources.users.resources.threads.methods.get.parameters.format.enumDescriptions The following keys were added: - canonicalName - mtlsRootUrl - parameters.$.xgafv.description - parameters.$.xgafv.enum - parameters.$.xgafv.enumDescriptions - parameters.$.xgafv.location - parameters.$.xgafv.type - parameters.access_token.description - parameters.access_token.location - parameters.access_token.type - parameters.callback.description - parameters.callback.location - parameters.callback.type - parameters.uploadType.description - parameters.uploadType.location - parameters.uploadType.type - parameters.upload_protocol.description - parameters.upload_protocol.location - parameters.upload_protocol.type - resources.users.methods.getProfile.flatPath - resources.users.methods.stop.flatPath - resources.users.methods.watch.flatPath - resources.users.resources.drafts.methods.create.flatPath - resources.users.resources.drafts.methods.delete.flatPath - resources.users.resources.drafts.methods.get.flatPath - resources.users.resources.drafts.methods.list.flatPath - resources.users.resources.drafts.methods.send.flatPath - resources.users.resources.drafts.methods.update.flatPath - resources.users.resources.history.methods.list.flatPath - resources.users.resources.labels.methods.create.flatPath - resources.users.resources.labels.methods.delete.flatPath - resources.users.resources.labels.methods.get.flatPath - resources.users.resources.labels.methods.list.flatPath - resources.users.resources.labels.methods.patch.flatPath - resources.users.resources.labels.methods.update.flatPath - resources.users.resources.messages.methods.batchDelete.flatPath - resources.users.resources.messages.methods.batchModify.flatPath - resources.users.resources.messages.methods.delete.flatPath - resources.users.resources.messages.methods.get.flatPath - resources.users.resources.messages.methods.import.flatPath - resources.users.resources.messages.methods.insert.flatPath - resources.users.resources.messages.methods.list.flatPath - resources.users.resources.messages.methods.modify.flatPath - resources.users.resources.messages.methods.send.flatPath - resources.users.resources.messages.methods.trash.flatPath - resources.users.resources.messages.methods.untrash.flatPath - resources.users.resources.messages.resources.attachments.methods.get.flatPath - resources.users.resources.settings.methods.getAutoForwarding.flatPath - resources.users.resources.settings.methods.getImap.flatPath - resources.users.resources.settings.methods.getLanguage.flatPath - resources.users.resources.settings.methods.getPop.flatPath - resources.users.resources.settings.methods.getVacation.flatPath - resources.users.resources.settings.methods.updateAutoForwarding.flatPath - resources.users.resources.settings.methods.updateImap.flatPath - resources.users.resources.settings.methods.updateLanguage.flatPath - resources.users.resources.settings.methods.updatePop.flatPath - resources.users.resources.settings.methods.updateVacation.flatPath - resources.users.resources.settings.resources.delegates.methods.create.flatPath - resources.users.resources.settings.resources.delegates.methods.delete.flatPath - resources.users.resources.settings.resources.delegates.methods.get.flatPath - resources.users.resources.settings.resources.delegates.methods.list.flatPath - resources.users.resources.settings.resources.filters.methods.create.flatPath - resources.users.resources.settings.resources.filters.methods.delete.flatPath - resources.users.resources.settings.resources.filters.methods.get.flatPath - resources.users.resources.settings.resources.filters.methods.list.flatPath - resources.users.resources.settings.resources.forwardingAddresses.methods.create.flatPath - resources.users.resources.settings.resources.forwardingAddresses.methods.delete.flatPath - resources.users.resources.settings.resources.forwardingAddresses.methods.get.flatPath - resources.users.resources.settings.resources.forwardingAddresses.methods.list.flatPath - resources.users.resources.settings.resources.sendAs.methods.create.flatPath - resources.users.resources.settings.resources.sendAs.methods.delete.flatPath - resources.users.resources.settings.resources.sendAs.methods.get.flatPath - resources.users.resources.settings.resources.sendAs.methods.list.flatPath - resources.users.resources.settings.resources.sendAs.methods.patch.flatPath - resources.users.resources.settings.resources.sendAs.methods.update.flatPath - resources.users.resources.settings.resources.sendAs.methods.verify.flatPath - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.delete.flatPath - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.get.flatPath - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.insert.flatPath - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.list.flatPath - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.setDefault.flatPath - resources.users.resources.threads.methods.delete.flatPath - resources.users.resources.threads.methods.get.flatPath - resources.users.resources.threads.methods.list.flatPath - resources.users.resources.threads.methods.modify.flatPath - resources.users.resources.threads.methods.trash.flatPath - resources.users.resources.threads.methods.untrash.flatPath The following keys were changed: - baseUrl - description - icons.x16 - icons.x32 - parameters.alt.description - parameters.alt.enum - parameters.alt.enumDescriptions - parameters.quotaUser.description - resources.users.methods.getProfile.parameters.userId.description - resources.users.methods.getProfile.path - resources.users.methods.stop.parameters.userId.description - resources.users.methods.stop.path - resources.users.methods.watch.parameters.userId.description - resources.users.methods.watch.path - resources.users.resources.drafts.methods.create.description - resources.users.resources.drafts.methods.create.mediaUpload.accept - resources.users.resources.drafts.methods.create.mediaUpload.maxSize - resources.users.resources.drafts.methods.create.parameters.userId.description - resources.users.resources.drafts.methods.create.path - resources.users.resources.drafts.methods.delete.description - resources.users.resources.drafts.methods.delete.parameters.userId.description - resources.users.resources.drafts.methods.delete.path - resources.users.resources.drafts.methods.delete.scopes - resources.users.resources.drafts.methods.get.parameters.format.enum - resources.users.resources.drafts.methods.get.parameters.userId.description - resources.users.resources.drafts.methods.get.path - resources.users.resources.drafts.methods.list.parameters.includeSpamTrash.description - resources.users.resources.drafts.methods.list.parameters.q.description - resources.users.resources.drafts.methods.list.parameters.userId.description - resources.users.resources.drafts.methods.list.path - resources.users.resources.drafts.methods.send.description - resources.users.resources.drafts.methods.send.mediaUpload.accept - resources.users.resources.drafts.methods.send.mediaUpload.maxSize - resources.users.resources.drafts.methods.send.parameters.userId.description - resources.users.resources.drafts.methods.send.path - resources.users.resources.drafts.methods.send.scopes - resources.users.resources.drafts.methods.update.mediaUpload.accept - resources.users.resources.drafts.methods.update.mediaUpload.maxSize - resources.users.resources.drafts.methods.update.parameters.userId.description - resources.users.resources.drafts.methods.update.path - resources.users.resources.drafts.methods.update.scopes - resources.users.resources.history.methods.list.description - resources.users.resources.history.methods.list.parameters.historyTypes.enum - resources.users.resources.history.methods.list.parameters.startHistoryId.description - resources.users.resources.history.methods.list.parameters.userId.description - resources.users.resources.history.methods.list.path - resources.users.resources.labels.methods.create.parameters.userId.description - resources.users.resources.labels.methods.create.path - resources.users.resources.labels.methods.delete.description - resources.users.resources.labels.methods.delete.parameters.userId.description - resources.users.resources.labels.methods.delete.path - resources.users.resources.labels.methods.get.parameters.userId.description - resources.users.resources.labels.methods.get.path - resources.users.resources.labels.methods.list.parameters.userId.description - resources.users.resources.labels.methods.list.path - resources.users.resources.labels.methods.patch.description - resources.users.resources.labels.methods.patch.parameters.userId.description - resources.users.resources.labels.methods.patch.path - resources.users.resources.labels.methods.update.parameters.userId.description - resources.users.resources.labels.methods.update.path - resources.users.resources.messages.methods.batchDelete.description - resources.users.resources.messages.methods.batchDelete.parameters.userId.description - resources.users.resources.messages.methods.batchDelete.path - resources.users.resources.messages.methods.batchModify.parameters.userId.description - resources.users.resources.messages.methods.batchModify.path - resources.users.resources.messages.methods.delete.description - resources.users.resources.messages.methods.delete.parameters.userId.description - resources.users.resources.messages.methods.delete.path - resources.users.resources.messages.methods.get.parameters.format.enum - resources.users.resources.messages.methods.get.parameters.userId.description - resources.users.resources.messages.methods.get.path - resources.users.resources.messages.methods.import.description - resources.users.resources.messages.methods.import.mediaUpload.accept - resources.users.resources.messages.methods.import.mediaUpload.maxSize - resources.users.resources.messages.methods.import.parameters.deleted.description - resources.users.resources.messages.methods.import.parameters.internalDateSource.enum - resources.users.resources.messages.methods.import.parameters.neverMarkSpam.description - resources.users.resources.messages.methods.import.parameters.processForCalendar.description - resources.users.resources.messages.methods.import.parameters.userId.description - resources.users.resources.messages.methods.import.path - resources.users.resources.messages.methods.insert.description - resources.users.resources.messages.methods.insert.mediaUpload.accept - resources.users.resources.messages.methods.insert.mediaUpload.maxSize - resources.users.resources.messages.methods.insert.parameters.deleted.description - resources.users.resources.messages.methods.insert.parameters.internalDateSource.enum - resources.users.resources.messages.methods.insert.parameters.userId.description - resources.users.resources.messages.methods.insert.path - resources.users.resources.messages.methods.list.parameters.includeSpamTrash.description - resources.users.resources.messages.methods.list.parameters.q.description - resources.users.resources.messages.methods.list.parameters.userId.description - resources.users.resources.messages.methods.list.path - resources.users.resources.messages.methods.modify.parameters.userId.description - resources.users.resources.messages.methods.modify.path - resources.users.resources.messages.methods.send.description - resources.users.resources.messages.methods.send.mediaUpload.accept - resources.users.resources.messages.methods.send.mediaUpload.maxSize - resources.users.resources.messages.methods.send.parameters.userId.description - resources.users.resources.messages.methods.send.path - resources.users.resources.messages.methods.trash.parameters.userId.description - resources.users.resources.messages.methods.trash.path - resources.users.resources.messages.methods.untrash.parameters.userId.description - resources.users.resources.messages.methods.untrash.path - resources.users.resources.messages.resources.attachments.methods.get.parameters.userId.description - resources.users.resources.messages.resources.attachments.methods.get.path - resources.users.resources.settings.methods.getAutoForwarding.parameters.userId.description - resources.users.resources.settings.methods.getAutoForwarding.path - resources.users.resources.settings.methods.getImap.parameters.userId.description - resources.users.resources.settings.methods.getImap.path - resources.users.resources.settings.methods.getLanguage.parameters.userId.description - resources.users.resources.settings.methods.getLanguage.path - resources.users.resources.settings.methods.getPop.parameters.userId.description - resources.users.resources.settings.methods.getPop.path - resources.users.resources.settings.methods.getVacation.parameters.userId.description - resources.users.resources.settings.methods.getVacation.path - resources.users.resources.settings.methods.updateAutoForwarding.description - resources.users.resources.settings.methods.updateAutoForwarding.parameters.userId.description - resources.users.resources.settings.methods.updateAutoForwarding.path - resources.users.resources.settings.methods.updateImap.parameters.userId.description - resources.users.resources.settings.methods.updateImap.path - resources.users.resources.settings.methods.updateLanguage.description - resources.users.resources.settings.methods.updateLanguage.parameters.userId.description - resources.users.resources.settings.methods.updateLanguage.path - resources.users.resources.settings.methods.updatePop.parameters.userId.description - resources.users.resources.settings.methods.updatePop.path - resources.users.resources.settings.methods.updateVacation.parameters.userId.description - resources.users.resources.settings.methods.updateVacation.path - resources.users.resources.settings.resources.delegates.methods.create.description - resources.users.resources.settings.resources.delegates.methods.create.parameters.userId.description - resources.users.resources.settings.resources.delegates.methods.create.path - resources.users.resources.settings.resources.delegates.methods.delete.description - resources.users.resources.settings.resources.delegates.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.delegates.methods.delete.path - resources.users.resources.settings.resources.delegates.methods.get.description - resources.users.resources.settings.resources.delegates.methods.get.parameters.delegateEmail.description - resources.users.resources.settings.resources.delegates.methods.get.parameters.userId.description - resources.users.resources.settings.resources.delegates.methods.get.path - resources.users.resources.settings.resources.delegates.methods.list.description - resources.users.resources.settings.resources.delegates.methods.list.parameters.userId.description - resources.users.resources.settings.resources.delegates.methods.list.path - resources.users.resources.settings.resources.filters.methods.create.parameters.userId.description - resources.users.resources.settings.resources.filters.methods.create.path - resources.users.resources.settings.resources.filters.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.filters.methods.delete.path - resources.users.resources.settings.resources.filters.methods.get.parameters.userId.description - resources.users.resources.settings.resources.filters.methods.get.path - resources.users.resources.settings.resources.filters.methods.list.parameters.userId.description - resources.users.resources.settings.resources.filters.methods.list.path - resources.users.resources.settings.resources.forwardingAddresses.methods.create.description - resources.users.resources.settings.resources.forwardingAddresses.methods.create.parameters.userId.description - resources.users.resources.settings.resources.forwardingAddresses.methods.create.path - resources.users.resources.settings.resources.forwardingAddresses.methods.delete.description - resources.users.resources.settings.resources.forwardingAddresses.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.forwardingAddresses.methods.delete.path - resources.users.resources.settings.resources.forwardingAddresses.methods.get.parameters.userId.description - resources.users.resources.settings.resources.forwardingAddresses.methods.get.path - resources.users.resources.settings.resources.forwardingAddresses.methods.list.parameters.userId.description - resources.users.resources.settings.resources.forwardingAddresses.methods.list.path - resources.users.resources.settings.resources.sendAs.methods.create.description - resources.users.resources.settings.resources.sendAs.methods.create.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.create.path - resources.users.resources.settings.resources.sendAs.methods.delete.description - resources.users.resources.settings.resources.sendAs.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.delete.path - resources.users.resources.settings.resources.sendAs.methods.get.description - resources.users.resources.settings.resources.sendAs.methods.get.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.get.path - resources.users.resources.settings.resources.sendAs.methods.list.description - resources.users.resources.settings.resources.sendAs.methods.list.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.list.path - resources.users.resources.settings.resources.sendAs.methods.patch.description - resources.users.resources.settings.resources.sendAs.methods.patch.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.patch.path - resources.users.resources.settings.resources.sendAs.methods.update.description - resources.users.resources.settings.resources.sendAs.methods.update.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.update.path - resources.users.resources.settings.resources.sendAs.methods.verify.description - resources.users.resources.settings.resources.sendAs.methods.verify.parameters.userId.description - resources.users.resources.settings.resources.sendAs.methods.verify.path - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.delete.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.delete.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.delete.path - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.get.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.get.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.get.path - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.insert.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.insert.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.insert.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.insert.path - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.list.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.list.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.list.path - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.setDefault.parameters.sendAsEmail.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.setDefault.parameters.userId.description - resources.users.resources.settings.resources.sendAs.resources.smimeInfo.methods.setDefault.path - resources.users.resources.threads.methods.delete.description - resources.users.resources.threads.methods.delete.parameters.userId.description - resources.users.resources.threads.methods.delete.path - resources.users.resources.threads.methods.get.parameters.userId.description - resources.users.resources.threads.methods.get.path - resources.users.resources.threads.methods.list.parameters.includeSpamTrash.description - resources.users.resources.threads.methods.list.parameters.q.description - resources.users.resources.threads.methods.list.parameters.userId.description - resources.users.resources.threads.methods.list.path - resources.users.resources.threads.methods.modify.description - resources.users.resources.threads.methods.modify.parameters.userId.description - resources.users.resources.threads.methods.modify.path - resources.users.resources.threads.methods.trash.parameters.userId.description - resources.users.resources.threads.methods.trash.path - resources.users.resources.threads.methods.untrash.parameters.userId.description - resources.users.resources.threads.methods.untrash.path - schemas.AutoForwarding.properties.disposition.enum - schemas.AutoForwarding.properties.disposition.enumDescriptions - schemas.AutoForwarding.properties.emailAddress.description - schemas.BatchModifyMessagesRequest.properties.ids.description - schemas.Delegate.description - schemas.Delegate.properties.verificationStatus.description - schemas.Delegate.properties.verificationStatus.enum - schemas.Delegate.properties.verificationStatus.enumDescriptions - schemas.Filter.description - schemas.FilterCriteria.properties.negatedQuery.description - schemas.FilterCriteria.properties.query.description - schemas.FilterCriteria.properties.size.description - schemas.FilterCriteria.properties.sizeComparison.enum - schemas.FilterCriteria.properties.sizeComparison.enumDescriptions - schemas.FilterCriteria.properties.subject.description - schemas.FilterCriteria.properties.to.description - schemas.ForwardingAddress.properties.verificationStatus.description - schemas.ForwardingAddress.properties.verificationStatus.enum - schemas.ForwardingAddress.properties.verificationStatus.enumDescriptions - schemas.History.description - schemas.History.properties.messages.description - schemas.ImapSettings.properties.autoExpunge.description - schemas.ImapSettings.properties.expungeBehavior.description - schemas.ImapSettings.properties.expungeBehavior.enum - schemas.ImapSettings.properties.expungeBehavior.enumDescriptions - schemas.ImapSettings.properties.maxFolderSize.description - schemas.Label.description - schemas.Label.properties.color.description - schemas.Label.properties.labelListVisibility.description - schemas.Label.properties.labelListVisibility.enum - schemas.Label.properties.messageListVisibility.description - schemas.Label.properties.messageListVisibility.enum - schemas.Label.properties.name.description - schemas.Label.properties.type.description - schemas.LabelColor.properties.backgroundColor.description - schemas.LabelColor.properties.textColor.description - schemas.LanguageSettings.description - schemas.LanguageSettings.properties.displayLanguage.description - schemas.ListDraftsResponse.properties.drafts.description - schemas.ListHistoryResponse.properties.history.description - schemas.ListLabelsResponse.properties.labels.description - schemas.ListMessagesResponse.properties.messages.description - schemas.ListThreadsResponse.properties.threads.description - schemas.Message.properties.internalDate.description - schemas.Message.properties.labelIds.description - schemas.Message.properties.raw.description - schemas.Message.properties.threadId.description - schemas.MessagePart.properties.body.description - schemas.MessagePart.properties.filename.description - schemas.MessagePart.properties.headers.description - schemas.MessagePart.properties.parts.description - schemas.MessagePartBody.properties.attachmentId.description - schemas.MessagePartBody.properties.data.description - schemas.MessagePartHeader.properties.name.description - schemas.MessagePartHeader.properties.value.description - schemas.PopSettings.properties.accessWindow.enum - schemas.PopSettings.properties.accessWindow.enumDescriptions - schemas.PopSettings.properties.disposition.description - schemas.PopSettings.properties.disposition.enum - schemas.PopSettings.properties.disposition.enumDescriptions - schemas.SendAs.description - schemas.SendAs.properties.displayName.description - schemas.SendAs.properties.isDefault.description - schemas.SendAs.properties.isPrimary.description - schemas.SendAs.properties.replyToAddress.description - schemas.SendAs.properties.sendAsEmail.description - schemas.SendAs.properties.signature.description - schemas.SendAs.properties.smtpMsa.description - schemas.SendAs.properties.treatAsAlias.description - schemas.SendAs.properties.verificationStatus.description - schemas.SendAs.properties.verificationStatus.enum - schemas.SendAs.properties.verificationStatus.enumDescriptions - schemas.SmimeInfo.properties.pem.description - schemas.SmimeInfo.properties.pkcs12.description - schemas.SmtpMsa.properties.host.description - schemas.SmtpMsa.properties.password.description - schemas.SmtpMsa.properties.port.description - schemas.SmtpMsa.properties.securityMode.description - schemas.SmtpMsa.properties.securityMode.enum - schemas.SmtpMsa.properties.securityMode.enumDescriptions - schemas.SmtpMsa.properties.username.description - schemas.VacationSettings.description - schemas.VacationSettings.properties.endTime.description - schemas.VacationSettings.properties.responseBodyHtml.description - schemas.VacationSettings.properties.responseBodyPlainText.description - schemas.VacationSettings.properties.responseSubject.description - schemas.VacationSettings.properties.restrictToContacts.description - schemas.VacationSettings.properties.restrictToDomain.description - schemas.VacationSettings.properties.startTime.description - schemas.WatchRequest.properties.labelFilterAction.enum - schemas.WatchRequest.properties.labelFilterAction.enumDescriptions - schemas.WatchRequest.properties.labelIds.description - schemas.WatchRequest.properties.topicName.description - schemas.WatchResponse.properties.expiration.description --- discovery/gmail-v1.json | 847 ++++++++++++++++++++++------------------ src/apis/gmail/v1.ts | 745 ++++++++++++++++++++--------------- 2 files changed, 896 insertions(+), 696 deletions(-) diff --git a/discovery/gmail-v1.json b/discovery/gmail-v1.json index 6deb9cd8d2..35bf79813a 100644 --- a/discovery/gmail-v1.json +++ b/discovery/gmail-v1.json @@ -47,35 +47,63 @@ } } }, - "basePath": "/gmail/v1/users/", - "baseUrl": "https://www.googleapis.com/gmail/v1/users/", + "basePath": "", + "baseUrl": "https://www.googleapis.com/", "batchPath": "batch/gmail/v1", - "description": "Access Gmail mailboxes including sending user email.", + "canonicalName": "Gmail", + "description": "The Gmail API lets you view and manage Gmail mailbox data like\n threads, messages, and labels.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/gmail/api/", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/wuvO3debMRRbS1xgERSPmyvlCL4\"", "icons": { - "x16": "https://www.google.com/images/icons/product/googlemail-16.png", - "x32": "https://www.google.com/images/icons/product/googlemail-32.png" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "gmail:v1", "kind": "discovery#restDescription", + "mtlsRootUrl": "https://www.mtls.googleapis.com/", "name": "gmail", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, "alt": { "default": "json", - "description": "Data format for the response.", + "description": "Data format for response.", "enum": [ - "json" + "json", + "media", + "proto" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string" }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", @@ -98,12 +126,17 @@ "type": "boolean" }, "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -114,6 +147,7 @@ "methods": { "getProfile": { "description": "Gets the current user's Gmail profile.", + "flatPath": "gmail/v1/users/{userId}/profile", "httpMethod": "GET", "id": "gmail.users.getProfile", "parameterOrder": [ @@ -122,13 +156,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/profile", + "path": "gmail/v1/users/{userId}/profile", "response": { "$ref": "Profile" }, @@ -142,6 +176,7 @@ }, "stop": { "description": "Stop receiving push notifications for the given user mailbox.", + "flatPath": "gmail/v1/users/{userId}/stop", "httpMethod": "POST", "id": "gmail.users.stop", "parameterOrder": [ @@ -150,13 +185,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/stop", + "path": "gmail/v1/users/{userId}/stop", "scopes": [ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.metadata", @@ -166,6 +201,7 @@ }, "watch": { "description": "Set up or update a push notification watch on the given user mailbox.", + "flatPath": "gmail/v1/users/{userId}/watch", "httpMethod": "POST", "id": "gmail.users.watch", "parameterOrder": [ @@ -174,13 +210,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/watch", + "path": "gmail/v1/users/{userId}/watch", "request": { "$ref": "WatchRequest" }, @@ -199,14 +235,15 @@ "drafts": { "methods": { "create": { - "description": "Creates a new draft with the DRAFT label.", + "description": "Creates a new draft with the DRAFT label.", + "flatPath": "gmail/v1/users/{userId}/drafts", "httpMethod": "POST", "id": "gmail.users.drafts.create", "mediaUpload": { "accept": [ - "message/rfc822" + "message/*" ], - "maxSize": "35MB", + "maxSize": "36700160", "protocols": { "resumable": { "multipart": true, @@ -224,13 +261,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/drafts", + "path": "gmail/v1/users/{userId}/drafts", "request": { "$ref": "Draft" }, @@ -246,7 +283,8 @@ "supportsMediaUpload": true }, "delete": { - "description": "Immediately and permanently deletes the specified draft. Does not simply trash it.", + "description": "Immediately and permanently deletes the specified draft.\nDoes not simply trash it.", + "flatPath": "gmail/v1/users/{userId}/drafts/{id}", "httpMethod": "DELETE", "id": "gmail.users.drafts.delete", "parameterOrder": [ @@ -262,21 +300,23 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/drafts/{id}", + "path": "gmail/v1/users/{userId}/drafts/{id}", "scopes": [ "https://mail.google.com/", + "https://www.googleapis.com/auth/gmail.addons.current.action.compose", "https://www.googleapis.com/auth/gmail.compose", "https://www.googleapis.com/auth/gmail.modify" ] }, "get": { "description": "Gets the specified draft.", + "flatPath": "gmail/v1/users/{userId}/drafts/{id}", "httpMethod": "GET", "id": "gmail.users.drafts.get", "parameterOrder": [ @@ -288,16 +328,10 @@ "default": "full", "description": "The format to return the draft in.", "enum": [ - "full", - "metadata", "minimal", - "raw" - ], - "enumDescriptions": [ - "", - "", - "", - "" + "full", + "raw", + "metadata" ], "location": "query", "type": "string" @@ -310,13 +344,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/drafts/{id}", + "path": "gmail/v1/users/{userId}/drafts/{id}", "response": { "$ref": "Draft" }, @@ -329,6 +363,7 @@ }, "list": { "description": "Lists the drafts in the user's mailbox.", + "flatPath": "gmail/v1/users/{userId}/drafts", "httpMethod": "GET", "id": "gmail.users.drafts.list", "parameterOrder": [ @@ -337,7 +372,7 @@ "parameters": { "includeSpamTrash": { "default": "false", - "description": "Include drafts from SPAM and TRASH in the results.", + "description": "Include drafts from SPAM and TRASH\nin the results.", "location": "query", "type": "boolean" }, @@ -354,19 +389,19 @@ "type": "string" }, "q": { - "description": "Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, \"from:someuser@example.com rfc822msgid: is:unread\".", + "description": "Only return draft messages matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n\"from:someuser@example.com rfc822msgid:\nis: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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/drafts", + "path": "gmail/v1/users/{userId}/drafts", "response": { "$ref": "ListDraftsResponse" }, @@ -378,14 +413,15 @@ ] }, "send": { - "description": "Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.", + "description": "Sends the specified, existing draft to the recipients in the\nTo, Cc, and Bcc headers.", + "flatPath": "gmail/v1/users/{userId}/drafts/send", "httpMethod": "POST", "id": "gmail.users.drafts.send", "mediaUpload": { "accept": [ - "message/rfc822" + "message/*" ], - "maxSize": "35MB", + "maxSize": "36700160", "protocols": { "resumable": { "multipart": true, @@ -403,13 +439,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/drafts/send", + "path": "gmail/v1/users/{userId}/drafts/send", "request": { "$ref": "Draft" }, @@ -418,6 +454,7 @@ }, "scopes": [ "https://mail.google.com/", + "https://www.googleapis.com/auth/gmail.addons.current.action.compose", "https://www.googleapis.com/auth/gmail.compose", "https://www.googleapis.com/auth/gmail.modify" ], @@ -425,13 +462,14 @@ }, "update": { "description": "Replaces a draft's content.", + "flatPath": "gmail/v1/users/{userId}/drafts/{id}", "httpMethod": "PUT", "id": "gmail.users.drafts.update", "mediaUpload": { "accept": [ - "message/rfc822" + "message/*" ], - "maxSize": "35MB", + "maxSize": "36700160", "protocols": { "resumable": { "multipart": true, @@ -456,13 +494,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/drafts/{id}", + "path": "gmail/v1/users/{userId}/drafts/{id}", "request": { "$ref": "Draft" }, @@ -471,6 +509,7 @@ }, "scopes": [ "https://mail.google.com/", + "https://www.googleapis.com/auth/gmail.addons.current.action.compose", "https://www.googleapis.com/auth/gmail.compose", "https://www.googleapis.com/auth/gmail.modify" ], @@ -481,7 +520,8 @@ "history": { "methods": { "list": { - "description": "Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).", + "description": "Lists the history of all changes to the given mailbox. History results are\nreturned in chronological order (increasing historyId).", + "flatPath": "gmail/v1/users/{userId}/history", "httpMethod": "GET", "id": "gmail.users.history.list", "parameterOrder": [ @@ -491,16 +531,10 @@ "historyTypes": { "description": "History types to be returned by the function", "enum": [ - "labelAdded", - "labelRemoved", "messageAdded", - "messageDeleted" - ], - "enumDescriptions": [ - "", - "", - "", - "" + "messageDeleted", + "labelAdded", + "labelRemoved" ], "location": "query", "repeated": true, @@ -524,20 +558,20 @@ "type": "string" }, "startHistoryId": { - "description": "Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request.", + "description": "Required. Returns history records after the specified\nstartHistoryId. The supplied startHistoryId\nshould be obtained from the historyId of a message, thread, or\nprevious list response. History IDs increase\nchronologically but are not contiguous with random gaps in between valid\nIDs. Supplying an invalid or out of date startHistoryId\ntypically returns an HTTP 404 error code. A\nhistoryId is typically valid for at least a week, but in some\nrare circumstances may be valid for only a few hours. If you receive an\nHTTP 404 error response, your application should perform a\nfull sync. If you receive no nextPageToken in the response,\nthere are no updates to retrieve and you can store the returned\nhistoryId for a future request.", "format": "uint64", "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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/history", + "path": "gmail/v1/users/{userId}/history", "response": { "$ref": "ListHistoryResponse" }, @@ -554,6 +588,7 @@ "methods": { "create": { "description": "Creates a new label.", + "flatPath": "gmail/v1/users/{userId}/labels", "httpMethod": "POST", "id": "gmail.users.labels.create", "parameterOrder": [ @@ -562,13 +597,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/labels", + "path": "gmail/v1/users/{userId}/labels", "request": { "$ref": "Label" }, @@ -582,7 +617,8 @@ ] }, "delete": { - "description": "Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.", + "description": "Immediately and permanently deletes the specified label and removes it from\nany messages and threads that it is applied to.", + "flatPath": "gmail/v1/users/{userId}/labels/{id}", "httpMethod": "DELETE", "id": "gmail.users.labels.delete", "parameterOrder": [ @@ -598,13 +634,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/labels/{id}", + "path": "gmail/v1/users/{userId}/labels/{id}", "scopes": [ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.labels", @@ -613,6 +649,7 @@ }, "get": { "description": "Gets the specified label.", + "flatPath": "gmail/v1/users/{userId}/labels/{id}", "httpMethod": "GET", "id": "gmail.users.labels.get", "parameterOrder": [ @@ -628,13 +665,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/labels/{id}", + "path": "gmail/v1/users/{userId}/labels/{id}", "response": { "$ref": "Label" }, @@ -648,6 +685,7 @@ }, "list": { "description": "Lists all labels in the user's mailbox.", + "flatPath": "gmail/v1/users/{userId}/labels", "httpMethod": "GET", "id": "gmail.users.labels.list", "parameterOrder": [ @@ -656,13 +694,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/labels", + "path": "gmail/v1/users/{userId}/labels", "response": { "$ref": "ListLabelsResponse" }, @@ -675,7 +713,8 @@ ] }, "patch": { - "description": "Updates the specified label. This method supports patch semantics.", + "description": "Patch the specified label.", + "flatPath": "gmail/v1/users/{userId}/labels/{id}", "httpMethod": "PATCH", "id": "gmail.users.labels.patch", "parameterOrder": [ @@ -691,13 +730,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/labels/{id}", + "path": "gmail/v1/users/{userId}/labels/{id}", "request": { "$ref": "Label" }, @@ -712,6 +751,7 @@ }, "update": { "description": "Updates the specified label.", + "flatPath": "gmail/v1/users/{userId}/labels/{id}", "httpMethod": "PUT", "id": "gmail.users.labels.update", "parameterOrder": [ @@ -727,13 +767,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/labels/{id}", + "path": "gmail/v1/users/{userId}/labels/{id}", "request": { "$ref": "Label" }, @@ -751,7 +791,8 @@ "messages": { "methods": { "batchDelete": { - "description": "Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.", + "description": "Deletes many messages by message ID. Provides no guarantees that messages\nwere not already deleted or even existed at all.", + "flatPath": "gmail/v1/users/{userId}/messages/batchDelete", "httpMethod": "POST", "id": "gmail.users.messages.batchDelete", "parameterOrder": [ @@ -760,13 +801,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/batchDelete", + "path": "gmail/v1/users/{userId}/messages/batchDelete", "request": { "$ref": "BatchDeleteMessagesRequest" }, @@ -776,6 +817,7 @@ }, "batchModify": { "description": "Modifies the labels on the specified messages.", + "flatPath": "gmail/v1/users/{userId}/messages/batchModify", "httpMethod": "POST", "id": "gmail.users.messages.batchModify", "parameterOrder": [ @@ -784,13 +826,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/batchModify", + "path": "gmail/v1/users/{userId}/messages/batchModify", "request": { "$ref": "BatchModifyMessagesRequest" }, @@ -800,7 +842,8 @@ ] }, "delete": { - "description": "Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead.", + "description": "Immediately and permanently deletes the specified message. This operation\ncannot be undone. Prefer messages.trash instead.", + "flatPath": "gmail/v1/users/{userId}/messages/{id}", "httpMethod": "DELETE", "id": "gmail.users.messages.delete", "parameterOrder": [ @@ -816,19 +859,20 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/{id}", + "path": "gmail/v1/users/{userId}/messages/{id}", "scopes": [ "https://mail.google.com/" ] }, "get": { "description": "Gets the specified message.", + "flatPath": "gmail/v1/users/{userId}/messages/{id}", "httpMethod": "GET", "id": "gmail.users.messages.get", "parameterOrder": [ @@ -840,16 +884,10 @@ "default": "full", "description": "The format to return the message in.", "enum": [ - "full", - "metadata", "minimal", - "raw" - ], - "enumDescriptions": [ - "", - "", - "", - "" + "full", + "raw", + "metadata" ], "location": "query", "type": "string" @@ -868,13 +906,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/{id}", + "path": "gmail/v1/users/{userId}/messages/{id}", "response": { "$ref": "Message" }, @@ -889,14 +927,15 @@ ] }, "import": { - "description": "Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.", + "description": "Imports a message into only this user's mailbox, with standard\nemail delivery scanning and classification similar to receiving via SMTP.\nDoes not send a message.", + "flatPath": "gmail/v1/users/{userId}/messages/import", "httpMethod": "POST", "id": "gmail.users.messages.import", "mediaUpload": { "accept": [ - "message/rfc822" + "message/*" ], - "maxSize": "50MB", + "maxSize": "52428800", "protocols": { "resumable": { "multipart": true, @@ -914,7 +953,7 @@ "parameters": { "deleted": { "default": "false", - "description": "Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.", + "description": "Mark the email as permanently deleted (not TRASH) and\nonly visible in\nGoogle Vault to\na Vault administrator. Only used for G Suite accounts.", "location": "query", "type": "boolean" }, @@ -922,37 +961,33 @@ "default": "dateHeader", "description": "Source for Gmail's internal date of the message.", "enum": [ - "dateHeader", - "receivedTime" - ], - "enumDescriptions": [ - "", - "" + "receivedTime", + "dateHeader" ], "location": "query", "type": "string" }, "neverMarkSpam": { "default": "false", - "description": "Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.", + "description": "Ignore the Gmail spam classifier decision and never mark\nthis email as SPAM in the mailbox.", "location": "query", "type": "boolean" }, "processForCalendar": { "default": "false", - "description": "Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.", + "description": "Process calendar invites in the email and add any extracted\nmeetings to the Google Calendar for this user.", "location": "query", "type": "boolean" }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/import", + "path": "gmail/v1/users/{userId}/messages/import", "request": { "$ref": "Message" }, @@ -967,14 +1002,15 @@ "supportsMediaUpload": true }, "insert": { - "description": "Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.", + "description": "Directly inserts a message into only this user's mailbox similar to\nIMAP APPEND, bypassing most scanning and classification.\nDoes not send a message.", + "flatPath": "gmail/v1/users/{userId}/messages", "httpMethod": "POST", "id": "gmail.users.messages.insert", "mediaUpload": { "accept": [ - "message/rfc822" + "message/*" ], - "maxSize": "50MB", + "maxSize": "52428800", "protocols": { "resumable": { "multipart": true, @@ -992,7 +1028,7 @@ "parameters": { "deleted": { "default": "false", - "description": "Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.", + "description": "Mark the email as permanently deleted (not TRASH) and\nonly visible in\nGoogle Vault to\na Vault administrator. Only used for G Suite accounts.", "location": "query", "type": "boolean" }, @@ -1000,25 +1036,21 @@ "default": "receivedTime", "description": "Source for Gmail's internal date of the message.", "enum": [ - "dateHeader", - "receivedTime" - ], - "enumDescriptions": [ - "", - "" + "receivedTime", + "dateHeader" ], "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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages", + "path": "gmail/v1/users/{userId}/messages", "request": { "$ref": "Message" }, @@ -1034,6 +1066,7 @@ }, "list": { "description": "Lists the messages in the user's mailbox.", + "flatPath": "gmail/v1/users/{userId}/messages", "httpMethod": "GET", "id": "gmail.users.messages.list", "parameterOrder": [ @@ -1042,7 +1075,7 @@ "parameters": { "includeSpamTrash": { "default": "false", - "description": "Include messages from SPAM and TRASH in the results.", + "description": "Include messages from SPAM and TRASH\nin the results.", "location": "query", "type": "boolean" }, @@ -1065,19 +1098,19 @@ "type": "string" }, "q": { - "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\". Parameter cannot be used when accessing the api using the gmail.metadata scope.", + "description": "Only return messages matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n\"from:someuser@example.com rfc822msgid:<somemsgid@example.com>\nis:unread\". Parameter cannot be used when accessing the api\nusing the gmail.metadata scope.", "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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages", + "path": "gmail/v1/users/{userId}/messages", "response": { "$ref": "ListMessagesResponse" }, @@ -1090,6 +1123,7 @@ }, "modify": { "description": "Modifies the labels on the specified message.", + "flatPath": "gmail/v1/users/{userId}/messages/{id}/modify", "httpMethod": "POST", "id": "gmail.users.messages.modify", "parameterOrder": [ @@ -1105,13 +1139,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/{id}/modify", + "path": "gmail/v1/users/{userId}/messages/{id}/modify", "request": { "$ref": "ModifyMessageRequest" }, @@ -1124,14 +1158,15 @@ ] }, "send": { - "description": "Sends the specified message to the recipients in the To, Cc, and Bcc headers.", + "description": "Sends the specified message to the recipients in the\nTo, Cc, and Bcc headers.", + "flatPath": "gmail/v1/users/{userId}/messages/send", "httpMethod": "POST", "id": "gmail.users.messages.send", "mediaUpload": { "accept": [ - "message/rfc822" + "message/*" ], - "maxSize": "35MB", + "maxSize": "36700160", "protocols": { "resumable": { "multipart": true, @@ -1149,13 +1184,13 @@ "parameters": { "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/send", + "path": "gmail/v1/users/{userId}/messages/send", "request": { "$ref": "Message" }, @@ -1173,6 +1208,7 @@ }, "trash": { "description": "Moves the specified message to the trash.", + "flatPath": "gmail/v1/users/{userId}/messages/{id}/trash", "httpMethod": "POST", "id": "gmail.users.messages.trash", "parameterOrder": [ @@ -1188,13 +1224,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/{id}/trash", + "path": "gmail/v1/users/{userId}/messages/{id}/trash", "response": { "$ref": "Message" }, @@ -1205,6 +1241,7 @@ }, "untrash": { "description": "Removes the specified message from the trash.", + "flatPath": "gmail/v1/users/{userId}/messages/{id}/untrash", "httpMethod": "POST", "id": "gmail.users.messages.untrash", "parameterOrder": [ @@ -1220,13 +1257,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/{id}/untrash", + "path": "gmail/v1/users/{userId}/messages/{id}/untrash", "response": { "$ref": "Message" }, @@ -1241,6 +1278,7 @@ "methods": { "get": { "description": "Gets the specified message attachment.", + "flatPath": "gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}", "httpMethod": "GET", "id": "gmail.users.messages.attachments.get", "parameterOrder": [ @@ -1263,13 +1301,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/messages/{messageId}/attachments/{id}", + "path": "gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}", "response": { "$ref": "MessagePartBody" }, @@ -1289,6 +1327,7 @@ "methods": { "getAutoForwarding": { "description": "Gets the auto-forwarding setting for the specified account.", + "flatPath": "gmail/v1/users/{userId}/settings/autoForwarding", "httpMethod": "GET", "id": "gmail.users.settings.getAutoForwarding", "parameterOrder": [ @@ -1297,13 +1336,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/autoForwarding", + "path": "gmail/v1/users/{userId}/settings/autoForwarding", "response": { "$ref": "AutoForwarding" }, @@ -1316,6 +1355,7 @@ }, "getImap": { "description": "Gets IMAP settings.", + "flatPath": "gmail/v1/users/{userId}/settings/imap", "httpMethod": "GET", "id": "gmail.users.settings.getImap", "parameterOrder": [ @@ -1324,13 +1364,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/imap", + "path": "gmail/v1/users/{userId}/settings/imap", "response": { "$ref": "ImapSettings" }, @@ -1343,6 +1383,7 @@ }, "getLanguage": { "description": "Gets language settings.", + "flatPath": "gmail/v1/users/{userId}/settings/language", "httpMethod": "GET", "id": "gmail.users.settings.getLanguage", "parameterOrder": [ @@ -1351,13 +1392,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/language", + "path": "gmail/v1/users/{userId}/settings/language", "response": { "$ref": "LanguageSettings" }, @@ -1370,6 +1411,7 @@ }, "getPop": { "description": "Gets POP settings.", + "flatPath": "gmail/v1/users/{userId}/settings/pop", "httpMethod": "GET", "id": "gmail.users.settings.getPop", "parameterOrder": [ @@ -1378,13 +1420,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/pop", + "path": "gmail/v1/users/{userId}/settings/pop", "response": { "$ref": "PopSettings" }, @@ -1397,6 +1439,7 @@ }, "getVacation": { "description": "Gets vacation responder settings.", + "flatPath": "gmail/v1/users/{userId}/settings/vacation", "httpMethod": "GET", "id": "gmail.users.settings.getVacation", "parameterOrder": [ @@ -1405,13 +1448,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/vacation", + "path": "gmail/v1/users/{userId}/settings/vacation", "response": { "$ref": "VacationSettings" }, @@ -1423,7 +1466,8 @@ ] }, "updateAutoForwarding": { - "description": "Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Updates the auto-forwarding setting for the specified account. A verified\nforwarding address must be specified when auto-forwarding is enabled.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/autoForwarding", "httpMethod": "PUT", "id": "gmail.users.settings.updateAutoForwarding", "parameterOrder": [ @@ -1432,13 +1476,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/autoForwarding", + "path": "gmail/v1/users/{userId}/settings/autoForwarding", "request": { "$ref": "AutoForwarding" }, @@ -1451,6 +1495,7 @@ }, "updateImap": { "description": "Updates IMAP settings.", + "flatPath": "gmail/v1/users/{userId}/settings/imap", "httpMethod": "PUT", "id": "gmail.users.settings.updateImap", "parameterOrder": [ @@ -1459,13 +1504,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/imap", + "path": "gmail/v1/users/{userId}/settings/imap", "request": { "$ref": "ImapSettings" }, @@ -1477,7 +1522,8 @@ ] }, "updateLanguage": { - "description": "Updates language settings.\n\nIf successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.", + "description": "Updates language settings.\n\nIf successful, the return object contains the displayLanguage\nthat was saved for the user, which may differ from the value passed into\nthe request. This is because the requested displayLanguage may\nnot be directly supported by Gmail but have a close variant that is, and so\nthe variant may be chosen and saved instead.", + "flatPath": "gmail/v1/users/{userId}/settings/language", "httpMethod": "PUT", "id": "gmail.users.settings.updateLanguage", "parameterOrder": [ @@ -1486,13 +1532,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/language", + "path": "gmail/v1/users/{userId}/settings/language", "request": { "$ref": "LanguageSettings" }, @@ -1505,6 +1551,7 @@ }, "updatePop": { "description": "Updates POP settings.", + "flatPath": "gmail/v1/users/{userId}/settings/pop", "httpMethod": "PUT", "id": "gmail.users.settings.updatePop", "parameterOrder": [ @@ -1513,13 +1560,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/pop", + "path": "gmail/v1/users/{userId}/settings/pop", "request": { "$ref": "PopSettings" }, @@ -1532,6 +1579,7 @@ }, "updateVacation": { "description": "Updates vacation responder settings.", + "flatPath": "gmail/v1/users/{userId}/settings/vacation", "httpMethod": "PUT", "id": "gmail.users.settings.updateVacation", "parameterOrder": [ @@ -1540,13 +1588,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/vacation", + "path": "gmail/v1/users/{userId}/settings/vacation", "request": { "$ref": "VacationSettings" }, @@ -1562,7 +1610,8 @@ "delegates": { "methods": { "create": { - "description": "Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user.\n\nGmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators.\n\nNote that a delegate user must be referred to by their primary email address, and not an email alias.\n\nAlso note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Adds a delegate with its verification status set directly to\naccepted, without sending any verification email. The\ndelegate user must be a member of the same G Suite organization as the\ndelegator user.\n\nGmail imposes limitations on the number of delegates and delegators each\nuser in a G Suite organization can have. These limits depend on your\norganization, but in general each user can have up to 25 delegates and\nup to 10 delegators.\n\nNote that a delegate user must be referred to by their primary email\naddress, and not an email alias.\n\nAlso note that when a new delegate is created, there may be up to a one\nminute delay before the new delegate is available for use.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/delegates", "httpMethod": "POST", "id": "gmail.users.settings.delegates.create", "parameterOrder": [ @@ -1571,13 +1620,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/delegates", + "path": "gmail/v1/users/{userId}/settings/delegates", "request": { "$ref": "Delegate" }, @@ -1589,7 +1638,8 @@ ] }, "delete": { - "description": "Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it.\n\nNote that a delegate user must be referred to by their primary email address, and not an email alias.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Removes the specified delegate (which can be of any verification status),\nand revokes any verification that may have been required for using it.\n\nNote that a delegate user must be referred to by their primary email\naddress, and not an email alias.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/delegates/{delegateEmail}", "httpMethod": "DELETE", "id": "gmail.users.settings.delegates.delete", "parameterOrder": [ @@ -1605,19 +1655,20 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/delegates/{delegateEmail}", + "path": "gmail/v1/users/{userId}/settings/delegates/{delegateEmail}", "scopes": [ "https://www.googleapis.com/auth/gmail.settings.sharing" ] }, "get": { - "description": "Gets the specified delegate.\n\nNote that a delegate user must be referred to by their primary email address, and not an email alias.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Gets the specified delegate.\n\nNote that a delegate user must be referred to by their primary email\naddress, and not an email alias.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/delegates/{delegateEmail}", "httpMethod": "GET", "id": "gmail.users.settings.delegates.get", "parameterOrder": [ @@ -1626,20 +1677,20 @@ ], "parameters": { "delegateEmail": { - "description": "The email address of the user whose delegate relationship is to be retrieved.", + "description": "The email address of the user whose delegate relationship is to be\nretrieved.", "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.", + "description": "User's email address. The special value \"me\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/delegates/{delegateEmail}", + "path": "gmail/v1/users/{userId}/settings/delegates/{delegateEmail}", "response": { "$ref": "Delegate" }, @@ -1651,7 +1702,8 @@ ] }, "list": { - "description": "Lists the delegates for the specified account.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Lists the delegates for the specified account.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/delegates", "httpMethod": "GET", "id": "gmail.users.settings.delegates.list", "parameterOrder": [ @@ -1660,13 +1712,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/delegates", + "path": "gmail/v1/users/{userId}/settings/delegates", "response": { "$ref": "ListDelegatesResponse" }, @@ -1683,6 +1735,7 @@ "methods": { "create": { "description": "Creates a filter.", + "flatPath": "gmail/v1/users/{userId}/settings/filters", "httpMethod": "POST", "id": "gmail.users.settings.filters.create", "parameterOrder": [ @@ -1691,13 +1744,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/filters", + "path": "gmail/v1/users/{userId}/settings/filters", "request": { "$ref": "Filter" }, @@ -1710,6 +1763,7 @@ }, "delete": { "description": "Deletes a filter.", + "flatPath": "gmail/v1/users/{userId}/settings/filters/{id}", "httpMethod": "DELETE", "id": "gmail.users.settings.filters.delete", "parameterOrder": [ @@ -1725,19 +1779,20 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/filters/{id}", + "path": "gmail/v1/users/{userId}/settings/filters/{id}", "scopes": [ "https://www.googleapis.com/auth/gmail.settings.basic" ] }, "get": { "description": "Gets a filter.", + "flatPath": "gmail/v1/users/{userId}/settings/filters/{id}", "httpMethod": "GET", "id": "gmail.users.settings.filters.get", "parameterOrder": [ @@ -1753,13 +1808,13 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/filters/{id}", + "path": "gmail/v1/users/{userId}/settings/filters/{id}", "response": { "$ref": "Filter" }, @@ -1772,6 +1827,7 @@ }, "list": { "description": "Lists the message filters of a Gmail user.", + "flatPath": "gmail/v1/users/{userId}/settings/filters", "httpMethod": "GET", "id": "gmail.users.settings.filters.list", "parameterOrder": [ @@ -1780,13 +1836,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/filters", + "path": "gmail/v1/users/{userId}/settings/filters", "response": { "$ref": "ListFiltersResponse" }, @@ -1802,7 +1858,8 @@ "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.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Creates a forwarding address. If ownership verification is required, a\nmessage will be sent to the recipient and the resource's verification\nstatus will be set to pending; otherwise, the resource will be\ncreated with verification status set to accepted.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/forwardingAddresses", "httpMethod": "POST", "id": "gmail.users.settings.forwardingAddresses.create", "parameterOrder": [ @@ -1811,13 +1868,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/forwardingAddresses", + "path": "gmail/v1/users/{userId}/settings/forwardingAddresses", "request": { "$ref": "ForwardingAddress" }, @@ -1829,7 +1886,8 @@ ] }, "delete": { - "description": "Deletes the specified forwarding address and revokes any verification that may have been required.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Deletes the specified forwarding address and revokes any verification that\nmay have been required.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}", "httpMethod": "DELETE", "id": "gmail.users.settings.forwardingAddresses.delete", "parameterOrder": [ @@ -1845,19 +1903,20 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/forwardingAddresses/{forwardingEmail}", + "path": "gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}", "scopes": [ "https://www.googleapis.com/auth/gmail.settings.sharing" ] }, "get": { "description": "Gets the specified forwarding address.", + "flatPath": "gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}", "httpMethod": "GET", "id": "gmail.users.settings.forwardingAddresses.get", "parameterOrder": [ @@ -1873,13 +1932,13 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/forwardingAddresses/{forwardingEmail}", + "path": "gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}", "response": { "$ref": "ForwardingAddress" }, @@ -1892,6 +1951,7 @@ }, "list": { "description": "Lists the forwarding addresses for the specified account.", + "flatPath": "gmail/v1/users/{userId}/settings/forwardingAddresses", "httpMethod": "GET", "id": "gmail.users.settings.forwardingAddresses.list", "parameterOrder": [ @@ -1900,13 +1960,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/forwardingAddresses", + "path": "gmail/v1/users/{userId}/settings/forwardingAddresses", "response": { "$ref": "ListForwardingAddressesResponse" }, @@ -1922,7 +1982,8 @@ "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.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Creates a custom \"from\" send-as alias. If an SMTP MSA is specified, Gmail\nwill attempt to connect to the SMTP service to validate the configuration\nbefore creating the alias. If ownership verification is required for the\nalias, a message will be sent to the email address and the resource's\nverification status will be set to pending; otherwise, the\nresource will be created with verification status set to\naccepted. If a signature is provided, Gmail will sanitize the\nHTML before saving it with the alias.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs", "httpMethod": "POST", "id": "gmail.users.settings.sendAs.create", "parameterOrder": [ @@ -1931,13 +1992,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs", + "path": "gmail/v1/users/{userId}/settings/sendAs", "request": { "$ref": "SendAs" }, @@ -1949,7 +2010,8 @@ ] }, "delete": { - "description": "Deletes the specified send-as alias. Revokes any verification that may have been required for using it.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Deletes the specified send-as alias. Revokes any verification that may\nhave been required for using it.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "DELETE", "id": "gmail.users.settings.sendAs.delete", "parameterOrder": [ @@ -1965,19 +2027,20 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}", + "path": "gmail/v1/users/{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.", + "description": "Gets the specified send-as alias. Fails with an HTTP 404 error if the\nspecified address is not a member of the collection.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "GET", "id": "gmail.users.settings.sendAs.get", "parameterOrder": [ @@ -1993,13 +2056,13 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}", + "path": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "response": { "$ref": "SendAs" }, @@ -2011,7 +2074,8 @@ ] }, "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.", + "description": "Lists the send-as aliases for the specified account. The result includes\nthe primary send-as address associated with the account as well as any\ncustom \"from\" aliases.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs", "httpMethod": "GET", "id": "gmail.users.settings.sendAs.list", "parameterOrder": [ @@ -2020,13 +2084,13 @@ "parameters": { "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs", + "path": "gmail/v1/users/{userId}/settings/sendAs", "response": { "$ref": "ListSendAsResponse" }, @@ -2038,7 +2102,8 @@ ] }, "patch": { - "description": "Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.\n\nAddresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics.", + "description": "Patch the specified send-as alias.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "PATCH", "id": "gmail.users.settings.sendAs.patch", "parameterOrder": [ @@ -2054,13 +2119,13 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}", + "path": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "request": { "$ref": "SendAs" }, @@ -2073,7 +2138,8 @@ ] }, "update": { - "description": "Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.\n\nAddresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.", + "description": "Updates a send-as alias. If a signature is provided, Gmail will sanitize\nthe HTML before saving it with the alias.\n\nAddresses other than the primary address for the account can only be\nupdated by service account clients that have been delegated domain-wide\nauthority.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "httpMethod": "PUT", "id": "gmail.users.settings.sendAs.update", "parameterOrder": [ @@ -2089,13 +2155,13 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}", + "path": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}", "request": { "$ref": "SendAs" }, @@ -2108,7 +2174,8 @@ ] }, "verify": { - "description": "Sends a verification email to the specified send-as alias address. The verification status must be pending.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.", + "description": "Sends a verification email to the specified send-as alias address.\nThe verification status must be pending.\n\nThis method is only available to service account clients that have been\ndelegated domain-wide authority.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify", "httpMethod": "POST", "id": "gmail.users.settings.sendAs.verify", "parameterOrder": [ @@ -2124,13 +2191,13 @@ }, "userId": { "default": "me", - "description": "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\"\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}/verify", + "path": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify", "scopes": [ "https://www.googleapis.com/auth/gmail.settings.sharing" ] @@ -2141,6 +2208,7 @@ "methods": { "delete": { "description": "Deletes the specified S/MIME config for the specified send-as alias.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}", "httpMethod": "DELETE", "id": "gmail.users.settings.sendAs.smimeInfo.delete", "parameterOrder": [ @@ -2156,20 +2224,20 @@ "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}", + "path": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}", "scopes": [ "https://www.googleapis.com/auth/gmail.settings.basic", "https://www.googleapis.com/auth/gmail.settings.sharing" @@ -2177,6 +2245,7 @@ }, "get": { "description": "Gets the specified S/MIME config for the specified send-as alias.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}", "httpMethod": "GET", "id": "gmail.users.settings.sendAs.smimeInfo.get", "parameterOrder": [ @@ -2192,20 +2261,20 @@ "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}", + "path": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}", "response": { "$ref": "SmimeInfo" }, @@ -2218,7 +2287,8 @@ ] }, "insert": { - "description": "Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.", + "description": "Insert (upload) the given S/MIME config for the specified send-as alias.\nNote that pkcs12 format is required for the key.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo", "httpMethod": "POST", "id": "gmail.users.settings.sendAs.smimeInfo.insert", "parameterOrder": [ @@ -2227,20 +2297,20 @@ ], "parameters": { "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo", + "path": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo", "request": { "$ref": "SmimeInfo" }, @@ -2254,6 +2324,7 @@ }, "list": { "description": "Lists S/MIME configs for the specified send-as alias.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo", "httpMethod": "GET", "id": "gmail.users.settings.sendAs.smimeInfo.list", "parameterOrder": [ @@ -2262,20 +2333,20 @@ ], "parameters": { "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo", + "path": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo", "response": { "$ref": "ListSmimeInfoResponse" }, @@ -2289,6 +2360,7 @@ }, "setDefault": { "description": "Sets the default S/MIME config for the specified send-as alias.", + "flatPath": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault", "httpMethod": "POST", "id": "gmail.users.settings.sendAs.smimeInfo.setDefault", "parameterOrder": [ @@ -2304,20 +2376,20 @@ "type": "string" }, "sendAsEmail": { - "description": "The email address that appears in the \"From:\" header for mail sent using this alias.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis alias.", "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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault", + "path": "gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault", "scopes": [ "https://www.googleapis.com/auth/gmail.settings.basic", "https://www.googleapis.com/auth/gmail.settings.sharing" @@ -2332,7 +2404,8 @@ "threads": { "methods": { "delete": { - "description": "Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.", + "description": "Immediately and permanently deletes the specified thread. This operation\ncannot be undone. Prefer threads.trash instead.", + "flatPath": "gmail/v1/users/{userId}/threads/{id}", "httpMethod": "DELETE", "id": "gmail.users.threads.delete", "parameterOrder": [ @@ -2348,19 +2421,20 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/threads/{id}", + "path": "gmail/v1/users/{userId}/threads/{id}", "scopes": [ "https://mail.google.com/" ] }, "get": { "description": "Gets the specified thread.", + "flatPath": "gmail/v1/users/{userId}/threads/{id}", "httpMethod": "GET", "id": "gmail.users.threads.get", "parameterOrder": [ @@ -2376,11 +2450,6 @@ "metadata", "minimal" ], - "enumDescriptions": [ - "", - "", - "" - ], "location": "query", "type": "string" }, @@ -2398,13 +2467,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/threads/{id}", + "path": "gmail/v1/users/{userId}/threads/{id}", "response": { "$ref": "Thread" }, @@ -2420,6 +2489,7 @@ }, "list": { "description": "Lists the threads in the user's mailbox.", + "flatPath": "gmail/v1/users/{userId}/threads", "httpMethod": "GET", "id": "gmail.users.threads.list", "parameterOrder": [ @@ -2428,7 +2498,7 @@ "parameters": { "includeSpamTrash": { "default": "false", - "description": "Include threads from SPAM and TRASH in the results.", + "description": "Include threads from SPAM and TRASH\nin the results.", "location": "query", "type": "boolean" }, @@ -2451,19 +2521,19 @@ "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\". Parameter cannot be used when accessing the api using the gmail.metadata scope.", + "description": "Only return threads matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n\"from:someuser@example.com rfc822msgid:\nis:unread\". Parameter cannot be used when accessing the api\nusing the gmail.metadata scope.", "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": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/threads", + "path": "gmail/v1/users/{userId}/threads", "response": { "$ref": "ListThreadsResponse" }, @@ -2475,7 +2545,8 @@ ] }, "modify": { - "description": "Modifies the labels applied to the thread. This applies to all messages in the thread.", + "description": "Modifies the labels applied to the thread. This applies to all messages\nin the thread.", + "flatPath": "gmail/v1/users/{userId}/threads/{id}/modify", "httpMethod": "POST", "id": "gmail.users.threads.modify", "parameterOrder": [ @@ -2491,13 +2562,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/threads/{id}/modify", + "path": "gmail/v1/users/{userId}/threads/{id}/modify", "request": { "$ref": "ModifyThreadRequest" }, @@ -2511,6 +2582,7 @@ }, "trash": { "description": "Moves the specified thread to the trash.", + "flatPath": "gmail/v1/users/{userId}/threads/{id}/trash", "httpMethod": "POST", "id": "gmail.users.threads.trash", "parameterOrder": [ @@ -2526,13 +2598,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/threads/{id}/trash", + "path": "gmail/v1/users/{userId}/threads/{id}/trash", "response": { "$ref": "Thread" }, @@ -2543,6 +2615,7 @@ }, "untrash": { "description": "Removes the specified thread from the trash.", + "flatPath": "gmail/v1/users/{userId}/threads/{id}/untrash", "httpMethod": "POST", "id": "gmail.users.threads.untrash", "parameterOrder": [ @@ -2558,13 +2631,13 @@ }, "userId": { "default": "me", - "description": "The user's email address. The special value me can be used to indicate the authenticated user.", + "description": "The user's email address. The special value me\ncan be used to indicate the authenticated user.", "location": "path", "required": true, "type": "string" } }, - "path": "{userId}/threads/{id}/untrash", + "path": "gmail/v1/users/{userId}/threads/{id}/untrash", "response": { "$ref": "Thread" }, @@ -2578,7 +2651,7 @@ } } }, - "revision": "20200504", + "revision": "20200608", "rootUrl": "https://www.googleapis.com/", "schemas": { "AutoForwarding": { @@ -2588,23 +2661,23 @@ "disposition": { "description": "The state that a message should be left in after it has been forwarded.", "enum": [ - "archive", "dispositionUnspecified", "leaveInInbox", - "markRead", - "trash" + "archive", + "trash", + "markRead" ], "enumDescriptions": [ - "", - "", - "", - "", - "" + "Unspecified disposition.", + "Leave the message in the `INBOX`.", + "Archive the message.", + "Move the message to the `TRASH`.", + "Leave the message in the `INBOX` and mark it as read." ], "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.", + "description": "Email address to which all incoming messages are forwarded. This email\naddress must be a verified member of the forwarding addresses.", "type": "string" }, "enabled": { @@ -2638,7 +2711,7 @@ "type": "array" }, "ids": { - "description": "The IDs of the messages to modify. There is a limit of 1000 ids per request.", + "description": "The IDs of the messages to modify. There is a limit of 1000 ids per\nrequest.", "items": { "type": "string" }, @@ -2655,7 +2728,7 @@ "type": "object" }, "Delegate": { - "description": "Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See \"Set up mail delegation\" for more information about delegates.", + "description": "Settings for a delegate. Delegates can read, send, and delete messages, as\nwell as view and add contacts, for the delegator's account. See\n\"Set up\nmail delegation\" for more information about delegates.", "id": "Delegate", "properties": { "delegateEmail": { @@ -2663,20 +2736,20 @@ "type": "string" }, "verificationStatus": { - "description": "Indicates whether this address has been verified and can act as a delegate for the account. Read-only.", + "description": "Indicates whether this address has been verified and can act as a delegate\nfor the account. Read-only.", "enum": [ + "verificationStatusUnspecified", "accepted", - "expired", "pending", "rejected", - "verificationStatusUnspecified" + "expired" ], "enumDescriptions": [ - "", - "", - "", - "", - "" + "Unspecified verification status.", + "The address can act a delegate for the account.", + "A verification request was mailed to the address, and the owner has not\nyet accepted it.", + "A verification request was mailed to the address, and the owner rejected\nit.", + "A verification request was mailed to the address, and it expired without\nverification." ], "type": "string" } @@ -2704,7 +2777,7 @@ "type": "object" }, "Filter": { - "description": "Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.", + "description": "Resource definition for Gmail filters. Filters apply to specific messages\ninstead of an entire email thread.", "id": "Filter", "properties": { "action": { @@ -2764,38 +2837,38 @@ "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\".", + "description": "Only return messages not matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n\"from:someuser@example.com rfc822msgid:\nis: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\".", + "description": "Only return messages matching the specified query. Supports the same\nquery format as the Gmail search box. For example,\n\"from:someuser@example.com rfc822msgid:\nis:unread\".", "type": "string" }, "size": { - "description": "The size of the entire RFC822 message in bytes, including all headers and attachments.", + "description": "The size of the entire RFC822 message in bytes, including all headers and\nattachments.", "format": "int32", "type": "integer" }, "sizeComparison": { "description": "How the message size in bytes should be in relation to the size field.", "enum": [ - "larger", + "unspecified", "smaller", - "unspecified" + "larger" ], "enumDescriptions": [ "", - "", - "" + "Find messages smaller than the given size.", + "Find messages larger than the given size." ], "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.", + "description": "Case-insensitive phrase found in the message's subject. Trailing and\nleading 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.", + "description": "The recipient's display name or email address. Includes recipients in the\n\"to\", \"cc\", and \"bcc\" header fields. You can use simply the local part of\nthe email address. For example, \"example\" and \"example@\" both match\n\"example@gmail.com\". This field is case-insensitive.", "type": "string" } }, @@ -2810,16 +2883,16 @@ "type": "string" }, "verificationStatus": { - "description": "Indicates whether this address has been verified and is usable for forwarding. Read-only.", + "description": "Indicates whether this address has been verified and is usable for\nforwarding. Read-only.", "enum": [ + "verificationStatusUnspecified", "accepted", - "pending", - "verificationStatusUnspecified" + "pending" ], "enumDescriptions": [ - "", - "", - "" + "Unspecified verification status.", + "The address is ready to use for forwarding.", + "The address is awaiting verification by the owner." ], "type": "string" } @@ -2827,7 +2900,7 @@ "type": "object" }, "History": { - "description": "A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.", + "description": "A record of a change to the user's mailbox. Each history change may affect\nmultiple messages in multiple ways.", "id": "History", "properties": { "id": { @@ -2850,7 +2923,7 @@ "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.", + "description": "List of messages changed in this history record. The fields for specific\nchange types, such as messagesAdded may duplicate messages in\nthis field. We recommend using the specific change-type fields instead\nof this.", "items": { "$ref": "Message" }, @@ -2928,7 +3001,7 @@ "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.", + "description": "If this value is true, Gmail will immediately expunge a message when it is\nmarked as deleted in IMAP. Otherwise, Gmail will wait for an update from\nthe client before expunging messages marked as deleted.", "type": "boolean" }, "enabled": { @@ -2936,23 +3009,23 @@ "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.", + "description": "The action that will be executed on a message when it is marked as deleted\nand expunged from the last visible IMAP folder.", "enum": [ - "archive", - "deleteForever", "expungeBehaviorUnspecified", - "trash" + "archive", + "trash", + "deleteForever" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unspecified behavior.", + "Archive messages marked as deleted.", + "Move messages marked as deleted to the trash.", + "Immediately and permanently delete messages marked as deleted. The\nexpunged messages cannot be recovered." ], "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.", + "description": "An optional limit on the number of messages that an IMAP folder may\ncontain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero\nis interpreted to mean that there is no limit.", "format": "int32", "type": "integer" } @@ -2960,12 +3033,12 @@ "type": "object" }, "Label": { - "description": "Labels are used to categorize messages and threads within the user's mailbox.", + "description": "Labels are used to categorize messages and threads within the\nuser's mailbox.", "id": "Label", "properties": { "color": { "$ref": "LabelColor", - "description": "The color to assign to the label. Color is only available for labels that have their type set to user." + "description": "The color to assign to the label. Color is only available for labels that\nhave their type set to user.\n@mutable gmail.users.labels.create gmail.users.labels.update" }, "id": { "annotations": { @@ -2983,11 +3056,11 @@ "gmail.users.labels.update" ] }, - "description": "The visibility of the label in the label list in the Gmail web interface.", + "description": "The visibility of the label in the label list in the Gmail web interface.\n@mutable gmail.users.labels.create gmail.users.labels.update", "enum": [ - "labelHide", "labelShow", - "labelShowIfUnread" + "labelShowIfUnread", + "labelHide" ], "enumDescriptions": [ "", @@ -3003,10 +3076,10 @@ "gmail.users.labels.update" ] }, - "description": "The visibility of the label in the message list in the Gmail web interface.", + "description": "The visibility of the label in the message list in the\nGmail web interface.\n@mutable gmail.users.labels.create gmail.users.labels.update", "enum": [ - "hide", - "show" + "show", + "hide" ], "enumDescriptions": [ "", @@ -3031,7 +3104,7 @@ "gmail.users.labels.update" ] }, - "description": "The display name of the label.", + "description": "The display name of the label.\n@mutable gmail.users.labels.create gmail.users.labels.update", "type": "string" }, "threadsTotal": { @@ -3045,7 +3118,7 @@ "type": "integer" }, "type": { - "description": "The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.", + "description": "The owner type for the label. User labels are created by the user and\ncan be modified and deleted by the user and can be applied to any\nmessage or thread. System labels are internally created and cannot be\nadded, modified, or deleted. System labels may be able to be applied to or\nremoved from messages and threads under some circumstances but this is\nnot guaranteed. For example, users can apply and remove the\nINBOX and UNREAD labels from messages and\nthreads, but cannot apply or remove the DRAFTS or\nSENT labels from messages or threads.", "enum": [ "system", "user" @@ -3063,22 +3136,22 @@ "id": "LabelColor", "properties": { "backgroundColor": { - "description": "The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed:\n#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765", + "description": "The background color represented as hex string #RRGGBB (ex #000000).\nThis field is required in order to set the color of a label.\nOnly the following predefined set of color values are allowed:\n
\n# 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,\n\n# fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,\n\n# f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,\n\n# efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,\n\n# e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,\n\n# cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,\n\n# ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,\n\n# 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c\n\n# 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,\n\n# 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,\n\n# 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,\n\n# c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,\n\n# 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765\n\n@mutable gmail.users.labels.create gmail.users.labels.update", "type": "string" }, "textColor": { - "description": "The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed:\n#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765", + "description": "The text color of the label, represented as hex string.\nThis field is required in order to set the color of a label.\nOnly the following predefined set of color values are allowed:\n
\n# 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,\n\n# fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,\n\n# f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,\n\n# efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,\n\n# e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,\n\n# cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,\n\n# ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,\n\n# 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c\n\n# 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,\n\n# 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,\n\n# 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,\n\n# c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,\n\n# 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765\n\n@mutable gmail.users.labels.create gmail.users.labels.update", "type": "string" } }, "type": "object" }, "LanguageSettings": { - "description": "Language settings for an account. These settings correspond to the \"Language settings\" feature in the web interface.", + "description": "Language settings for an account. These settings correspond to\nthe \"Language\nsettings\" feature in the web interface.", "id": "LanguageSettings", "properties": { "displayLanguage": { - "description": "The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).\n\nThe set of languages supported by Gmail evolves over time, so please refer to the \"Language\" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide \n\nNot all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).", + "description": "The language to display Gmail in, formatted as an\nRFC 3066\nLanguage Tag (for example en-GB, fr or\nja for British English, French, or Japanese respectively).\n\nThe set of languages supported by Gmail evolves over time, so please refer\nto the \"Language\" dropdown in the\nGmail settings\n for all available options, as described in the\nlanguage settings\nhelp article. A table of sample values is also provided in the\nManaging\nLanguage Settings guide\n\nNot all Gmail clients can display the same set of languages. In the case\nthat a user's display language is not available for use on a particular\nclient, said client automatically chooses to display in the closest\nsupported variant (or a reasonable default).", "type": "string" } }, @@ -3102,7 +3175,7 @@ "id": "ListDraftsResponse", "properties": { "drafts": { - "description": "List of drafts. Note that the Message property in each Draft resource only contains an id and a threadId. The messages.get method can fetch additional message details.", + "description": "List of drafts. Note that the Message property in each\nDraft resource only contains an id and a\nthreadId. The\nmessages.get\nmethod can fetch additional message details.", "items": { "$ref": "Draft" }, @@ -3152,7 +3225,7 @@ "id": "ListHistoryResponse", "properties": { "history": { - "description": "List of history records. Any messages contained in the response will typically only have id and threadId fields populated.", + "description": "List of history records. Any messages contained in the\nresponse will typically only have id and\nthreadId fields populated.", "items": { "$ref": "History" }, @@ -3174,7 +3247,7 @@ "id": "ListLabelsResponse", "properties": { "labels": { - "description": "List of labels. Note that each label resource only contains an id, name, messageListVisibility, labelListVisibility, and type. The labels.get method can fetch additional label details.", + "description": "List of labels. Note that each label resource only contains an\nid, name, messageListVisibility,\nlabelListVisibility, and type. The\nlabels.get method\ncan fetch additional label details.", "items": { "$ref": "Label" }, @@ -3187,7 +3260,7 @@ "id": "ListMessagesResponse", "properties": { "messages": { - "description": "List of messages. Note that each message resource contains only an id and a threadId. Additional message details can be fetched using the messages.get method.", + "description": "List of messages. Note that each message resource contains only an\nid and a threadId. Additional message details can\nbe fetched using the\nmessages.get\nmethod.", "items": { "$ref": "Message" }, @@ -3245,7 +3318,7 @@ "type": "integer" }, "threads": { - "description": "List of threads. Note that each thread resource does not contain a list of messages. The list of messages for a given thread can be fetched using the threads.get method.", + "description": "List of threads. Note that each thread resource does not contain a list of\nmessages. The list of messages for a given thread\ncan be fetched using the\nthreads.get method.", "items": { "$ref": "Thread" }, @@ -3268,12 +3341,12 @@ "type": "string" }, "internalDate": { - "description": "The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.", + "description": "The internal message creation timestamp (epoch ms), which determines\nordering in the inbox. For normal SMTP-received email, this represents the\ntime the message was originally accepted by Google, which is more reliable\nthan the Date header. However, for API-migrated mail, it can\nbe configured by client to be based on the Date header.", "format": "int64", "type": "string" }, "labelIds": { - "description": "List of IDs of labels applied to this message.", + "description": "List of IDs of labels applied to this message.\n@mutable gmail.users.messages.insert gmail.users.messages.modify", "items": { "type": "string" }, @@ -3292,7 +3365,7 @@ "gmail.users.messages.send" ] }, - "description": "The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.", + "description": "The entire email message in an RFC 2822 formatted and base64url\nencoded string. Returned in messages.get and\ndrafts.get responses when the format=RAW\nparameter is supplied.\n@mutable gmail.users.messages.insert gmail.users.messages.send\n@mutable gmail.users.drafts.create gmail.users.drafts.update", "format": "byte", "type": "string" }, @@ -3306,7 +3379,7 @@ "type": "string" }, "threadId": { - "description": "The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: \n- The requested threadId must be specified on the Message or Draft.Message you supply with your request. \n- The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard. \n- The Subject headers must match.", + "description": "The ID of the thread the message belongs to. To add a message or draft to\na thread, the following criteria must be met:\n
  1. The requested threadId must be specified on the\nMessage or Draft.Message you supply with your\nrequest.
    2. \n
  2. The References and In-Reply-To headers must\nbe set in compliance with the\nRFC 2822 standard.
    3. \n
  3. The Subject headers must match.\n@mutable gmail.users.messages.insert gmail.users.messages.send\n@mutable gmail.users.drafts.create gmail.users.drafts.update", "type": "string" } }, @@ -3318,14 +3391,14 @@ "properties": { "body": { "$ref": "MessagePartBody", - "description": "The message part body for this part, which may be empty for container MIME message parts." + "description": "The message part body for this part, which may be empty for\ncontainer MIME message parts." }, "filename": { - "description": "The filename of the attachment. Only present if this message part represents an attachment.", + "description": "The filename of the attachment. Only present if this message part\nrepresents an attachment.", "type": "string" }, "headers": { - "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.", + "description": "List of headers on this message part. For the top-level message part,\nrepresenting the entire message payload, it will contain the standard\nRFC 2822 email headers such as To, From, and\nSubject.", "items": { "$ref": "MessagePartHeader" }, @@ -3340,7 +3413,7 @@ "type": "string" }, "parts": { - "description": "The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.", + "description": "The child MIME message parts of this part. This only applies to container\nMIME message parts, for example multipart/*. For non-\ncontainer MIME message part types, such as text/plain, this\nfield is empty. For more information, see\nRFC 1521.", "items": { "$ref": "MessagePart" }, @@ -3354,11 +3427,11 @@ "id": "MessagePartBody", "properties": { "attachmentId": { - "description": "When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.", + "description": "When present, contains the ID of an external attachment that can be\nretrieved in a separate messages.attachments.get request.\nWhen not present, the entire content of the message part body is\ncontained in the data field.", "type": "string" }, "data": { - "description": "The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.", + "description": "The body data of a MIME message part as a base64url encoded string.\nMay be empty for MIME container\ntypes that have no message body or when the body data is sent as a\nseparate attachment. An attachment ID is present if the body data is\ncontained in a separate attachment.", "format": "byte", "type": "string" }, @@ -3374,11 +3447,11 @@ "id": "MessagePartHeader", "properties": { "name": { - "description": "The name of the header before the : separator. For example, To.", + "description": "The name of the header before the : separator. For\nexample, To.", "type": "string" }, "value": { - "description": "The value of the header after the : separator. For example, someuser@example.com.", + "description": "The value of the header after the : separator. For example,\nsomeuser@example.com.", "type": "string" } }, @@ -3432,33 +3505,33 @@ "description": "The range of messages which are accessible via POP.", "enum": [ "accessWindowUnspecified", - "allMail", "disabled", - "fromNowOn" + "fromNowOn", + "allMail" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unspecified range.", + "Indicates that no messages are accessible via POP.", + "Indicates that unfetched messages received after some past point in\ntime are accessible via POP.", + "Indicates that all unfetched messages are accessible via POP." ], "type": "string" }, "disposition": { - "description": "The action that will be executed on a message after it has been fetched via POP.", + "description": "The action that will be executed on a message after it has been fetched via\nPOP.", "enum": [ - "archive", "dispositionUnspecified", "leaveInInbox", - "markRead", - "trash" + "archive", + "trash", + "markRead" ], "enumDescriptions": [ - "", - "", - "", - "", - "" + "Unspecified disposition.", + "Leave the message in the INBOX.", + "Archive the message.", + "Move the message to the TRASH.", + "Leave the message in the INBOX and mark it as read." ], "type": "string" } @@ -3492,52 +3565,52 @@ "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.", + "description": "Settings associated with a send-as alias, which can be either the primary\nlogin address associated with the account or a custom \"from\" address.\nSend-as aliases correspond to the\n\"Send Mail As\"\nfeature in the web interface.", "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. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.", + "description": "A name that appears in the \"From:\" header for mail sent using this alias.\nFor custom \"from\" addresses, when this is empty, Gmail will populate the\n\"From:\" header with the name that is used for the primary address\nassociated with the account.\nIf the admin has disabled the ability for users to update their name\nformat, requests to update this field for the primary login will silently\nfail.", "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.", + "description": "Whether this address is selected as the default \"From:\" address in\nsituations such as composing a new message or sending a vacation\nauto-reply. Every Gmail account has exactly one default send-as address,\nso the only legal value that clients may write to this field is\ntrue. Changing this from false to\ntrue for an address will result in this field becoming\nfalse 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.", + "description": "Whether this address is the primary address used to login to the account.\nEvery Gmail account has exactly one primary address, and it cannot be\ndeleted 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.", + "description": "An optional email address that is included in a \"Reply-To:\" header for mail\nsent using this alias. If this is empty, Gmail will not generate a\n\"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.", + "description": "The email address that appears in the \"From:\" header for mail sent using\nthis 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.", + "description": "An optional HTML signature that is included in messages composed with this\nalias 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." + "description": "An optional SMTP service that will be used as an outbound relay for mail\nsent using this alias. If this is empty, outbound mail will be sent\ndirectly from Gmail's servers to the destination SMTP service. This\nsetting only applies to custom \"from\" aliases." }, "treatAsAlias": { - "description": "Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom \"from\" aliases.", + "description": "Whether Gmail should \ntreat this address as an alias for the user's primary email address.\nThis 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.", + "description": "Indicates whether this address has been verified for use as a send-as\nalias. Read-only. This setting only applies to custom \"from\" aliases.", "enum": [ + "verificationStatusUnspecified", "accepted", - "pending", - "verificationStatusUnspecified" + "pending" ], "enumDescriptions": [ - "", - "", - "" + "Unspecified verification status.", + "The address is ready to use as a send-as alias.", + "The address is awaiting verification by the owner." ], "type": "string" } @@ -3570,11 +3643,11 @@ "type": "string" }, "pem": { - "description": "PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).", + "description": "PEM formatted X509 concatenated certificate string (standard base64\nencoding). Format used for returning key, which includes public key\nas well as certificate chain (not private key).", "type": "string" }, "pkcs12": { - "description": "PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.", + "description": "PKCS#12 format containing a single private/public key pair and\ncertificate chain. This format is only accepted from client\nfor creating a new SmimeInfo and is never returned, because the\nprivate key is not intended to be exported. PKCS#12 may be encrypted,\nin which case encryptedKeyPassword should be set appropriately.", "format": "byte", "type": "string" } @@ -3586,36 +3659,36 @@ "id": "SmtpMsa", "properties": { "host": { - "description": "The hostname of the SMTP service. Required.", + "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.", + "description": "The password that will be used for authentication with the SMTP service.\nThis is a write-only field that can be specified in requests to create or\nupdate SendAs settings; it is never populated in responses.", "type": "string" }, "port": { - "description": "The port of the SMTP service. Required.", + "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.", + "description": "The protocol that will be used to secure communication with the SMTP\nservice. Required.", "enum": [ - "none", "securityModeUnspecified", + "none", "ssl", "starttls" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unspecified security mode.", + "Communication with the remote SMTP service is unsecured. Requires port\n25.", + "Communication with the remote SMTP service is secured using SSL.", + "Communication with the remote SMTP service is secured using STARTTLS." ], "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.", + "description": "The username that will be used for authentication with the SMTP service.\nThis is a write-only field that can be specified in requests to create or\nupdate SendAs settings; it is never populated in responses.", "type": "string" } }, @@ -3649,7 +3722,7 @@ "type": "object" }, "VacationSettings": { - "description": "Vacation auto-reply settings for an account. These settings correspond to the \"Vacation responder\" feature in the web interface.", + "description": "Vacation auto-reply settings for an account. These settings correspond to\nthe \"Vacation\nresponder\" feature in the web interface.", "id": "VacationSettings", "properties": { "enableAutoReply": { @@ -3657,32 +3730,32 @@ "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.", + "description": "An optional end time for sending auto-replies (epoch ms).\nWhen this is specified, Gmail will automatically reply only to messages\nthat it receives before the end time. If both startTime and\nendTime are specified, startTime must precede\nendTime.", "format": "int64", "type": "string" }, "responseBodyHtml": { - "description": "Response body in HTML format. Gmail will sanitize the HTML before storing it.", + "description": "Response body in HTML format. Gmail will sanitize the HTML before\nstoring it. If both response_body_plain_text and\nresponse_body_html are specified,\nresponse_body_html will be used.", "type": "string" }, "responseBodyPlainText": { - "description": "Response body in plain text format.", + "description": "Response body in plain text format. If both\nresponse_body_plain_text and response_body_html\nare specified, response_body_html will be used.", "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.", + "description": "Optional text to prepend to the subject line in vacation responses. In\norder to enable auto-replies, either the response subject or the response\nbody 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.", + "description": "Flag that determines whether responses are sent to recipients who are not\nin 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 G Suite users.", + "description": "Flag that determines whether responses are sent to recipients who are\noutside of the user's domain. This feature is only available for G Suite\nusers.", "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.", + "description": "An optional start time for sending auto-replies (epoch ms).\nWhen this is specified, Gmail will automatically reply only to messages\nthat it receives after the start time. If both startTime and\nendTime are specified, startTime must precede\nendTime.", "format": "int64", "type": "string" } @@ -3696,24 +3769,24 @@ "labelFilterAction": { "description": "Filtering behavior of labelIds list specified.", "enum": [ - "exclude", - "include" + "include", + "exclude" ], "enumDescriptions": [ - "", - "" + "Only get push notifications for message changes relating to labelIds\nspecified.", + "Get push notifications for all message changes except those relating\nto labelIds specified." ], "type": "string" }, "labelIds": { - "description": "List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.", + "description": "List of label_ids to restrict notifications about. By default,\nif unspecified, all changes are pushed out. If specified then\ndictates which labels are required for a push notification to\nbe generated.", "items": { "type": "string" }, "type": "array" }, "topicName": { - "description": "A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail \"publish\" permission on it. For example, \"projects/my-project-identifier/topics/my-topic-name\" (using the Cloud Pub/Sub \"v1\" topic naming format).\n\nNote that the \"my-project-identifier\" portion must exactly match your Google developer project id (the one executing this watch request).", + "description": "A fully qualified Google Cloud Pub/Sub API topic name to publish the\nevents to. This topic name **must** already exist in Cloud Pub/Sub and\nyou **must** have already granted gmail \"publish\" permission on it.\nFor example, \"projects/my-project-identifier/topics/my-topic-name\"\n(using the Cloud Pub/Sub \"v1\" topic naming format).\n\nNote that the \"my-project-identifier\" portion must exactly match your\nGoogle developer project id (the one executing this watch request).", "type": "string" } }, @@ -3724,7 +3797,7 @@ "id": "WatchResponse", "properties": { "expiration": { - "description": "When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch.", + "description": "When Gmail will stop sending notifications for mailbox updates\n(epoch millis). Call watch again before this time to renew\nthe watch.", "format": "int64", "type": "string" }, @@ -3737,7 +3810,7 @@ "type": "object" } }, - "servicePath": "gmail/v1/users/", + "servicePath": "", "title": "Gmail API", "version": "v1" } \ No newline at end of file diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index b612244f5c..19a47b1e48 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -53,9 +53,21 @@ export namespace gmail_v1 { | GoogleAuth; /** - * Data format for the response. + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. */ alt?: string; + /** + * JSONP + */ + callback?: string; /** * Selector specifying which fields to include in a partial response. */ @@ -73,19 +85,23 @@ export namespace gmail_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** * Gmail API * - * Access Gmail mailboxes including sending user email. + * The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels. * * @example * const {google} = require('googleapis'); @@ -120,7 +136,7 @@ export namespace gmail_v1 { */ disposition?: string | null; /** - * Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. + * Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. */ emailAddress?: string | null; /** @@ -149,7 +165,7 @@ export namespace gmail_v1 { removeLabelIds?: string[] | null; } /** - * Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates. + * Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See <a href="https://support.google.com/mail/answer/138350">"Set up mail delegation"</a> for more information about delegates. */ export interface Schema$Delegate { /** @@ -157,7 +173,7 @@ export namespace gmail_v1 { */ delegateEmail?: string | null; /** - * Indicates whether this address has been verified and can act as a delegate for the account. Read-only. + * Indicates whether this address has been verified and can act as a delegate for the account. Read-only. */ verificationStatus?: string | null; } @@ -225,11 +241,11 @@ export namespace gmail_v1 { */ hasAttachment?: boolean | null; /** - * 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". + * Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, <code>"from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"</code>. */ negatedQuery?: string | null; /** - * 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". + * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, <code>"from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"</code>. */ query?: string | null; /** @@ -258,7 +274,7 @@ export namespace gmail_v1 { */ forwardingEmail?: string | null; /** - * Indicates whether this address has been verified and is usable for forwarding. Read-only. + * Indicates whether this address has been verified and is usable for forwarding. Read-only. */ verificationStatus?: string | null; } @@ -279,7 +295,7 @@ export namespace gmail_v1 { */ labelsRemoved?: Schema$HistoryLabelRemoved[]; /** - * 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. + * List of messages changed in this history record. The fields for specific change types, such as <code>messagesAdded</code> may duplicate messages in this field. We recommend using the specific change-type fields instead of this. */ messages?: Schema$Message[]; /** @@ -316,7 +332,7 @@ export namespace gmail_v1 { */ export interface Schema$ImapSettings { /** - * 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. + * 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. */ autoExpunge?: boolean | null; /** @@ -328,7 +344,7 @@ export namespace gmail_v1 { */ expungeBehavior?: string | null; /** - * 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. + * 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. */ maxFolderSize?: number | null; } @@ -337,7 +353,7 @@ export namespace gmail_v1 { */ export interface Schema$Label { /** - * The color to assign to the label. Color is only available for labels that have their type set to user. + * The color to assign to the label. Color is only available for labels that have their <code>type</code> set to <code>user</code>. @mutable gmail.users.labels.create gmail.users.labels.update */ color?: Schema$LabelColor; /** @@ -345,11 +361,11 @@ export namespace gmail_v1 { */ id?: string | null; /** - * The visibility of the label in the label list in the Gmail web interface. + * The visibility of the label in the label list in the Gmail web interface. @mutable gmail.users.labels.create gmail.users.labels.update */ labelListVisibility?: string | null; /** - * The visibility of the label in the message list in the Gmail web interface. + * The visibility of the label in the message list in the Gmail web interface. @mutable gmail.users.labels.create gmail.users.labels.update */ messageListVisibility?: string | null; /** @@ -361,7 +377,7 @@ export namespace gmail_v1 { */ messagesUnread?: number | null; /** - * The display name of the label. + * The display name of the label. @mutable gmail.users.labels.create gmail.users.labels.update */ name?: string | null; /** @@ -373,26 +389,26 @@ export namespace gmail_v1 { */ threadsUnread?: number | null; /** - * The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads. + * The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the <code>INBOX</code> and <code>UNREAD</code> labels from messages and threads, but cannot apply or remove the <code>DRAFTS</code> or <code>SENT</code> labels from messages or threads. */ type?: string | null; } export interface Schema$LabelColor { /** - * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: <br/> # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update */ backgroundColor?: string | null; /** - * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: <br/> # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update */ textColor?: string | null; } /** - * Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. + * Language settings for an account. These settings correspond to the <a href="https://support.google.com/mail/answer/17091">"Language settings"</a> feature in the web interface. */ export interface Schema$LanguageSettings { /** - * The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). + * The language to display Gmail in, formatted as an <a href="https://www.w3.org/International/articles/language-tags/">RFC 3066 Language Tag</a> (for example <code>en-GB</code>, <code>fr</code> or <code>ja</code> for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the <a href="https://mail.google.com/mail/u/0/#settings/general">Gmail settings </a> for all available options, as described in the <a href="https://support.google.com/mail/answer/17091">language settings help article</a>. A table of sample values is also provided in the <a href="/gmail/api/guides/language_settings#display_language">Managing Language Settings guide</a> Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). */ displayLanguage?: string | null; } @@ -407,7 +423,7 @@ export namespace gmail_v1 { } export interface Schema$ListDraftsResponse { /** - * List of drafts. Note that the Message property in each Draft resource only contains an id and a threadId. The messages.get method can fetch additional message details. + * List of drafts. Note that the <code>Message</code> property in each <code>Draft</code> resource only contains an <code>id</code> and a <code>threadId</code>. The <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a> method can fetch additional message details. */ drafts?: Schema$Draft[]; /** @@ -439,7 +455,7 @@ export namespace gmail_v1 { } export interface Schema$ListHistoryResponse { /** - * List of history records. Any messages contained in the response will typically only have id and threadId fields populated. + * List of history records. Any <code>messages</code> contained in the response will typically only have <code>id</code> and <code>threadId</code> fields populated. */ history?: Schema$History[]; /** @@ -453,13 +469,13 @@ export namespace gmail_v1 { } export interface Schema$ListLabelsResponse { /** - * List of labels. Note that each label resource only contains an id, name, messageListVisibility, labelListVisibility, and type. The labels.get method can fetch additional label details. + * List of labels. Note that each label resource only contains an <code>id</code>, <code>name</code>, <code>messageListVisibility</code>, <code>labelListVisibility</code>, and <code>type</code>. The <a href="/gmail/api/v1/reference/users/labels/get">labels.get</a> method can fetch additional label details. */ labels?: Schema$Label[]; } export interface Schema$ListMessagesResponse { /** - * List of messages. Note that each message resource contains only an id and a threadId. Additional message details can be fetched using the messages.get method. + * List of messages. Note that each message resource contains only an <code>id</code> and a <code>threadId</code>. Additional message details can be fetched using the <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a> method. */ messages?: Schema$Message[]; /** @@ -496,7 +512,7 @@ export namespace gmail_v1 { */ resultSizeEstimate?: number | null; /** - * List of threads. Note that each thread resource does not contain a list of messages. The list of messages for a given thread can be fetched using the threads.get method. + * List of threads. Note that each thread resource does not contain a list of <code>messages</code>. The list of <code>messages</code> for a given thread can be fetched using the <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> method. */ threads?: Schema$Thread[]; } @@ -513,11 +529,11 @@ export namespace gmail_v1 { */ id?: string | null; /** - * The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header. + * The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the <code>Date</code> header. However, for API-migrated mail, it can be configured by client to be based on the <code>Date</code> header. */ internalDate?: string | null; /** - * List of IDs of labels applied to this message. + * List of IDs of labels applied to this message. @mutable gmail.users.messages.insert gmail.users.messages.modify */ labelIds?: string[] | null; /** @@ -525,7 +541,7 @@ export namespace gmail_v1 { */ payload?: Schema$MessagePart; /** - * The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied. + * The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in <code>messages.get</code> and <code>drafts.get</code> responses when the <code>format=RAW</code> parameter is supplied. @mutable gmail.users.messages.insert gmail.users.messages.send @mutable gmail.users.drafts.create gmail.users.drafts.update */ raw?: string | null; /** @@ -537,7 +553,7 @@ export namespace gmail_v1 { */ snippet?: string | null; /** - * The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: - The requested threadId must be specified on the Message or Draft.Message you supply with your request. - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard. - The Subject headers must match. + * The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: <ol><li>The requested <code>threadId</code> must be specified on the <code>Message</code> or <code>Draft.Message</code> you supply with your request.</li> <li>The <code>References</code> and <code>In-Reply-To</code> headers must be set in compliance with the <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li> <li>The <code>Subject</code> headers must match. @mutable gmail.users.messages.insert gmail.users.messages.send @mutable gmail.users.drafts.create gmail.users.drafts.update */ threadId?: string | null; } @@ -554,7 +570,7 @@ export namespace gmail_v1 { */ filename?: string | null; /** - * 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. + * 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 <code>To</code>, <code>From</code>, and <code>Subject</code>. */ headers?: Schema$MessagePartHeader[]; /** @@ -566,7 +582,7 @@ export namespace gmail_v1 { */ partId?: string | null; /** - * The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521. + * The child MIME message parts of this part. This only applies to container MIME message parts, for example <code>multipart/*</code>. For non- container MIME message part types, such as <code>text/plain</code>, this field is empty. For more information, see <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>. */ parts?: Schema$MessagePart[]; } @@ -575,7 +591,7 @@ export namespace gmail_v1 { */ export interface Schema$MessagePartBody { /** - * When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field. + * When present, contains the ID of an external attachment that can be retrieved in a separate <code>messages.attachments.get</code> request. When not present, the entire content of the message part body is contained in the data field. */ attachmentId?: string | null; /** @@ -589,11 +605,11 @@ export namespace gmail_v1 { } export interface Schema$MessagePartHeader { /** - * The name of the header before the : separator. For example, To. + * The name of the header before the <code>:</code> separator. For example, <code>To</code>. */ name?: string | null; /** - * The value of the header after the : separator. For example, someuser@example.com. + * The value of the header after the <code>:</code> separator. For example, <code>someuser@example.com</code>. */ value?: string | null; } @@ -652,7 +668,7 @@ export namespace gmail_v1 { threadsTotal?: number | null; } /** - * 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. + * 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 <a href="https://support.google.com/mail/answer/22370">"Send Mail As"</a> feature in the web interface. */ export interface Schema$SendAs { /** @@ -660,19 +676,19 @@ export namespace gmail_v1 { */ displayName?: string | null; /** - * 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. + * 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 <code>true</code>. Changing this from <code>false</code> to <code>true</code> for an address will result in this field becoming <code>false</code> for the other previous default address. */ isDefault?: boolean | null; /** - * 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. + * 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. */ isPrimary?: boolean | null; /** - * 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. + * 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. */ replyToAddress?: string | null; /** - * The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create. + * The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create. */ sendAsEmail?: string | null; /** @@ -680,15 +696,15 @@ export namespace gmail_v1 { */ signature?: string | null; /** - * 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. + * 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. */ smtpMsa?: Schema$SmtpMsa; /** - * Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases. + * Whether Gmail should <a href="https://support.google.com/a/answer/1710338"> treat this address as an alias</a> for the user's primary email address. This setting only applies to custom "from" aliases. */ treatAsAlias?: boolean | null; /** - * Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. + * Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. */ verificationStatus?: string | null; } @@ -717,11 +733,11 @@ export namespace gmail_v1 { */ issuerCn?: string | null; /** - * PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key). + * PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key). */ pem?: string | null; /** - * PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. + * PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. */ pkcs12?: string | null; } @@ -730,7 +746,7 @@ export namespace gmail_v1 { */ export interface Schema$SmtpMsa { /** - * The hostname of the SMTP service. Required. + * The hostname of the SMTP service. Required. */ host?: string | null; /** @@ -738,11 +754,11 @@ export namespace gmail_v1 { */ password?: string | null; /** - * The port of the SMTP service. Required. + * The port of the SMTP service. Required. */ port?: number | null; /** - * The protocol that will be used to secure communication with the SMTP service. Required. + * The protocol that will be used to secure communication with the SMTP service. Required. */ securityMode?: string | null; /** @@ -772,7 +788,7 @@ export namespace gmail_v1 { snippet?: string | null; } /** - * Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. + * Vacation auto-reply settings for an account. These settings correspond to the <a href="https://support.google.com/mail/answer/25922">"Vacation responder"</a> feature in the web interface. */ export interface Schema$VacationSettings { /** @@ -780,19 +796,19 @@ export namespace gmail_v1 { */ enableAutoReply?: boolean | null; /** - * 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. + * 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 <code>startTime</code> and <code>endTime</code> are specified, <code>startTime</code> must precede <code>endTime</code>. */ endTime?: string | null; /** - * Response body in HTML format. Gmail will sanitize the HTML before storing it. + * Response body in HTML format. Gmail will sanitize the HTML before storing it. If both <code>response_body_plain_text</code> and <code>response_body_html</code> are specified, <code>response_body_html</code> will be used. */ responseBodyHtml?: string | null; /** - * Response body in plain text format. + * Response body in plain text format. If both <code>response_body_plain_text</code> and <code>response_body_html</code> are specified, <code>response_body_html</code> will be used. */ responseBodyPlainText?: string | null; /** - * 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. + * 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. */ responseSubject?: string | null; /** @@ -804,7 +820,7 @@ export namespace gmail_v1 { */ restrictToDomain?: boolean | null; /** - * 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. + * 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 <code>startTime</code> and <code>endTime</code> are specified, <code>startTime</code> must precede <code>endTime</code>. */ startTime?: string | null; } @@ -817,7 +833,7 @@ export namespace gmail_v1 { */ labelFilterAction?: string | null; /** - * List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. + * List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. */ labelIds?: string[] | null; /** @@ -830,7 +846,7 @@ export namespace gmail_v1 { */ export interface Schema$WatchResponse { /** - * When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch. + * When Gmail will stop sending notifications for mailbox updates (epoch millis). Call <code>watch</code> again before this time to renew the watch. */ expiration?: string | null; /** @@ -890,7 +906,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.getProfile({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -913,7 +930,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1028,7 +1045,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.stop({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -1043,7 +1061,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1156,7 +1174,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.watch({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -1187,7 +1206,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().WatchRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1274,19 +1293,19 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Getprofile extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Stop extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Watch extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -1304,7 +1323,7 @@ export namespace gmail_v1 { /** * gmail.users.drafts.create - * @desc Creates a new draft with the DRAFT label. + * @desc Creates a new draft with the DRAFT label. * @example * // Before running the sample: * // - Enable the API at: @@ -1334,7 +1353,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.drafts.create({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -1368,7 +1388,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -1480,6 +1500,7 @@ export namespace gmail_v1 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://mail.google.com/', + * 'https://www.googleapis.com/auth/gmail.addons.current.action.compose', * 'https://www.googleapis.com/auth/gmail.compose', * 'https://www.googleapis.com/auth/gmail.modify', * ], @@ -1493,7 +1514,8 @@ export namespace gmail_v1 { * const res = await gmail.users.drafts.delete({ * // The ID of the draft to delete. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -1509,7 +1531,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the draft to delete. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1627,7 +1649,8 @@ export namespace gmail_v1 { * format: 'placeholder-value', * // The ID of the draft to retrieve. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -1650,7 +1673,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string=} params.format The format to return the draft in. * @param {string} params.id The ID of the draft to retrieve. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1765,15 +1788,20 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.drafts.list({ - * // Include drafts from SPAM and TRASH in the results. + * // Include drafts from SPAM and TRASH + * // in the results. * includeSpamTrash: 'placeholder-value', * // Maximum number of drafts to return. * maxResults: 'placeholder-value', * // Page token to retrieve a specific page of results in the list. * pageToken: 'placeholder-value', - * // Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". + * // Only return draft messages matching the specified query. Supports the same + * // query format as the Gmail search box. For example, + * // "from:someuser@example.com rfc822msgid: + * // is:unread". * q: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -1795,11 +1823,11 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.includeSpamTrash Include drafts from SPAM and TRASH in the results. + * @param {boolean=} params.includeSpamTrash Include drafts from SPAM and TRASH in the results. * @param {integer=} params.maxResults Maximum number of drafts to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.q Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string=} params.q Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1888,7 +1916,7 @@ export namespace gmail_v1 { /** * gmail.users.drafts.send - * @desc Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. + * @desc Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. * @example * // Before running the sample: * // - Enable the API at: @@ -1906,6 +1934,7 @@ export namespace gmail_v1 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://mail.google.com/', + * 'https://www.googleapis.com/auth/gmail.addons.current.action.compose', * 'https://www.googleapis.com/auth/gmail.compose', * 'https://www.googleapis.com/auth/gmail.modify', * ], @@ -1917,7 +1946,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.drafts.send({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -1958,7 +1988,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -2069,6 +2099,7 @@ export namespace gmail_v1 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://mail.google.com/', + * 'https://www.googleapis.com/auth/gmail.addons.current.action.compose', * 'https://www.googleapis.com/auth/gmail.compose', * 'https://www.googleapis.com/auth/gmail.modify', * ], @@ -2082,7 +2113,8 @@ export namespace gmail_v1 { * const res = await gmail.users.drafts.update({ * // The ID of the draft to update. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -2117,7 +2149,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the draft to update. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -2212,7 +2244,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Drafts$Create extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -2243,7 +2275,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -2257,14 +2289,14 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Drafts$List extends StandardParameters { /** - * Include drafts from SPAM and TRASH in the results. + * Include drafts from SPAM and TRASH in the results. */ includeSpamTrash?: boolean; /** @@ -2276,18 +2308,18 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". + * Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". */ q?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Drafts$Send extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -2318,7 +2350,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -2351,7 +2383,7 @@ export namespace gmail_v1 { /** * gmail.users.history.list - * @desc Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). + * @desc Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). * @example * // Before running the sample: * // - Enable the API at: @@ -2389,9 +2421,22 @@ export namespace gmail_v1 { * maxResults: 'placeholder-value', * // Page token to retrieve a specific page of results in the list. * pageToken: 'placeholder-value', - * // Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. + * // Required. Returns history records after the specified + * // startHistoryId. The supplied startHistoryId + * // should be obtained from the historyId of a message, thread, or + * // previous list response. History IDs increase + * // chronologically but are not contiguous with random gaps in between valid + * // IDs. Supplying an invalid or out of date startHistoryId + * // typically returns an HTTP 404 error code. A + * // historyId is typically valid for at least a week, but in some + * // rare circumstances may be valid for only a few hours. If you receive an + * // HTTP 404 error response, your application should perform a + * // full sync. If you receive no nextPageToken in the response, + * // there are no updates to retrieve and you can store the returned + * // historyId for a future request. * startHistoryId: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -2417,8 +2462,8 @@ export namespace gmail_v1 { * @param {string=} params.labelId Only return messages with a label matching the ID. * @param {integer=} params.maxResults The maximum number of history records to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.startHistoryId Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string=} params.startHistoryId Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2525,11 +2570,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. + * Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. */ startHistoryId?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -2571,7 +2616,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.labels.create({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -2617,7 +2663,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().Label} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2735,7 +2781,8 @@ export namespace gmail_v1 { * const res = await gmail.users.labels.delete({ * // The ID of the label to delete. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -2751,7 +2798,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the label to delete. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2868,7 +2915,8 @@ export namespace gmail_v1 { * const res = await gmail.users.labels.get({ * // The ID of the label to retrieve. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -2898,7 +2946,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the label to retrieve. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3014,7 +3062,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.labels.list({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -3034,7 +3083,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3123,7 +3172,7 @@ export namespace gmail_v1 { /** * gmail.users.labels.patch - * @desc Updates the specified label. This method supports patch semantics. + * @desc Patch the specified label. * @example * // Before running the sample: * // - Enable the API at: @@ -3154,7 +3203,8 @@ export namespace gmail_v1 { * const res = await gmail.users.labels.patch({ * // The ID of the label to update. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -3201,7 +3251,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the label to update. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().Label} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3319,7 +3369,8 @@ export namespace gmail_v1 { * const res = await gmail.users.labels.update({ * // The ID of the label to update. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -3366,7 +3417,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the label to update. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().Label} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3455,7 +3506,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Labels$Create extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3471,7 +3522,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3481,14 +3532,14 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Labels$List extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3499,7 +3550,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3515,7 +3566,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3535,7 +3586,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.batchDelete - * @desc Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. + * @desc Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. * @example * // Before running the sample: * // - Enable the API at: @@ -3560,7 +3611,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.batchDelete({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -3583,7 +3635,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().BatchDeleteMessagesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3695,7 +3747,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.batchModify({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -3720,7 +3773,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().BatchModifyMessagesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3804,7 +3857,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.delete - * @desc Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead. + * @desc Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead. * @example * // Before running the sample: * // - Enable the API at: @@ -3831,7 +3884,8 @@ export namespace gmail_v1 { * const res = await gmail.users.messages.delete({ * // The ID of the message to delete. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -3847,7 +3901,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the message to delete. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3970,7 +4024,8 @@ export namespace gmail_v1 { * id: 'placeholder-value', * // When given and format is METADATA, only include headers specified. * metadataHeaders: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -4001,7 +4056,7 @@ export namespace gmail_v1 { * @param {string=} params.format The format to return the message in. * @param {string} params.id The ID of the message to retrieve. * @param {string=} params.metadataHeaders When given and format is METADATA, only include headers specified. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4116,15 +4171,21 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.import({ - * // Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * // Mark the email as permanently deleted (not TRASH) and + * // only visible in + * // Google Vault to + * // a Vault administrator. Only used for G Suite accounts. * deleted: 'placeholder-value', * // Source for Gmail's internal date of the message. * internalDateSource: 'placeholder-value', - * // Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox. + * // Ignore the Gmail spam classifier decision and never mark + * // this email as SPAM in the mailbox. * neverMarkSpam: 'placeholder-value', - * // Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user. + * // Process calendar invites in the email and add any extracted + * // meetings to the Google Calendar for this user. * processForCalendar: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -4172,11 +4233,11 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. * @param {string=} params.internalDateSource Source for Gmail's internal date of the message. * @param {boolean=} params.neverMarkSpam Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox. * @param {boolean=} params.processForCalendar Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -4269,7 +4330,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.insert - * @desc Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. + * @desc Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. * @example * // Before running the sample: * // - Enable the API at: @@ -4298,11 +4359,15 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.insert({ - * // Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * // Mark the email as permanently deleted (not TRASH) and + * // only visible in + * // Google Vault to + * // a Vault administrator. Only used for G Suite accounts. * deleted: 'placeholder-value', * // Source for Gmail's internal date of the message. * internalDateSource: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -4350,9 +4415,9 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. * @param {string=} params.internalDateSource Source for Gmail's internal date of the message. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -4475,7 +4540,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.list({ - * // Include messages from SPAM and TRASH in the results. + * // Include messages from SPAM and TRASH + * // in the results. * includeSpamTrash: 'placeholder-value', * // Only return messages with labels that match all of the specified label IDs. * labelIds: 'placeholder-value', @@ -4483,9 +4549,14 @@ export namespace gmail_v1 { * maxResults: 'placeholder-value', * // Page token to retrieve a specific page of results in the list. * pageToken: 'placeholder-value', - * // 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". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * // Only return messages matching the specified query. Supports the same + * // query format as the Gmail search box. For example, + * // "from:someuser@example.com rfc822msgid:<somemsgid@example.com> + * // is:unread". Parameter cannot be used when accessing the api + * // using the gmail.metadata scope. * q: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -4507,12 +4578,12 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.includeSpamTrash Include messages from SPAM and TRASH in the results. + * @param {boolean=} params.includeSpamTrash Include messages from SPAM and TRASH in the results. * @param {string=} params.labelIds Only return messages with labels that match all of the specified label IDs. * @param {integer=} params.maxResults Maximum number of messages to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.q 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". Parameter cannot be used when accessing the api using the gmail.metadata scope. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string=} params.q Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4633,7 +4704,8 @@ export namespace gmail_v1 { * const res = await gmail.users.messages.modify({ * // The ID of the message to modify. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -4671,7 +4743,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the message to modify. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().ModifyMessageRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4757,7 +4829,7 @@ export namespace gmail_v1 { /** * gmail.users.messages.send - * @desc Sends the specified message to the recipients in the To, Cc, and Bcc headers. + * @desc Sends the specified message to the recipients in the To, Cc, and Bcc headers. * @example * // Before running the sample: * // - Enable the API at: @@ -4788,7 +4860,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.messages.send({ - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -4836,7 +4909,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -4959,7 +5032,8 @@ export namespace gmail_v1 { * const res = await gmail.users.messages.trash({ * // The ID of the message to Trash. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -4988,7 +5062,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the message to Trash. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5103,7 +5177,8 @@ export namespace gmail_v1 { * const res = await gmail.users.messages.untrash({ * // The ID of the message to remove from Trash. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5132,7 +5207,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the message to remove from Trash. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5219,7 +5294,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Messages$Batchdelete extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -5231,7 +5306,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Messages$Batchmodify extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -5247,7 +5322,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -5266,14 +5341,14 @@ export namespace gmail_v1 { */ metadataHeaders?: string[]; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Messages$Import extends StandardParameters { /** - * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. */ deleted?: boolean; /** @@ -5289,7 +5364,7 @@ export namespace gmail_v1 { */ processForCalendar?: boolean; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -5316,7 +5391,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Messages$Insert extends StandardParameters { /** - * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. */ deleted?: boolean; /** @@ -5324,7 +5399,7 @@ export namespace gmail_v1 { */ internalDateSource?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -5351,7 +5426,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Messages$List extends StandardParameters { /** - * Include messages from SPAM and TRASH in the results. + * Include messages from SPAM and TRASH in the results. */ includeSpamTrash?: boolean; /** @@ -5367,11 +5442,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * 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". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. */ q?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -5382,7 +5457,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -5394,7 +5469,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Messages$Send extends StandardParameters { /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -5425,7 +5500,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -5436,7 +5511,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -5484,7 +5559,8 @@ export namespace gmail_v1 { * id: 'placeholder-value', * // The ID of the message containing the attachment. * messageId: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5508,7 +5584,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string} params.id The ID of the attachment. * @param {string} params.messageId The ID of the message containing the attachment. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5604,7 +5680,7 @@ export namespace gmail_v1 { */ messageId?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -5657,7 +5733,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getAutoForwarding({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5679,7 +5756,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5796,7 +5873,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getImap({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5819,7 +5897,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5935,7 +6013,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getLanguage({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5955,7 +6034,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6070,7 +6149,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getPop({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -6091,7 +6171,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6207,7 +6287,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.getVacation({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -6234,7 +6315,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6319,7 +6400,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.updateAutoForwarding - * @desc Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -6344,7 +6425,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updateAutoForwarding({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -6376,7 +6458,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().AutoForwarding} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6489,7 +6571,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updateImap({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -6523,7 +6606,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().ImapSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6610,7 +6693,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.updateLanguage - * @desc Updates language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. + * @desc Updates language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. * @example * // Before running the sample: * // - Enable the API at: @@ -6635,7 +6718,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updateLanguage({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -6663,7 +6747,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().LanguageSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6776,7 +6860,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updatePop({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -6806,7 +6891,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().PopSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6918,7 +7003,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.updateVacation({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -6960,7 +7046,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().VacationSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7050,42 +7136,42 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Getautoforwarding extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Getimap extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Getlanguage extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Getpop extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Getvacation extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Updateautoforwarding extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7097,7 +7183,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Updateimap extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7109,7 +7195,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Updatelanguage extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7121,7 +7207,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Updatepop extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7133,7 +7219,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Updatevacation extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7151,7 +7237,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.create - * @desc Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -7176,7 +7262,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.delegates.create({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -7206,7 +7293,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().Delegate} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7319,7 +7406,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.delegates.delete({ * // The email address of the user to be removed as a delegate. * delegateEmail: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -7335,7 +7423,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.delegateEmail The email address of the user to be removed as a delegate. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7449,9 +7537,11 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.delegates.get({ - * // The email address of the user whose delegate relationship is to be retrieved. + * // The email address of the user whose delegate relationship is to be + * // retrieved. * delegateEmail: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -7473,7 +7563,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.delegateEmail The email address of the user whose delegate relationship is to be retrieved. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7589,7 +7679,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.delegates.list({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -7609,7 +7700,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7701,7 +7792,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Delegates$Create extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -7717,7 +7808,7 @@ export namespace gmail_v1 { */ delegateEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -7728,14 +7819,14 @@ export namespace gmail_v1 { */ delegateEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Delegates$List extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -7773,7 +7864,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.filters.create({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -7918,7 +8010,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.filters.delete({ * // The ID of the filter to be deleted. * id: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8049,7 +8142,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.filters.get({ * // The ID of the filter to be fetched. * id: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8187,7 +8281,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.filters.list({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8344,7 +8439,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.forwardingAddresses.create - * @desc Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -8369,7 +8464,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.forwardingAddresses.create({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -8399,7 +8495,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().ForwardingAddress} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8515,7 +8611,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.forwardingAddresses.delete({ * // The forwarding address to be deleted. * forwardingEmail: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8531,7 +8628,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.forwardingEmail The forwarding address to be deleted. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8647,7 +8744,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.forwardingAddresses.get({ * // The forwarding address to be retrieved. * forwardingEmail: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8669,7 +8767,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.forwardingEmail The forwarding address to be retrieved. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8788,7 +8886,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.forwardingAddresses.list({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -8808,7 +8907,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8904,7 +9003,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Forwardingaddresses$Create extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -8920,7 +9019,7 @@ export namespace gmail_v1 { */ forwardingEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -8931,14 +9030,14 @@ export namespace gmail_v1 { */ forwardingEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Forwardingaddresses$List extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -8955,7 +9054,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.create - * @desc Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -8980,7 +9079,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.sendAs.create({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -9024,7 +9124,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().SendAs} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9111,7 +9211,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.delete - * @desc Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -9138,7 +9238,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.delete({ * // The send-as alias to be deleted. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9154,7 +9255,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be deleted. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9237,7 +9338,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.get - * @desc Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. + * @desc Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. * @example * // Before running the sample: * // - Enable the API at: @@ -9269,7 +9370,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.get({ * // The send-as alias to be retrieved. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9298,7 +9400,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be retrieved. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9383,7 +9485,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.list - * @desc 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. + * @desc 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. * @example * // Before running the sample: * // - Enable the API at: @@ -9413,7 +9515,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.sendAs.list({ - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9433,7 +9536,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9522,7 +9625,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.patch - * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics. + * @desc Patch the specified send-as alias. * @example * // Before running the sample: * // - Enable the API at: @@ -9552,7 +9655,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.patch({ * // The send-as alias to be updated. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -9597,7 +9701,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be updated. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().SendAs} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9683,7 +9787,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.update - * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. + * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -9713,7 +9817,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.update({ * // The send-as alias to be updated. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -9758,7 +9863,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be updated. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().SendAs} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9844,7 +9949,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.verify - * @desc Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority. * @example * // Before running the sample: * // - Enable the API at: @@ -9871,7 +9976,8 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.verify({ * // The send-as alias to be verified. * sendAsEmail: 'placeholder-value', - * // User's email address. The special value "me" can be used to indicate the authenticated user. + * // User's email address. The special value "me" + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9887,7 +9993,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be verified. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9973,7 +10079,7 @@ export namespace gmail_v1 { export interface Params$Resource$Users$Settings$Sendas$Create extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -9989,7 +10095,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -10000,14 +10106,14 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Settings$Sendas$List extends StandardParameters { /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -10018,7 +10124,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -10034,7 +10140,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -10050,7 +10156,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -10093,9 +10199,11 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.smimeInfo.delete({ * // The immutable ID for the SmimeInfo. * id: 'placeholder-value', - * // The email address that appears in the "From:" header for mail sent using this alias. + * // The email address that appears in the "From:" header for mail sent using + * // this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -10112,7 +10220,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string} params.id The immutable ID for the SmimeInfo. * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10229,9 +10337,11 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.smimeInfo.get({ * // The immutable ID for the SmimeInfo. * id: 'placeholder-value', - * // The email address that appears in the "From:" header for mail sent using this alias. + * // The email address that appears in the "From:" header for mail sent using + * // this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -10259,7 +10369,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string} params.id The immutable ID for the SmimeInfo. * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10373,9 +10483,11 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.sendAs.smimeInfo.insert({ - * // The email address that appears in the "From:" header for mail sent using this alias. + * // The email address that appears in the "From:" header for mail sent using + * // this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -10416,7 +10528,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().SmimeInfo} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10534,9 +10646,11 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.settings.sendAs.smimeInfo.list({ - * // The email address that appears in the "From:" header for mail sent using this alias. + * // The email address that appears in the "From:" header for mail sent using + * // this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -10557,7 +10671,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10678,9 +10792,11 @@ export namespace gmail_v1 { * const res = await gmail.users.settings.sendAs.smimeInfo.setDefault({ * // The immutable ID for the SmimeInfo. * id: 'placeholder-value', - * // The email address that appears in the "From:" header for mail sent using this alias. + * // The email address that appears in the "From:" header for mail sent using + * // this alias. * sendAsEmail: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -10697,7 +10813,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string} params.id The immutable ID for the SmimeInfo. * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10791,7 +10907,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -10806,7 +10922,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -10817,7 +10933,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -10833,7 +10949,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -10848,7 +10964,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -10861,7 +10977,7 @@ export namespace gmail_v1 { /** * gmail.users.threads.delete - * @desc Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead. + * @desc Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead. * @example * // Before running the sample: * // - Enable the API at: @@ -10888,7 +11004,8 @@ export namespace gmail_v1 { * const res = await gmail.users.threads.delete({ * // ID of the Thread to delete. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -10904,7 +11021,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id ID of the Thread to delete. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -11027,7 +11144,8 @@ export namespace gmail_v1 { * id: 'placeholder-value', * // When given and format is METADATA, only include headers specified. * metadataHeaders: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11053,7 +11171,7 @@ export namespace gmail_v1 { * @param {string=} params.format The format to return the messages in. * @param {string} params.id The ID of the thread to retrieve. * @param {string=} params.metadataHeaders When given and format is METADATA, only include headers specified. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -11169,7 +11287,8 @@ export namespace gmail_v1 { * * // Do the magic * const res = await gmail.users.threads.list({ - * // Include threads from SPAM and TRASH in the results. + * // Include threads from SPAM and TRASH + * // in the results. * includeSpamTrash: 'placeholder-value', * // Only return threads with labels that match all of the specified label IDs. * labelIds: 'placeholder-value', @@ -11177,9 +11296,14 @@ export namespace gmail_v1 { * maxResults: 'placeholder-value', * // Page token to retrieve a specific page of results in the list. * pageToken: 'placeholder-value', - * // 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". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * // 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". Parameter cannot be used when accessing the api + * // using the gmail.metadata scope. * q: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11201,12 +11325,12 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.includeSpamTrash Include threads from SPAM and TRASH in the results. + * @param {boolean=} params.includeSpamTrash Include threads from SPAM and TRASH in the results. * @param {string=} params.labelIds Only return threads with labels that match all of the specified label IDs. * @param {integer=} params.maxResults Maximum number of threads to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.q 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". Parameter cannot be used when accessing the api using the gmail.metadata scope. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string=} params.q 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". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -11325,7 +11449,8 @@ export namespace gmail_v1 { * const res = await gmail.users.threads.modify({ * // The ID of the thread to modify. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * * // Request body metadata @@ -11358,7 +11483,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the thread to modify. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().ModifyThreadRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -11474,7 +11599,8 @@ export namespace gmail_v1 { * const res = await gmail.users.threads.trash({ * // The ID of the thread to Trash. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11498,7 +11624,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the thread to Trash. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -11613,7 +11739,8 @@ export namespace gmail_v1 { * const res = await gmail.users.threads.untrash({ * // The ID of the thread to remove from Trash. * id: 'placeholder-value', - * // The user's email address. The special value me can be used to indicate the authenticated user. + * // The user's email address. The special value me + * // can be used to indicate the authenticated user. * userId: 'placeholder-value', * }); * console.log(res.data); @@ -11637,7 +11764,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the thread to remove from Trash. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -11728,7 +11855,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -11747,14 +11874,14 @@ export namespace gmail_v1 { */ metadataHeaders?: string[]; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } export interface Params$Resource$Users$Threads$List extends StandardParameters { /** - * Include threads from SPAM and TRASH in the results. + * Include threads from SPAM and TRASH in the results. */ includeSpamTrash?: boolean; /** @@ -11770,11 +11897,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * 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". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * 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". Parameter cannot be used when accessing the api using the gmail.metadata scope. */ q?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -11785,7 +11912,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -11801,7 +11928,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -11812,7 +11939,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; }