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
-
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.
IMAP settings for an account.
Labels are used to categorize messages and threads within the user's mailbox.
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 theMessage
property in eachDraft
resource only contains anid
and athreadId
. 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. Anymessages
contained in the response will typically only haveid
andthreadId
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 anid
,name
,messageListVisibility
,labelListVisibility
, andtype
. 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 anid
and athreadId
. 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
-
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 ofmessages
. The list ofmessages
for a given thread can be fetched using the <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> method.
An email message.
A single MIME message part.
The body of a single MIME message part.
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.