Default request referring to version v1 of the Gmail API. This contains the host and root path used as a starting point for constructing service requests.

View and manage your mail

View and modify but not delete your email

Manage mailbox labels

Send email on your behalf

Insert mail into your mailbox

Manage drafts and send emails

View your emails messages and settings

The format to return the message in.

Creates a value of ModifyThreadRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mtrRemoveLabelIds
• mtrAddLabelIds

A list of IDs of labels to remove from this thread.

A list of IDs of labels to add to this thread.

Creates a value of ModifyMessageRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mmrRemoveLabelIds
• mmrAddLabelIds

A list IDs of labels to remove from this message.

A list of IDs of labels to add to this message.

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

See: history smart constructor.

Creates a value of History with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hLabelsRemoved
• hMessagesDeleted
• hMessagesAdded
• hLabelsAdded
• hId
• hMessages

Labels removed from messages in this history record.

Messages deleted (not Trashed) from the mailbox in this history record.

Messages added to the mailbox in this history record.

Labels added to messages in this history record.

The mailbox sequence ID.

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.

Profile for a Gmail user.

See: proFile smart constructor.

Creates a value of ProFile with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pfMessagesTotal
• pfThreadsTotal
• pfHistoryId
• pfEmailAddress

The total number of messages in the mailbox.

The total number of threads in the mailbox.

The ID of the mailbox's current history record.

The user's email address.

Creates a value of MessagePartHeader with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mphValue
• mphName

The value of the header after the : separator. For example, someuser'example.com.

The name of the header before the : separator. For example, To.

Creates a value of ListHistoryResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lhrNextPageToken
• lhrHistory
• lhrHistoryId

Page token to retrieve the next page of results in the list.

List of history records. Any messages contained in the response will typically only have id and threadId fields populated.

The ID of the mailbox's current history record.

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.

The format to return the draft in.

Source for Gmail's internal date of the message.

The visibility of the label in the message list in the Gmail web interface.

Creates a value of ListThreadsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltrNextPageToken
• ltrResultSizeEstimate
• ltrThreads

Page token to retrieve the next page of results in the list.

Estimated total number of results.

List of threads.

A single MIME message part.

See: messagePart smart constructor.

Creates a value of MessagePart with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mpParts
• mpBody
• mpMimeType
• mpHeaders
• mpPartId
• mpFilename

The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.

The message part body for this part, which may be empty for container MIME message parts.

The MIME type of the message part.

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.

The immutable ID of the message part.

The filename of the attachment. Only present if this message part represents an attachment.

Creates a value of HistoryLabelAdded with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hlaLabelIds
• hlaMessage

Label IDs added to the message.

Creates a value of ListLabelsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• llrLabels

List of labels.

The visibility of the label in the label list in the Gmail web interface.

Creates a value of HistoryMessageDeleted with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hmdMessage

The body of a single MIME message part.

See: messagePartBody smart constructor.

Creates a value of MessagePartBody with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mpbSize
• mpbData
• mpbAttachmentId

Total number of bytes in the body of the message part.

The body data of a MIME message part. 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.

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.

Creates a value of ListDraftsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ldrNextPageToken
• ldrResultSizeEstimate
• ldrDrafts

Token to retrieve the next page of results in the list.

Estimated total number of results.

List of drafts.

Push notification watch response.

See: watchResponse smart constructor.

Creates a value of WatchResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• wrExpiration
• wrHistoryId

When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch.

The ID of the mailbox's current history record.

The format to return the messages in.

A draft email in the user's mailbox.

See: draft smart constructor.

Creates a value of Draft with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dId
• dMessage

The immutable ID of the draft.

The message content of the draft.

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

See: watchRequest smart constructor.

Creates a value of WatchRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• wrLabelFilterAction
• wrTopicName
• wrLabelIds

Filtering behavior of labelIds list specified.

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 new Cloud Pub/Sub "v1beta2" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).

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.

Filtering behavior of labelIds list specified.

An email message.

See: message smart constructor.

Creates a value of Message with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mRaw
• mSnippet
• mSizeEstimate
• mPayload
• mHistoryId
• mId
• mLabelIds
• mThreadId
• mInternalDate

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.

A short part of the message text.

Estimated size in bytes of the message.

The parsed email structure in the message parts.

The ID of the last history record that modified this message.

The immutable ID of the message.

List of IDs of labels applied to this message.

The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: - The requested threadId must be specified on the Message or Draft.Message you supply with your request. - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard. - The Subject headers must match.

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.

Source for Gmail's internal date of the message.

Creates a value of HistoryLabelRemoved with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hlrLabelIds
• hlrMessage

Label IDs removed from the message.

A collection of messages representing a conversation.

See: thread smart constructor.

Creates a value of Thread with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tSnippet
• tHistoryId
• tId
• tMessages

A short part of the message text.

The ID of the last history record that modified this thread.

The unique ID of the thread.

The list of messages in the thread.

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

See: label smart constructor.

Creates a value of Label with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lThreadsUnread
• lMessageListVisibility
• lMessagesTotal
• lMessagesUnread
• lName
• lThreadsTotal
• lLabelListVisibility
• lId
• lType

The number of unread threads with the label.

The visibility of the label in the message list in the Gmail web interface.

The total number of messages with the label.

The number of unread messages with the label.

The display name of the label.

The total number of threads with the label.

The visibility of the label in the label list in the Gmail web interface.

The immutable ID of the label.

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.

Creates a value of ListMessagesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lmrNextPageToken
• lmrResultSizeEstimate
• lmrMessages

Token to retrieve the next page of results in the list.

Estimated total number of results.

List of messages.

Creates a value of HistoryMessageAdded with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hmaMessage