API Reference google_api_gmail v0.17.0

View Source

Modules

API client metadata for GoogleApi.Gmail.V1.

API calls for all endpoints tagged Users.

Handle Tesla connections for GoogleApi.Gmail.V1.

Auto-forwarding settings for an account.

Attributes

  • ids (type: list(String.t), default: nil) - The IDs of the messages to delete.

Attributes

  • addLabelIds (type: list(String.t), default: nil) - A list of label IDs to add to messages.
  • ids (type: list(String.t), default: nil) - The IDs of the messages to modify. There is a limit of 1000 ids per request.
  • removeLabelIds (type: list(String.t), default: nil) - A list of label IDs to remove from messages.

The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.

A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.

Metadata for a private key instance.

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.

Requests to turn off a client-side encryption key pair.

A draft email in the user's mailbox.

Requests to turn on a client-side encryption key pair.

Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.

A set of actions to perform on a message.

Message matching criteria.

Settings for a forwarding address.

Metadata for hardware keys.

A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.

Attributes

  • labelIds (type: list(String.t), default: nil) - Label IDs added to the message.
  • message (type: GoogleApi.Gmail.V1.Model.Message.t, default: nil) -

Attributes

  • labelIds (type: list(String.t), default: nil) - Label IDs removed from the message.
  • message (type: GoogleApi.Gmail.V1.Model.Message.t, default: nil) -

Attributes

  • message (type: GoogleApi.Gmail.V1.Model.Message.t, default: nil) -

Attributes

  • message (type: GoogleApi.Gmail.V1.Model.Message.t, default: nil) -

IMAP settings for an account.

Metadata for private keys managed by an external key access control list service. For details about managing key access, see Google Workspace CSE API Reference.

Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000.

Attributes

  • backgroundColor (type: String.t, default: nil) - 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
  • textColor (type: String.t, default: nil) - 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

Language settings for an account. These settings correspond to the "Language settings" feature in the web interface.

Attributes

  • cseIdentities (type: list(GoogleApi.Gmail.V1.Model.CseIdentity.t), default: nil) - One page of the list of CSE identities configured for the user.
  • nextPageToken (type: String.t, default: nil) - Pagination token to be passed to a subsequent ListCseIdentities call in order to retrieve the next page of identities. If this value is not returned or is the empty string, then no further pages remain.

Attributes

  • cseKeyPairs (type: list(GoogleApi.Gmail.V1.Model.CseKeyPair.t), default: nil) - One page of the list of CSE key pairs installed for the user.
  • nextPageToken (type: String.t, default: nil) - Pagination token to be passed to a subsequent ListCseKeyPairs call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain.

Response for the ListDelegates method.

Attributes

  • drafts (type: list(GoogleApi.Gmail.V1.Model.Draft.t), default: nil) - 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.
  • nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results in the list.
  • resultSizeEstimate (type: integer(), default: nil) - Estimated total number of results.

Response for the ListFilters method.

Response for the ListForwardingAddresses method.

Attributes

  • history (type: list(GoogleApi.Gmail.V1.Model.History.t), default: nil) - List of history records. Any messages contained in the response will typically only have id and threadId fields populated.
  • historyId (type: String.t, default: nil) - The ID of the mailbox's current history record.
  • nextPageToken (type: String.t, default: nil) - Page token to retrieve the next page of results in the list.

Attributes

  • labels (type: list(GoogleApi.Gmail.V1.Model.Label.t), default: nil) - 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.

Attributes

  • messages (type: list(GoogleApi.Gmail.V1.Model.Message.t), default: nil) - 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.
  • nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results in the list.
  • resultSizeEstimate (type: integer(), default: nil) - Estimated total number of results.

Response for the ListSendAs method.

Attributes

  • smimeInfo (type: list(GoogleApi.Gmail.V1.Model.SmimeInfo.t), default: nil) - List of SmimeInfo.

Attributes

  • nextPageToken (type: String.t, default: nil) - Page token to retrieve the next page of results in the list.
  • resultSizeEstimate (type: integer(), default: nil) - Estimated total number of results.
  • threads (type: list(GoogleApi.Gmail.V1.Model.Thread.t), default: nil) - 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.

A single MIME message part.

The body of a single MIME message part.

Attributes

  • name (type: String.t, default: nil) - The name of the header before the : separator. For example, To.
  • value (type: String.t, default: nil) - The value of the header after the : separator. For example, someuser@example.com.

Attributes

  • addLabelIds (type: list(String.t), default: nil) - A list of IDs of labels to add to this message. You can add up to 100 labels with each update.
  • removeLabelIds (type: list(String.t), default: nil) - A list IDs of labels to remove from this message. You can remove up to 100 labels with each update.

Attributes

  • addLabelIds (type: list(String.t), default: nil) - A list of IDs of labels to add to this thread. You can add up to 100 labels with each update.
  • removeLabelIds (type: list(String.t), default: nil) - A list of IDs of labels to remove from this thread. You can remove up to 100 labels with each update.

Request to obliterate a CSE key pair.

POP settings for an account.

Profile for a Gmail user.

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.

The configuration of a CSE identity that uses different key pairs for signing and encryption.

An S/MIME email config.

Configuration for communication with an SMTP service.

A collection of messages representing a conversation.

Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface.

Set up or update a new push notification watch on this user's mailbox.

Push notification watch response.