googleapis
Version:
Google APIs Client Library for Node.js
1,134 lines (1,133 loc) • 300 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace gmail_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Gmail API
*
* The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.
*
* @example
* ```js
* const {google} = require('googleapis');
* const gmail = google.gmail('v1');
* ```
*/
export class Gmail {
context: APIRequestContext;
users: Resource$Users;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Auto-forwarding settings for an account.
*/
export interface Schema$AutoForwarding {
/**
* The state that a message should be left in after it has been forwarded.
*/
disposition?: string | null;
/**
* Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
*/
emailAddress?: string | null;
/**
* Whether all incoming mail is automatically forwarded to another address.
*/
enabled?: boolean | null;
}
export interface Schema$BatchDeleteMessagesRequest {
/**
* The IDs of the messages to delete.
*/
ids?: string[] | null;
}
export interface Schema$BatchModifyMessagesRequest {
/**
* A list of label IDs to add to messages.
*/
addLabelIds?: string[] | null;
/**
* The IDs of the messages to modify. There is a limit of 1000 ids per request.
*/
ids?: string[] | null;
/**
* A list of label IDs to remove from messages.
*/
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.
*/
export interface Schema$Delegate {
/**
* The email address of the delegate.
*/
delegateEmail?: string | null;
/**
* Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
*/
verificationStatus?: string | null;
}
/**
* A draft email in the user's mailbox.
*/
export interface Schema$Draft {
/**
* The immutable ID of the draft.
*/
id?: string | null;
/**
* The message content of the draft.
*/
message?: Schema$Message;
}
/**
* Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
*/
export interface Schema$Filter {
/**
* Action that the filter performs.
*/
action?: Schema$FilterAction;
/**
* Matching criteria for the filter.
*/
criteria?: Schema$FilterCriteria;
/**
* The server assigned ID of the filter.
*/
id?: string | null;
}
/**
* A set of actions to perform on a message.
*/
export interface Schema$FilterAction {
/**
* List of labels to add to the message.
*/
addLabelIds?: string[] | null;
/**
* Email address that the message should be forwarded to.
*/
forward?: string | null;
/**
* List of labels to remove from the message.
*/
removeLabelIds?: string[] | null;
}
/**
* Message matching criteria.
*/
export interface Schema$FilterCriteria {
/**
* Whether the response should exclude chats.
*/
excludeChats?: boolean | null;
/**
* The sender's display name or email address.
*/
from?: string | null;
/**
* Whether the message has any attachment.
*/
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"`.
*/
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"`.
*/
query?: string | null;
/**
* The size of the entire RFC822 message in bytes, including all headers and attachments.
*/
size?: number | null;
/**
* How the message size in bytes should be in relation to the size field.
*/
sizeComparison?: string | null;
/**
* Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
*/
subject?: string | null;
/**
* 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.
*/
to?: string | null;
}
/**
* Settings for a forwarding address.
*/
export interface Schema$ForwardingAddress {
/**
* An email address to which messages can be forwarded.
*/
forwardingEmail?: string | null;
/**
* Indicates whether this address has been verified and is usable for forwarding. Read-only.
*/
verificationStatus?: string | null;
}
/**
* A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.
*/
export interface Schema$History {
/**
* The mailbox sequence ID.
*/
id?: string | null;
/**
* Labels added to messages in this history record.
*/
labelsAdded?: Schema$HistoryLabelAdded[];
/**
* Labels removed from messages in this history record.
*/
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.
*/
messages?: Schema$Message[];
/**
* Messages added to the mailbox in this history record.
*/
messagesAdded?: Schema$HistoryMessageAdded[];
/**
* Messages deleted (not Trashed) from the mailbox in this history record.
*/
messagesDeleted?: Schema$HistoryMessageDeleted[];
}
export interface Schema$HistoryLabelAdded {
/**
* Label IDs added to the message.
*/
labelIds?: string[] | null;
message?: Schema$Message;
}
export interface Schema$HistoryLabelRemoved {
/**
* Label IDs removed from the message.
*/
labelIds?: string[] | null;
message?: Schema$Message;
}
export interface Schema$HistoryMessageAdded {
message?: Schema$Message;
}
export interface Schema$HistoryMessageDeleted {
message?: Schema$Message;
}
/**
* IMAP settings for an account.
*/
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.
*/
autoExpunge?: boolean | null;
/**
* Whether IMAP is enabled for the account.
*/
enabled?: boolean | null;
/**
* The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
*/
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.
*/
maxFolderSize?: number | null;
}
/**
* Labels are used to categorize messages and threads within the user's mailbox.
*/
export interface Schema$Label {
/**
* The color to assign to the label. Color is only available for labels that have their `type` set to `user`.
*/
color?: Schema$LabelColor;
/**
* The immutable ID of the label.
*/
id?: string | null;
/**
* The visibility of the label in the label list in the Gmail web interface.
*/
labelListVisibility?: string | null;
/**
* The visibility of messages with this label in the message list in the Gmail web interface.
*/
messageListVisibility?: string | null;
/**
* The total number of messages with the label.
*/
messagesTotal?: number | null;
/**
* The number of unread messages with the label.
*/
messagesUnread?: number | null;
/**
* The display name of the label.
*/
name?: string | null;
/**
* The total number of threads with the label.
*/
threadsTotal?: number | null;
/**
* The number of unread threads with the label.
*/
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.
*/
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
*/
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
*/
textColor?: string | null;
}
/**
* Language settings for an account. These settings correspond to the "Language settings" 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).
*/
displayLanguage?: string | null;
}
/**
* Response for the ListDelegates method.
*/
export interface Schema$ListDelegatesResponse {
/**
* List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear.
*/
delegates?: Schema$Delegate[];
}
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.
*/
drafts?: Schema$Draft[];
/**
* Token to retrieve the next page of results in the list.
*/
nextPageToken?: string | null;
/**
* Estimated total number of results.
*/
resultSizeEstimate?: number | null;
}
/**
* Response for the ListFilters method.
*/
export interface Schema$ListFiltersResponse {
/**
* List of a user's filters.
*/
filter?: Schema$Filter[];
}
/**
* Response for the ListForwardingAddresses method.
*/
export interface Schema$ListForwardingAddressesResponse {
/**
* List of addresses that may be used for forwarding.
*/
forwardingAddresses?: Schema$ForwardingAddress[];
}
export interface Schema$ListHistoryResponse {
/**
* List of history records. Any `messages` contained in the response will typically only have `id` and `threadId` fields populated.
*/
history?: Schema$History[];
/**
* The ID of the mailbox's current history record.
*/
historyId?: string | null;
/**
* Page token to retrieve the next page of results in the list.
*/
nextPageToken?: string | null;
}
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.
*/
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.
*/
messages?: Schema$Message[];
/**
* Token to retrieve the next page of results in the list.
*/
nextPageToken?: string | null;
/**
* Estimated total number of results.
*/
resultSizeEstimate?: number | null;
}
/**
* Response for the ListSendAs method.
*/
export interface Schema$ListSendAsResponse {
/**
* List of send-as aliases.
*/
sendAs?: Schema$SendAs[];
}
export interface Schema$ListSmimeInfoResponse {
/**
* List of SmimeInfo.
*/
smimeInfo?: Schema$SmimeInfo[];
}
export interface Schema$ListThreadsResponse {
/**
* Page token to retrieve the next page of results in the list.
*/
nextPageToken?: string | null;
/**
* Estimated total number of results.
*/
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.
*/
threads?: Schema$Thread[];
}
/**
* An email message.
*/
export interface Schema$Message {
/**
* The ID of the last history record that modified this message.
*/
historyId?: string | null;
/**
* The immutable ID of the message.
*/
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.
*/
internalDate?: string | null;
/**
* List of IDs of labels applied to this message.
*/
labelIds?: string[] | null;
/**
* The parsed email structure in the message parts.
*/
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.
*/
raw?: string | null;
/**
* Estimated size in bytes of the message.
*/
sizeEstimate?: number | null;
/**
* A short part of the message text.
*/
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: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
*/
threadId?: string | null;
}
/**
* A single MIME message part.
*/
export interface Schema$MessagePart {
/**
* The message part body for this part, which may be empty for container MIME message parts.
*/
body?: Schema$MessagePartBody;
/**
* The filename of the attachment. Only present if this message part represents an attachment.
*/
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`.
*/
headers?: Schema$MessagePartHeader[];
/**
* The MIME type of the message part.
*/
mimeType?: string | null;
/**
* The immutable ID of the message part.
*/
partId?: string | null;
/**
* The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/x`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
*/
parts?: Schema$MessagePart[];
}
/**
* The body of a single MIME message part.
*/
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.
*/
attachmentId?: string | null;
/**
* 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.
*/
data?: string | null;
/**
* Number of bytes for the message part data (encoding notwithstanding).
*/
size?: number | null;
}
export interface Schema$MessagePartHeader {
/**
* The name of the header before the `:` separator. For example, `To`.
*/
name?: string | null;
/**
* The value of the header after the `:` separator. For example, `someuser@example.com`.
*/
value?: string | null;
}
export interface Schema$ModifyMessageRequest {
/**
* A list of IDs of labels to add to this message.
*/
addLabelIds?: string[] | null;
/**
* A list IDs of labels to remove from this message.
*/
removeLabelIds?: string[] | null;
}
export interface Schema$ModifyThreadRequest {
/**
* A list of IDs of labels to add to this thread.
*/
addLabelIds?: string[] | null;
/**
* A list of IDs of labels to remove from this thread.
*/
removeLabelIds?: string[] | null;
}
/**
* POP settings for an account.
*/
export interface Schema$PopSettings {
/**
* The range of messages which are accessible via POP.
*/
accessWindow?: string | null;
/**
* The action that will be executed on a message after it has been fetched via POP.
*/
disposition?: string | null;
}
/**
* Profile for a Gmail user.
*/
export interface Schema$Profile {
/**
* The user's email address.
*/
emailAddress?: string | null;
/**
* The ID of the mailbox's current history record.
*/
historyId?: string | null;
/**
* The total number of messages in the mailbox.
*/
messagesTotal?: number | null;
/**
* The total number of threads in the mailbox.
*/
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.
*/
export interface Schema$SendAs {
/**
* 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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
sendAsEmail?: string | null;
/**
* An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
*/
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.
*/
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.
*/
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.
*/
verificationStatus?: string | null;
}
/**
* An S/MIME email config.
*/
export interface Schema$SmimeInfo {
/**
* Encrypted key password, when key is encrypted.
*/
encryptedKeyPassword?: string | null;
/**
* When the certificate expires (in milliseconds since epoch).
*/
expiration?: string | null;
/**
* The immutable ID for the SmimeInfo.
*/
id?: string | null;
/**
* Whether this SmimeInfo is the default one for this user's send-as address.
*/
isDefault?: boolean | null;
/**
* The S/MIME certificate issuer's common name.
*/
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?: 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.
*/
pkcs12?: string | null;
}
/**
* Configuration for communication with an SMTP service.
*/
export interface Schema$SmtpMsa {
/**
* The hostname of the SMTP service. Required.
*/
host?: string | null;
/**
* 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.
*/
password?: string | null;
/**
* The port of the SMTP service. Required.
*/
port?: number | null;
/**
* The protocol that will be used to secure communication with the SMTP service. Required.
*/
securityMode?: string | null;
/**
* 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.
*/
username?: string | null;
}
/**
* A collection of messages representing a conversation.
*/
export interface Schema$Thread {
/**
* The ID of the last history record that modified this thread.
*/
historyId?: string | null;
/**
* The unique ID of the thread.
*/
id?: string | null;
/**
* The list of messages in the thread.
*/
messages?: Schema$Message[];
/**
* A short part of the message text.
*/
snippet?: string | null;
}
/**
* Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface.
*/
export interface Schema$VacationSettings {
/**
* Flag that controls whether Gmail automatically replies to messages.
*/
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`.
*/
endTime?: string | null;
/**
* Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
*/
responseBodyHtml?: string | null;
/**
* Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` 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.
*/
responseSubject?: string | null;
/**
* Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
*/
restrictToContacts?: boolean | null;
/**
* 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.
*/
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`.
*/
startTime?: string | null;
}
/**
* Set up or update a new push notification watch on this user's mailbox.
*/
export interface Schema$WatchRequest {
/**
* Filtering behavior of labelIds list specified.
*/
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.
*/
labelIds?: string[] | null;
/**
* 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). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).
*/
topicName?: string | null;
}
/**
* Push notification watch response.
*/
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.
*/
expiration?: string | null;
/**
* The ID of the mailbox's current history record.
*/
historyId?: string | null;
}
export class Resource$Users {
context: APIRequestContext;
drafts: Resource$Users$Drafts;
history: Resource$Users$History;
labels: Resource$Users$Labels;
messages: Resource$Users$Messages;
settings: Resource$Users$Settings;
threads: Resource$Users$Threads;
constructor(context: APIRequestContext);
/**
* Gets the current user's Gmail profile.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/gmail.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const gmail = google.gmail('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // 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.compose',
* 'https://www.googleapis.com/auth/gmail.metadata',
* 'https://www.googleapis.com/auth/gmail.modify',
* 'https://www.googleapis.com/auth/gmail.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // 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.
* userId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "emailAddress": "my_emailAddress",
* // "historyId": "my_historyId",
* // "messagesTotal": 0,
* // "threadsTotal": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getProfile(params: Params$Resource$Users$Getprofile, options: StreamMethodOptions): GaxiosPromise<Readable>;
getProfile(params?: Params$Resource$Users$Getprofile, options?: MethodOptions): GaxiosPromise<Schema$Profile>;
getProfile(params: Params$Resource$Users$Getprofile, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getProfile(params: Params$Resource$Users$Getprofile, options: MethodOptions | BodyResponseCallback<Schema$Profile>, callback: BodyResponseCallback<Schema$Profile>): void;
getProfile(params: Params$Resource$Users$Getprofile, callback: BodyResponseCallback<Schema$Profile>): void;
getProfile(callback: BodyResponseCallback<Schema$Profile>): void;
/**
* Stop receiving push notifications for the given user mailbox.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/gmail.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const gmail = google.gmail('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // 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.metadata',
* 'https://www.googleapis.com/auth/gmail.modify',
* 'https://www.googleapis.com/auth/gmail.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // 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.
* userId: 'placeholder-value',
* });
* console.log(res.data);
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
stop(params: Params$Resource$Users$Stop, options: StreamMethodOptions): GaxiosPromise<Readable>;
stop(params?: Params$Resource$Users$Stop, options?: MethodOptions): GaxiosPromise<void>;
stop(params: Params$Resource$Users$Stop, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
stop(params: Params$Resource$Users$Stop, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
stop(params: Params$Resource$Users$Stop, callback: BodyResponseCallback<void>): void;
stop(callback: BodyResponseCallback<void>): void;
/**
* Set up or update a push notification watch on the given user mailbox.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/gmail.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const gmail = google.gmail('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // 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.metadata',
* 'https://www.googleapis.com/auth/gmail.modify',
* 'https://www.googleapis.com/auth/gmail.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // 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.
* userId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "labelFilterAction": "my_labelFilterAction",
* // "labelIds": [],
* // "topicName": "my_topicName"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "expiration": "my_expiration",
* // "historyId": "my_historyId"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
watch(params: Params$Resource$Users$Watch, options: StreamMethodOptions): GaxiosPromise<Readable>;
watch(params?: Params$Resource$Users$Watch, options?: MethodOptions): GaxiosPromise<Schema$WatchResponse>;
watch(params: Params$Resource$Users$Watch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
watch(params: Params$Resource$Users$Watch, options: MethodOptions | BodyResponseCallback<Schema$WatchResponse>, callback: BodyResponseCallback<Schema$WatchResponse>): void;
watch(params: Params$Resource$Users$Watch, callback: BodyResponseCallback<Schema$WatchResponse>): void;
watch(callback: BodyResponseCallback<Schema$WatchResponse>): void;
}
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.
*/
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.
*/
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.
*/
userId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WatchRequest;
}
export class Resource$Users$Drafts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new draft with the `DRAFT` label.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/gmail.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const gmail = google.gmail('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // 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',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // 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.
* userId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "id": "my_id",
* // "message": {}
* // }
* },
* media: {
* mimeType: 'placeholder-value',
* body: 'placeholder-value',
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "id": "my_id",
* // "message": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Users$Drafts$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Users$Drafts$Create, options?: MethodOptions): GaxiosPromise<Schema$Draft>;
create(params: Params$Resource$Users$Drafts$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Users$Drafts$Create, options: MethodOptions | BodyResponseCallback<Schema$Draft>, callback: BodyResponseCallback<Schema$Draft>): void;
create(params: Params$Resource$Users$Drafts$Create, callback: BodyResponseCallback<Schema$Draft>): void;
create(callback: BodyResponseCallback<Schema$Draft>): void;
/**
* Immediately and permanently deletes the specified draft. Does not simply trash it.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/gmail.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const gmail = google.gmail('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // 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',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*