@datafire/google_gmail

DataFire integration for Gmail API

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@datafire/google_gmail
133316.0.03 years ago7 years agoMinified + gzip package size for @datafire/google_gmail in KB

Popular Searches

Readme

@datafire/googlegmail
Client library for Gmail API

Installation and Usage

npm install --save @datafire/google_gmail
let google_gmail = require('@datafire/google_gmail').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an accesstoken
google_gmail.oauthCallback({
  "code": ""
}, context)

Input

  • input object
code required string

Output

  • output object
 accesstoken string refreshtoken string tokentype string scope string expiration string

oauthRefresh

Exchange a refreshtoken for an accesstoken
google_gmail.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
accesstoken string refreshtoken string tokentype string scope string expiration string

gmail.users.drafts.list

Lists the drafts in the user's mailbox.
google_gmail.gmail.users.drafts.list({
  "userId": ""
}, context)

Input

  • input object
userId required string: The user's email address. The special value me can be used to indicate the authenticated user. includeSpamTrash boolean: Include drafts from SPAM and TRASH in the results. maxResults integer: Maximum number of drafts to return. pageToken string: Page token to retrieve a specific page of results in the list. q 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". $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.drafts.create

Creates a new draft with the DRAFT label.
google_gmail.gmail.users.drafts.create({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. body Draft $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.drafts.send

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.
google_gmail.gmail.users.drafts.send({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. body Draft $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.drafts.delete

Immediately and permanently deletes the specified draft. Does not simply trash it.
google_gmail.gmail.users.drafts.delete({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the draft to delete. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Output schema unknown

gmail.users.drafts.get

Gets the specified draft.
google_gmail.gmail.users.drafts.get({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the draft to retrieve. format string (values: minimal, full, raw, metadata): The format to return the draft in. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.drafts.update

Replaces a draft's content.
google_gmail.gmail.users.drafts.update({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the draft to update. body Draft $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.history.list

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).
google_gmail.gmail.users.history.list({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. historyTypes array: History types to be returned by the function labelId string: Only return messages with a label matching the ID. maxResults integer: The maximum number of history records to return. pageToken string: Page token to retrieve a specific page of results in the list. startHistoryId 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. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.labels.list

Lists all labels in the user's mailbox.
google_gmail.gmail.users.labels.list({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.labels.create

Creates a new label.
google_gmail.gmail.users.labels.create({
  "userId": ""
}, context)

Input

  • input object
userId required string: The user's email address. The special value me can be used to indicate the authenticated user. body Label $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.labels.delete

Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.
google_gmail.gmail.users.labels.delete({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the label to delete. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Output schema unknown

gmail.users.labels.get

Gets the specified label.
google_gmail.gmail.users.labels.get({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the label to retrieve. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.labels.patch

Patch the specified label.
google_gmail.gmail.users.labels.patch({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the label to update. body Label $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.labels.update

Updates the specified label.
google_gmail.gmail.users.labels.update({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the label to update. body Label $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.messages.list

Lists the messages in the user's mailbox.
google_gmail.gmail.users.messages.list({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. includeSpamTrash boolean: Include messages from SPAM and TRASH in the results. labelIds array: Only return messages with labels that match all of the specified label IDs. maxResults integer: Maximum number of messages to return. pageToken string: Page token to retrieve a specific page of results in the list. q 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. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.messages.insert

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.
google_gmail.gmail.users.messages.insert({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. deleted boolean: Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. internalDateSource string (values: receivedTime, dateHeader): Source for Gmail's internal date of the message. body Message $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.messages.batchDelete

Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.
google_gmail.gmail.users.messages.batchDelete({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. body BatchDeleteMessagesRequest $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Output schema unknown

gmail.users.messages.batchModify

Modifies the labels on the specified messages.
google_gmail.gmail.users.messages.batchModify({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. body BatchModifyMessagesRequest $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Output schema unknown

gmail.users.messages.import

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. Note: This function doesn't trigger forwarding rules or filters set up by the user.
google_gmail.gmail.users.messages.import({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. deleted boolean: Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. internalDateSource string (values: receivedTime, dateHeader): Source for Gmail's internal date of the message. neverMarkSpam boolean: Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox. processForCalendar boolean: Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user. body Message $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.messages.send

Sends the specified message to the recipients in the To, Cc, and Bcc headers.
google_gmail.gmail.users.messages.send({
  "userId": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. body Message $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.messages.delete

Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead.
google_gmail.gmail.users.messages.delete({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the message to delete. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Output schema unknown

gmail.users.messages.get

Gets the specified message.
google_gmail.gmail.users.messages.get({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the message to retrieve. format string (values: minimal, full, raw, metadata): The format to return the message in. metadataHeaders array: When given and format is METADATA, only include headers specified. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.messages.modify

Modifies the labels on the specified message.
google_gmail.gmail.users.messages.modify({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the message to modify. body ModifyMessageRequest $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.messages.trash

Moves the specified message to the trash.
google_gmail.gmail.users.messages.trash({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the message to Trash. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.messages.untrash

Removes the specified message from the trash.
google_gmail.gmail.users.messages.untrash({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. id required string: The ID of the message to remove from Trash. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.messages.attachments.get

Gets the specified message attachment.
google_gmail.gmail.users.messages.attachments.get({
  "userId": "",
  "messageId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: The user's email address. The special value me can be used to indicate the authenticated user. messageId required string: The ID of the message containing the attachment. id required string: The ID of the attachment. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.getProfile

Gets the current user's Gmail profile.
google_gmail.gmail.users.getProfile({
  "userId": ""
}, context)

Input

  • input object
userId required string: The user's email address. The special value me can be used to indicate the authenticated user. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.getAutoForwarding

Gets the auto-forwarding setting for the specified account.
google_gmail.gmail.users.settings.getAutoForwarding({
  "userId": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.updateAutoForwarding

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.
google_gmail.gmail.users.settings.updateAutoForwarding({
  "userId": ""
}, context)

Input

  • input object
userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. body AutoForwarding $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.delegates.list

Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.
google_gmail.gmail.users.settings.delegates.list({
  "userId": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.delegates.create

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.
google_gmail.gmail.users.settings.delegates.create({
  "userId": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. body Delegate $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.delegates.delete

Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.
google_gmail.gmail.users.settings.delegates.delete({
  "userId": "",
  "delegateEmail": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. delegateEmail required string: The email address of the user to be removed as a delegate. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Output schema unknown

gmail.users.settings.delegates.get

Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.
google_gmail.gmail.users.settings.delegates.get({
  "userId": "",
  "delegateEmail": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. delegateEmail required string: The email address of the user whose delegate relationship is to be retrieved. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.filters.list

Lists the message filters of a Gmail user.
google_gmail.gmail.users.settings.filters.list({
  "userId": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.filters.create

Creates a filter. Note: you can only create a maximum of 1,000 filters.
google_gmail.gmail.users.settings.filters.create({
  "userId": ""
}, context)

Input

  • input object
userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. body Filter $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.filters.delete

Deletes a filter.
google_gmail.gmail.users.settings.filters.delete({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. id required string: The ID of the filter to be deleted. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Output schema unknown

gmail.users.settings.filters.get

Gets a filter.
google_gmail.gmail.users.settings.filters.get({
  "userId": "",
  "id": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. id required string: The ID of the filter to be fetched. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.forwardingAddresses.list

Lists the forwarding addresses for the specified account.
google_gmail.gmail.users.settings.forwardingAddresses.list({
  "userId": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.forwardingAddresses.create

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.
google_gmail.gmail.users.settings.forwardingAddresses.create({
  "userId": ""
}, context)

Input

  • input object
userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. body ForwardingAddress $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.forwardingAddresses.delete

Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority.
google_gmail.gmail.users.settings.forwardingAddresses.delete({
  "userId": "",
  "forwardingEmail": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. forwardingEmail required string: The forwarding address to be deleted. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Output schema unknown

gmail.users.settings.forwardingAddresses.get

Gets the specified forwarding address.
google_gmail.gmail.users.settings.forwardingAddresses.get({
  "userId": "",
  "forwardingEmail": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. forwardingEmail required string: The forwarding address to be retrieved. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.getImap

Gets IMAP settings.
google_gmail.gmail.users.settings.getImap({
  "userId": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.updateImap

Updates IMAP settings.
google_gmail.gmail.users.settings.updateImap({
  "userId": ""
}, context)

Input

  • input object
userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. body ImapSettings $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: 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. uploadprotocol string: Upload protocol for media (e.g. "raw", "multipart"). uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

gmail.users.settings.getLanguage

Gets language settings.
google_gmail.gmail.users.settings.getLanguage({
  "userId": ""
}, context)

Input

  • input object
 userId required string: User's email address. The special value "me" can be used to indicate the authenticated user. $.xgafv string (values: 1, 2): V1 error format. accesstoken string: OAuth access token. alt string (values: json, media, proto): Data format for response. callback string: JSONP fields string: Selector specifying which fields to include in a partial response. key 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. oauthtoken string: OAuth 2.0 token for the current user. prettyPrint boolean: Returns response with indentations and line breaks. quotaUser string: Availab