google_api_gmail v0.10.0 API Reference

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.

Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See

A draft email in the user's mailbox.

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.

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.

Labels are used to categorize messages and threads within the user's mailbox.

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: <br/>

Language settings for an account. These settings correspond to the <a href="https://support.google.com/mail/answer/17091">"Language settings"</a> feature in the web interface.

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 <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a> 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 <a href="/gmail/api/v1/reference/users/labels/get">labels.get</a> 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 <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a> 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 <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> 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.
  • removeLabelIds (type: list(String.t), default: nil) - A list IDs of labels to remove from this message.

Attributes

  • addLabelIds (type: list(String.t), default: nil) - A list of IDs of labels to add to this thread.
  • removeLabelIds (type: list(String.t), default: nil) - A list of IDs of labels to remove from this thread.

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

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 <a href="https://support.google.com/mail/answer/25922">"Vacation responder"</a> feature in the web interface.

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

Push notification watch response.