gmail

package
v0.181.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 16, 2024 License: BSD-3-Clause Imports: 16 Imported by: 642

Documentation

Overview

Package gmail provides access to the Gmail API.

For product documentation, see: https://developers.google.com/gmail/api/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/gmail/v1"
...
ctx := context.Background()
gmailService, err := gmail.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

gmailService, err := gmail.NewService(ctx, option.WithScopes(gmail.GmailSettingsSharingScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

gmailService, err := gmail.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
gmailService, err := gmail.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// Read, compose, send, and permanently delete all your email from Gmail
	MailGoogleComScope = "https://mail.google.com/"

	// Manage drafts and send emails when you interact with the add-on
	GmailAddonsCurrentActionComposeScope = "https://www.googleapis.com/auth/gmail.addons.current.action.compose"

	// View your email messages when you interact with the add-on
	GmailAddonsCurrentMessageActionScope = "https://www.googleapis.com/auth/gmail.addons.current.message.action"

	// View your email message metadata when the add-on is running
	GmailAddonsCurrentMessageMetadataScope = "https://www.googleapis.com/auth/gmail.addons.current.message.metadata"

	// View your email messages when the add-on is running
	GmailAddonsCurrentMessageReadonlyScope = "https://www.googleapis.com/auth/gmail.addons.current.message.readonly"

	// Manage drafts and send emails
	GmailComposeScope = "https://www.googleapis.com/auth/gmail.compose"

	// Add emails into your Gmail mailbox
	GmailInsertScope = "https://www.googleapis.com/auth/gmail.insert"

	// See and edit your email labels
	GmailLabelsScope = "https://www.googleapis.com/auth/gmail.labels"

	// View your email message metadata such as labels and headers, but not the
	// email body
	GmailMetadataScope = "https://www.googleapis.com/auth/gmail.metadata"

	// Read, compose, and send emails from your Gmail account
	GmailModifyScope = "https://www.googleapis.com/auth/gmail.modify"

	// View your email messages and settings
	GmailReadonlyScope = "https://www.googleapis.com/auth/gmail.readonly"

	// Send email on your behalf
	GmailSendScope = "https://www.googleapis.com/auth/gmail.send"

	// See, edit, create, or change your email settings and filters in Gmail
	GmailSettingsBasicScope = "https://www.googleapis.com/auth/gmail.settings.basic"

	// Manage your sensitive mail settings, including who can manage your mail
	GmailSettingsSharingScope = "https://www.googleapis.com/auth/gmail.settings.sharing"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AutoForwarding

type AutoForwarding struct {
	// Disposition: The state that a message should be left in after it has been
	// forwarded.
	//
	// Possible values:
	//   "dispositionUnspecified" - Unspecified disposition.
	//   "leaveInInbox" - Leave the message in the `INBOX`.
	//   "archive" - Archive the message.
	//   "trash" - Move the message to the `TRASH`.
	//   "markRead" - Leave the message in the `INBOX` and mark it as read.
	Disposition string `json:"disposition,omitempty"`
	// EmailAddress: Email address to which all incoming messages are forwarded.
	// This email address must be a verified member of the forwarding addresses.
	EmailAddress string `json:"emailAddress,omitempty"`
	// Enabled: Whether all incoming mail is automatically forwarded to another
	// address.
	Enabled bool `json:"enabled,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Disposition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Disposition") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AutoForwarding: Auto-forwarding settings for an account.

func (*AutoForwarding) MarshalJSON

func (s *AutoForwarding) MarshalJSON() ([]byte, error)

type BatchDeleteMessagesRequest

type BatchDeleteMessagesRequest struct {
	// Ids: The IDs of the messages to delete.
	Ids []string `json:"ids,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Ids") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Ids") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*BatchDeleteMessagesRequest) MarshalJSON

func (s *BatchDeleteMessagesRequest) MarshalJSON() ([]byte, error)

type BatchModifyMessagesRequest

type BatchModifyMessagesRequest struct {
	// AddLabelIds: A list of label IDs to add to messages.
	AddLabelIds []string `json:"addLabelIds,omitempty"`
	// Ids: The IDs of the messages to modify. There is a limit of 1000 ids per
	// request.
	Ids []string `json:"ids,omitempty"`
	// RemoveLabelIds: A list of label IDs to remove from messages.
	RemoveLabelIds []string `json:"removeLabelIds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AddLabelIds") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AddLabelIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*BatchModifyMessagesRequest) MarshalJSON

func (s *BatchModifyMessagesRequest) MarshalJSON() ([]byte, error)

type CseIdentity added in v0.106.0

type CseIdentity struct {
	// EmailAddress: The email address for the sending identity. The email address
	// must be the primary email address of the authenticated user.
	EmailAddress string `json:"emailAddress,omitempty"`
	// PrimaryKeyPairId: If a key pair is associated, the ID of the key pair,
	// CseKeyPair.
	PrimaryKeyPairId string `json:"primaryKeyPairId,omitempty"`
	// SignAndEncryptKeyPairs: The configuration of a CSE identity that uses
	// different key pairs for signing and encryption.
	SignAndEncryptKeyPairs *SignAndEncryptKeyPairs `json:"signAndEncryptKeyPairs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EmailAddress") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EmailAddress") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CseIdentity: 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.

func (*CseIdentity) MarshalJSON added in v0.106.0

func (s *CseIdentity) MarshalJSON() ([]byte, error)

type CseKeyPair added in v0.106.0

type CseKeyPair struct {
	// DisableTime: Output only. If a key pair is set to `DISABLED`, the time that
	// the key pair's state changed from `ENABLED` to `DISABLED`. This field is
	// present only when the key pair is in state `DISABLED`.
	DisableTime string `json:"disableTime,omitempty"`
	// EnablementState: Output only. The current state of the key pair.
	//
	// Possible values:
	//   "stateUnspecified" - The current state of the key pair is not set. The key
	// pair is neither turned on nor turned off.
	//   "enabled" - The key pair is turned on. For any email messages that this
	// key pair encrypts, Gmail decrypts the messages and signs any outgoing mail
	// with the private key. To turn on a key pair, use the EnableCseKeyPair
	// method.
	//   "disabled" - The key pair is turned off. Authenticated users cannot
	// decrypt email messages nor sign outgoing messages. If a key pair is turned
	// off for more than 30 days, you can permanently delete it. To turn off a key
	// pair, use the DisableCseKeyPair method.
	EnablementState string `json:"enablementState,omitempty"`
	// KeyPairId: Output only. The immutable ID for the client-side encryption
	// S/MIME key pair.
	KeyPairId string `json:"keyPairId,omitempty"`
	// Pem: Output only. The public key and its certificate chain, in PEM
	// (https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
	Pem string `json:"pem,omitempty"`
	// Pkcs7: Input only. The public key and its certificate chain. The chain must
	// be in PKCS#7 (https://en.wikipedia.org/wiki/PKCS_7) format and use PEM
	// encoding and ASCII armor.
	Pkcs7 string `json:"pkcs7,omitempty"`
	// PrivateKeyMetadata: Metadata for instances of this key pair's private key.
	PrivateKeyMetadata []*CsePrivateKeyMetadata `json:"privateKeyMetadata,omitempty"`
	// SubjectEmailAddresses: Output only. The email address identities that are
	// specified on the leaf certificate.
	SubjectEmailAddresses []string `json:"subjectEmailAddresses,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisableTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisableTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CseKeyPair: 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.

func (*CseKeyPair) MarshalJSON added in v0.106.0

func (s *CseKeyPair) MarshalJSON() ([]byte, error)

type CsePrivateKeyMetadata added in v0.106.0

type CsePrivateKeyMetadata struct {
	// HardwareKeyMetadata: Metadata for hardware keys.
	HardwareKeyMetadata *HardwareKeyMetadata `json:"hardwareKeyMetadata,omitempty"`
	// KaclsKeyMetadata: Metadata for a private key instance managed by an external
	// key access control list service.
	KaclsKeyMetadata *KaclsKeyMetadata `json:"kaclsKeyMetadata,omitempty"`
	// PrivateKeyMetadataId: Output only. The immutable ID for the private key
	// metadata instance.
	PrivateKeyMetadataId string `json:"privateKeyMetadataId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "HardwareKeyMetadata") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "HardwareKeyMetadata") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CsePrivateKeyMetadata: Metadata for a private key instance.

func (*CsePrivateKeyMetadata) MarshalJSON added in v0.106.0

func (s *CsePrivateKeyMetadata) MarshalJSON() ([]byte, error)

type Delegate

type Delegate struct {
	// DelegateEmail: The email address of the delegate.
	DelegateEmail string `json:"delegateEmail,omitempty"`
	// VerificationStatus: Indicates whether this address has been verified and can
	// act as a delegate for the account. Read-only.
	//
	// Possible values:
	//   "verificationStatusUnspecified" - Unspecified verification status.
	//   "accepted" - The address can act a delegate for the account.
	//   "pending" - A verification request was mailed to the address, and the
	// owner has not yet accepted it.
	//   "rejected" - A verification request was mailed to the address, and the
	// owner rejected it.
	//   "expired" - A verification request was mailed to the address, and it
	// expired without verification.
	VerificationStatus string `json:"verificationStatus,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DelegateEmail") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DelegateEmail") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Delegate: 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.

func (*Delegate) MarshalJSON

func (s *Delegate) MarshalJSON() ([]byte, error)

type DisableCseKeyPairRequest added in v0.106.0

type DisableCseKeyPairRequest struct {
}

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

type Draft

type Draft struct {
	// Id: The immutable ID of the draft.
	Id string `json:"id,omitempty"`
	// Message: The message content of the draft.
	Message *Message `json:"message,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Id") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Id") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Draft: A draft email in the user's mailbox.

func (*Draft) MarshalJSON

func (s *Draft) MarshalJSON() ([]byte, error)

type EnableCseKeyPairRequest added in v0.106.0

type EnableCseKeyPairRequest struct {
}

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

type Filter

type Filter struct {
	// Action: Action that the filter performs.
	Action *FilterAction `json:"action,omitempty"`
	// Criteria: Matching criteria for the filter.
	Criteria *FilterCriteria `json:"criteria,omitempty"`
	// Id: The server assigned ID of the filter.
	Id string `json:"id,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Action") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Action") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*Filter) MarshalJSON

func (s *Filter) MarshalJSON() ([]byte, error)

type FilterAction

type FilterAction struct {
	// AddLabelIds: List of labels to add to the message.
	AddLabelIds []string `json:"addLabelIds,omitempty"`
	// Forward: Email address that the message should be forwarded to.
	Forward string `json:"forward,omitempty"`
	// RemoveLabelIds: List of labels to remove from the message.
	RemoveLabelIds []string `json:"removeLabelIds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AddLabelIds") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AddLabelIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FilterAction: A set of actions to perform on a message.

func (*FilterAction) MarshalJSON

func (s *FilterAction) MarshalJSON() ([]byte, error)

type FilterCriteria

type FilterCriteria struct {
	// ExcludeChats: Whether the response should exclude chats.
	ExcludeChats bool `json:"excludeChats,omitempty"`
	// From: The sender's display name or email address.
	From string `json:"from,omitempty"`
	// HasAttachment: Whether the message has any attachment.
	HasAttachment bool `json:"hasAttachment,omitempty"`
	// NegatedQuery: Only return messages not matching the specified query.
	// Supports the same query format as the Gmail search box. For example,
	// "from:someuser@example.com rfc822msgid: is:unread".
	NegatedQuery string `json:"negatedQuery,omitempty"`
	// Query: 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".
	Query string `json:"query,omitempty"`
	// Size: The size of the entire RFC822 message in bytes, including all headers
	// and attachments.
	Size int64 `json:"size,omitempty"`
	// SizeComparison: How the message size in bytes should be in relation to the
	// size field.
	//
	// Possible values:
	//   "unspecified"
	//   "smaller" - Find messages smaller than the given size.
	//   "larger" - Find messages larger than the given size.
	SizeComparison string `json:"sizeComparison,omitempty"`
	// Subject: Case-insensitive phrase found in the message's subject. Trailing
	// and leading whitespace are be trimmed and adjacent spaces are collapsed.
	Subject string `json:"subject,omitempty"`
	// To: The recipient's display name or email address. Includes recipients in
	// the "to", "cc", and "bcc" header fields. You can use simply the local part
	// of the email address. For example, "example" and "example@" both match
	// "example@gmail.com". This field is case-insensitive.
	To string `json:"to,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExcludeChats") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExcludeChats") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FilterCriteria: Message matching criteria.

func (*FilterCriteria) MarshalJSON

func (s *FilterCriteria) MarshalJSON() ([]byte, error)

type ForwardingAddress

type ForwardingAddress struct {
	// ForwardingEmail: An email address to which messages can be forwarded.
	ForwardingEmail string `json:"forwardingEmail,omitempty"`
	// VerificationStatus: Indicates whether this address has been verified and is
	// usable for forwarding. Read-only.
	//
	// Possible values:
	//   "verificationStatusUnspecified" - Unspecified verification status.
	//   "accepted" - The address is ready to use for forwarding.
	//   "pending" - The address is awaiting verification by the owner.
	VerificationStatus string `json:"verificationStatus,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ForwardingEmail") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ForwardingEmail") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ForwardingAddress: Settings for a forwarding address.

func (*ForwardingAddress) MarshalJSON

func (s *ForwardingAddress) MarshalJSON() ([]byte, error)

type HardwareKeyMetadata added in v0.143.0

type HardwareKeyMetadata struct {
	// Description: Description about the hardware key.
	Description string `json:"description,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

HardwareKeyMetadata: Metadata for hardware keys.

func (*HardwareKeyMetadata) MarshalJSON added in v0.143.0

func (s *HardwareKeyMetadata) MarshalJSON() ([]byte, error)

type History

type History struct {
	// Id: The mailbox sequence ID.
	Id uint64 `json:"id,omitempty,string"`
	// LabelsAdded: Labels added to messages in this history record.
	LabelsAdded []*HistoryLabelAdded `json:"labelsAdded,omitempty"`
	// LabelsRemoved: Labels removed from messages in this history record.
	LabelsRemoved []*HistoryLabelRemoved `json:"labelsRemoved,omitempty"`
	// Messages: 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.
	Messages []*Message `json:"messages,omitempty"`
	// MessagesAdded: Messages added to the mailbox in this history record.
	MessagesAdded []*HistoryMessageAdded `json:"messagesAdded,omitempty"`
	// MessagesDeleted: Messages deleted (not Trashed) from the mailbox in this
	// history record.
	MessagesDeleted []*HistoryMessageDeleted `json:"messagesDeleted,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Id") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Id") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*History) MarshalJSON

func (s *History) MarshalJSON() ([]byte, error)

type HistoryLabelAdded

type HistoryLabelAdded struct {
	// LabelIds: Label IDs added to the message.
	LabelIds []string `json:"labelIds,omitempty"`
	Message  *Message `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LabelIds") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LabelIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*HistoryLabelAdded) MarshalJSON

func (s *HistoryLabelAdded) MarshalJSON() ([]byte, error)

type HistoryLabelRemoved

type HistoryLabelRemoved struct {
	// LabelIds: Label IDs removed from the message.
	LabelIds []string `json:"labelIds,omitempty"`
	Message  *Message `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LabelIds") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LabelIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*HistoryLabelRemoved) MarshalJSON

func (s *HistoryLabelRemoved) MarshalJSON() ([]byte, error)

type HistoryMessageAdded

type HistoryMessageAdded struct {
	Message *Message `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Message") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Message") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*HistoryMessageAdded) MarshalJSON

func (s *HistoryMessageAdded) MarshalJSON() ([]byte, error)

type HistoryMessageDeleted

type HistoryMessageDeleted struct {
	Message *Message `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Message") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Message") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*HistoryMessageDeleted) MarshalJSON

func (s *HistoryMessageDeleted) MarshalJSON() ([]byte, error)

type ImapSettings

type ImapSettings struct {
	// AutoExpunge: If this value is true, Gmail will immediately expunge a message
	// when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an
	// update from the client before expunging messages marked as deleted.
	AutoExpunge bool `json:"autoExpunge,omitempty"`
	// Enabled: Whether IMAP is enabled for the account.
	Enabled bool `json:"enabled,omitempty"`
	// ExpungeBehavior: The action that will be executed on a message when it is
	// marked as deleted and expunged from the last visible IMAP folder.
	//
	// Possible values:
	//   "expungeBehaviorUnspecified" - Unspecified behavior.
	//   "archive" - Archive messages marked as deleted.
	//   "trash" - Move messages marked as deleted to the trash.
	//   "deleteForever" - Immediately and permanently delete messages marked as
	// deleted. The expunged messages cannot be recovered.
	ExpungeBehavior string `json:"expungeBehavior,omitempty"`
	// MaxFolderSize: An optional limit on the number of messages that an IMAP
	// folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value
	// of zero is interpreted to mean that there is no limit.
	MaxFolderSize int64 `json:"maxFolderSize,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AutoExpunge") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AutoExpunge") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImapSettings: IMAP settings for an account.

func (*ImapSettings) MarshalJSON

func (s *ImapSettings) MarshalJSON() ([]byte, error)

type KaclsKeyMetadata added in v0.106.0

type KaclsKeyMetadata struct {
	// KaclsData: Opaque data generated and used by the key access control list
	// service. Maximum size: 8 KiB.
	KaclsData string `json:"kaclsData,omitempty"`
	// KaclsUri: The URI of the key access control list service that manages the
	// private key.
	KaclsUri string `json:"kaclsUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KaclsData") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KaclsData") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

KaclsKeyMetadata: 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 (https://developers.google.com/workspace/cse/reference).

func (*KaclsKeyMetadata) MarshalJSON added in v0.106.0

func (s *KaclsKeyMetadata) MarshalJSON() ([]byte, error)

type Label

type Label struct {
	// Color: The color to assign to the label. Color is only available for labels
	// that have their `type` set to `user`.
	Color *LabelColor `json:"color,omitempty"`
	// Id: The immutable ID of the label.
	Id string `json:"id,omitempty"`
	// LabelListVisibility: The visibility of the label in the label list in the
	// Gmail web interface.
	//
	// Possible values:
	//   "labelShow" - Show the label in the label list.
	//   "labelShowIfUnread" - Show the label if there are any unread messages with
	// that label.
	//   "labelHide" - Do not show the label in the label list.
	LabelListVisibility string `json:"labelListVisibility,omitempty"`
	// MessageListVisibility: The visibility of messages with this label in the
	// message list in the Gmail web interface.
	//
	// Possible values:
	//   "show" - Show the label in the message list.
	//   "hide" - Do not show the label in the message list.
	MessageListVisibility string `json:"messageListVisibility,omitempty"`
	// MessagesTotal: The total number of messages with the label.
	MessagesTotal int64 `json:"messagesTotal,omitempty"`
	// MessagesUnread: The number of unread messages with the label.
	MessagesUnread int64 `json:"messagesUnread,omitempty"`
	// Name: The display name of the label.
	Name string `json:"name,omitempty"`
	// ThreadsTotal: The total number of threads with the label.
	ThreadsTotal int64 `json:"threadsTotal,omitempty"`
	// ThreadsUnread: The number of unread threads with the label.
	ThreadsUnread int64 `json:"threadsUnread,omitempty"`
	// Type: 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.
	//
	// Possible values:
	//   "system" - Labels created by Gmail.
	//   "user" - Custom labels created by the user or application.
	Type string `json:"type,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Color") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Color") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Label: 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.

func (*Label) MarshalJSON

func (s *Label) MarshalJSON() ([]byte, error)

type LabelColor

type LabelColor struct {
	// BackgroundColor: 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
	BackgroundColor string `json:"backgroundColor,omitempty"`
	// TextColor: 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
	TextColor string `json:"textColor,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BackgroundColor") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackgroundColor") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*LabelColor) MarshalJSON

func (s *LabelColor) MarshalJSON() ([]byte, error)

type LanguageSettings added in v0.5.0

type LanguageSettings struct {
	// DisplayLanguage: The language to display Gmail in, formatted as an RFC 3066
	// Language Tag (for example `en-GB`, `fr` or `ja` for British English, French,
	// or Japanese respectively). The set of languages supported by Gmail evolves
	// over time, so please refer to the "Language" dropdown in the Gmail settings
	// for all available options, as described in the language settings help
	// article. A table of sample values is also provided in the Managing Language
	// Settings guide Not all Gmail clients can display the same set of languages.
	// In the case that a user's display language is not available for use on a
	// particular client, said client automatically chooses to display in the
	// closest supported variant (or a reasonable default).
	DisplayLanguage string `json:"displayLanguage,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayLanguage") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayLanguage") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*LanguageSettings) MarshalJSON added in v0.5.0

func (s *LanguageSettings) MarshalJSON() ([]byte, error)

type ListCseIdentitiesResponse added in v0.106.0

type ListCseIdentitiesResponse struct {
	// CseIdentities: One page of the list of CSE identities configured for the
	// user.
	CseIdentities []*CseIdentity `json:"cseIdentities,omitempty"`
	// NextPageToken: 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.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CseIdentities") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CseIdentities") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ListCseIdentitiesResponse) MarshalJSON added in v0.106.0

func (s *ListCseIdentitiesResponse) MarshalJSON() ([]byte, error)

type ListCseKeyPairsResponse added in v0.106.0

type ListCseKeyPairsResponse struct {
	// CseKeyPairs: One page of the list of CSE key pairs installed for the user.
	CseKeyPairs []*CseKeyPair `json:"cseKeyPairs,omitempty"`
	// NextPageToken: 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.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CseKeyPairs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CseKeyPairs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ListCseKeyPairsResponse) MarshalJSON added in v0.106.0

func (s *ListCseKeyPairsResponse) MarshalJSON() ([]byte, error)

type ListDelegatesResponse

type ListDelegatesResponse struct {
	// Delegates: List of the user's delegates (with any verification status). If
	// an account doesn't have delegates, this field doesn't appear.
	Delegates []*Delegate `json:"delegates,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Delegates") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Delegates") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListDelegatesResponse: Response for the ListDelegates method.

func (*ListDelegatesResponse) MarshalJSON

func (s *ListDelegatesResponse) MarshalJSON() ([]byte, error)

type ListDraftsResponse

type ListDraftsResponse struct {
	// Drafts: 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.
	Drafts []*Draft `json:"drafts,omitempty"`
	// NextPageToken: Token to retrieve the next page of results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ResultSizeEstimate: Estimated total number of results.
	ResultSizeEstimate int64 `json:"resultSizeEstimate,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Drafts") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Drafts") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ListDraftsResponse) MarshalJSON

func (s *ListDraftsResponse) MarshalJSON() ([]byte, error)

type ListFiltersResponse

type ListFiltersResponse struct {
	// Filter: List of a user's filters.
	Filter []*Filter `json:"filter,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Filter") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListFiltersResponse: Response for the ListFilters method.

func (*ListFiltersResponse) MarshalJSON

func (s *ListFiltersResponse) MarshalJSON() ([]byte, error)

type ListForwardingAddressesResponse

type ListForwardingAddressesResponse struct {
	// ForwardingAddresses: List of addresses that may be used for forwarding.
	ForwardingAddresses []*ForwardingAddress `json:"forwardingAddresses,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ForwardingAddresses") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ForwardingAddresses") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListForwardingAddressesResponse: Response for the ListForwardingAddresses method.

func (*ListForwardingAddressesResponse) MarshalJSON

func (s *ListForwardingAddressesResponse) MarshalJSON() ([]byte, error)

type ListHistoryResponse

type ListHistoryResponse struct {
	// History: List of history records. Any `messages` contained in the response
	// will typically only have `id` and `threadId` fields populated.
	History []*History `json:"history,omitempty"`
	// HistoryId: The ID of the mailbox's current history record.
	HistoryId uint64 `json:"historyId,omitempty,string"`
	// NextPageToken: Page token to retrieve the next page of results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "History") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "History") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ListHistoryResponse) MarshalJSON

func (s *ListHistoryResponse) MarshalJSON() ([]byte, error)

type ListLabelsResponse

type ListLabelsResponse struct {
	// Labels: 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.
	Labels []*Label `json:"labels,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Labels") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Labels") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ListLabelsResponse) MarshalJSON

func (s *ListLabelsResponse) MarshalJSON() ([]byte, error)

type ListMessagesResponse

type ListMessagesResponse struct {
	// Messages: 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.
	Messages []*Message `json:"messages,omitempty"`
	// NextPageToken: Token to retrieve the next page of results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ResultSizeEstimate: Estimated total number of results.
	ResultSizeEstimate int64 `json:"resultSizeEstimate,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Messages") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Messages") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ListMessagesResponse) MarshalJSON

func (s *ListMessagesResponse) MarshalJSON() ([]byte, error)

type ListSendAsResponse

type ListSendAsResponse struct {
	// SendAs: List of send-as aliases.
	SendAs []*SendAs `json:"sendAs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "SendAs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "SendAs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListSendAsResponse: Response for the ListSendAs method.

func (*ListSendAsResponse) MarshalJSON

func (s *ListSendAsResponse) MarshalJSON() ([]byte, error)

type ListSmimeInfoResponse

type ListSmimeInfoResponse struct {
	// SmimeInfo: List of SmimeInfo.
	SmimeInfo []*SmimeInfo `json:"smimeInfo,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "SmimeInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "SmimeInfo") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ListSmimeInfoResponse) MarshalJSON

func (s *ListSmimeInfoResponse) MarshalJSON() ([]byte, error)

type ListThreadsResponse

type ListThreadsResponse struct {
	// NextPageToken: Page token to retrieve the next page of results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ResultSizeEstimate: Estimated total number of results.
	ResultSizeEstimate int64 `json:"resultSizeEstimate,omitempty"`
	// Threads: 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.
	Threads []*Thread `json:"threads,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ListThreadsResponse) MarshalJSON

func (s *ListThreadsResponse) MarshalJSON() ([]byte, error)

type Message

type Message struct {
	// HistoryId: The ID of the last history record that modified this message.
	HistoryId uint64 `json:"historyId,omitempty,string"`
	// Id: The immutable ID of the message.
	Id string `json:"id,omitempty"`
	// InternalDate: 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.
	InternalDate int64 `json:"internalDate,omitempty,string"`
	// LabelIds: List of IDs of labels applied to this message.
	LabelIds []string `json:"labelIds,omitempty"`
	// Payload: The parsed email structure in the message parts.
	Payload *MessagePart `json:"payload,omitempty"`
	// Raw: 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.
	Raw string `json:"raw,omitempty"`
	// SizeEstimate: Estimated size in bytes of the message.
	SizeEstimate int64 `json:"sizeEstimate,omitempty"`
	// Snippet: A short part of the message text.
	Snippet string `json:"snippet,omitempty"`
	// ThreadId: The ID of the thread the message belongs to. To add a message or
	// draft to a thread, the following criteria must be met: 1. The requested
	// `threadId` must be specified on the `Message` or `Draft.Message` you supply
	// with your request. 2. The `References` and `In-Reply-To` headers must be set
	// in compliance with the RFC 2822 (https://tools.ietf.org/html/rfc2822)
	// standard. 3. The `Subject` headers must match.
	ThreadId string `json:"threadId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "HistoryId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "HistoryId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Message: An email message.

func (*Message) MarshalJSON

func (s *Message) MarshalJSON() ([]byte, error)

type MessagePart

type MessagePart struct {
	// Body: The message part body for this part, which may be empty for container
	// MIME message parts.
	Body *MessagePartBody `json:"body,omitempty"`
	// Filename: The filename of the attachment. Only present if this message part
	// represents an attachment.
	Filename string `json:"filename,omitempty"`
	// Headers: 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`.
	Headers []*MessagePartHeader `json:"headers,omitempty"`
	// MimeType: The MIME type of the message part.
	MimeType string `json:"mimeType,omitempty"`
	// PartId: The immutable ID of the message part.
	PartId string `json:"partId,omitempty"`
	// Parts: 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.
	Parts []*MessagePart `json:"parts,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Body") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Body") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MessagePart: A single MIME message part.

func (*MessagePart) MarshalJSON

func (s *MessagePart) MarshalJSON() ([]byte, error)

type MessagePartBody

type MessagePartBody struct {
	// AttachmentId: 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.
	AttachmentId string `json:"attachmentId,omitempty"`
	// Data: The body data of a MIME message part as a base64url encoded string.
	// 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.
	Data string `json:"data,omitempty"`
	// Size: Number of bytes for the message part data (encoding notwithstanding).
	Size int64 `json:"size,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AttachmentId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttachmentId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MessagePartBody: The body of a single MIME message part.

func (*MessagePartBody) MarshalJSON

func (s *MessagePartBody) MarshalJSON() ([]byte, error)

type MessagePartHeader

type MessagePartHeader struct {
	// Name: The name of the header before the `:` separator. For example, `To`.
	Name string `json:"name,omitempty"`
	// Value: The value of the header after the `:` separator. For example,
	// `someuser@example.com`.
	Value string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*MessagePartHeader) MarshalJSON

func (s *MessagePartHeader) MarshalJSON() ([]byte, error)

type ModifyMessageRequest

type ModifyMessageRequest struct {
	// AddLabelIds: A list of IDs of labels to add to this message. You can add up
	// to 100 labels with each update.
	AddLabelIds []string `json:"addLabelIds,omitempty"`
	// RemoveLabelIds: A list IDs of labels to remove from this message. You can
	// remove up to 100 labels with each update.
	RemoveLabelIds []string `json:"removeLabelIds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AddLabelIds") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AddLabelIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ModifyMessageRequest) MarshalJSON

func (s *ModifyMessageRequest) MarshalJSON() ([]byte, error)

type ModifyThreadRequest

type ModifyThreadRequest struct {
	// AddLabelIds: A list of IDs of labels to add to this thread. You can add up
	// to 100 labels with each update.
	AddLabelIds []string `json:"addLabelIds,omitempty"`
	// RemoveLabelIds: A list of IDs of labels to remove from this thread. You can
	// remove up to 100 labels with each update.
	RemoveLabelIds []string `json:"removeLabelIds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AddLabelIds") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AddLabelIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ModifyThreadRequest) MarshalJSON

func (s *ModifyThreadRequest) MarshalJSON() ([]byte, error)

type ObliterateCseKeyPairRequest added in v0.106.0

type ObliterateCseKeyPairRequest struct {
}

ObliterateCseKeyPairRequest: Request to obliterate a CSE key pair.

type PopSettings

type PopSettings struct {
	// AccessWindow: The range of messages which are accessible via POP.
	//
	// Possible values:
	//   "accessWindowUnspecified" - Unspecified range.
	//   "disabled" - Indicates that no messages are accessible via POP.
	//   "fromNowOn" - Indicates that unfetched messages received after some past
	// point in time are accessible via POP.
	//   "allMail" - Indicates that all unfetched messages are accessible via POP.
	AccessWindow string `json:"accessWindow,omitempty"`
	// Disposition: The action that will be executed on a message after it has been
	// fetched via POP.
	//
	// Possible values:
	//   "dispositionUnspecified" - Unspecified disposition.
	//   "leaveInInbox" - Leave the message in the `INBOX`.
	//   "archive" - Archive the message.
	//   "trash" - Move the message to the `TRASH`.
	//   "markRead" - Leave the message in the `INBOX` and mark it as read.
	Disposition string `json:"disposition,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AccessWindow") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AccessWindow") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PopSettings: POP settings for an account.

func (*PopSettings) MarshalJSON

func (s *PopSettings) MarshalJSON() ([]byte, error)

type Profile

type Profile struct {
	// EmailAddress: The user's email address.
	EmailAddress string `json:"emailAddress,omitempty"`
	// HistoryId: The ID of the mailbox's current history record.
	HistoryId uint64 `json:"historyId,omitempty,string"`
	// MessagesTotal: The total number of messages in the mailbox.
	MessagesTotal int64 `json:"messagesTotal,omitempty"`
	// ThreadsTotal: The total number of threads in the mailbox.
	ThreadsTotal int64 `json:"threadsTotal,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EmailAddress") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EmailAddress") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Profile: Profile for a Gmail user.

func (*Profile) MarshalJSON

func (s *Profile) MarshalJSON() ([]byte, error)

type SendAs

type SendAs struct {
	// DisplayName: A name that appears in the "From:" header for mail sent using
	// this alias. For custom "from" addresses, when this is empty, Gmail will
	// populate the "From:" header with the name that is used for the primary
	// address associated with the account. If the admin has disabled the ability
	// for users to update their name format, requests to update this field for the
	// primary login will silently fail.
	DisplayName string `json:"displayName,omitempty"`
	// IsDefault: Whether this address is selected as the default "From:" address
	// in situations such as composing a new message or sending a vacation
	// auto-reply. Every Gmail account has exactly one default send-as address, so
	// the only legal value that clients may write to this field is `true`.
	// Changing this from `false` to `true` for an address will result in this
	// field becoming `false` for the other previous default address.
	IsDefault bool `json:"isDefault,omitempty"`
	// IsPrimary: Whether this address is the primary address used to login to the
	// account. Every Gmail account has exactly one primary address, and it cannot
	// be deleted from the collection of send-as aliases. This field is read-only.
	IsPrimary bool `json:"isPrimary,omitempty"`
	// ReplyToAddress: An optional email address that is included in a "Reply-To:"
	// header for mail sent using this alias. If this is empty, Gmail will not
	// generate a "Reply-To:" header.
	ReplyToAddress string `json:"replyToAddress,omitempty"`
	// SendAsEmail: The email address that appears in the "From:" header for mail
	// sent using this alias. This is read-only for all operations except create.
	SendAsEmail string `json:"sendAsEmail,omitempty"`
	// Signature: An optional HTML signature that is included in messages composed
	// with this alias in the Gmail web UI. This signature is added to new emails
	// only.
	Signature string `json:"signature,omitempty"`
	// SmtpMsa: An optional SMTP service that will be used as an outbound relay for
	// mail sent using this alias. If this is empty, outbound mail will be sent
	// directly from Gmail's servers to the destination SMTP service. This setting
	// only applies to custom "from" aliases.
	SmtpMsa *SmtpMsa `json:"smtpMsa,omitempty"`
	// TreatAsAlias: Whether Gmail should treat this address as an alias for the
	// user's primary email address. This setting only applies to custom "from"
	// aliases.
	TreatAsAlias bool `json:"treatAsAlias,omitempty"`
	// VerificationStatus: Indicates whether this address has been verified for use
	// as a send-as alias. Read-only. This setting only applies to custom "from"
	// aliases.
	//
	// Possible values:
	//   "verificationStatusUnspecified" - Unspecified verification status.
	//   "accepted" - The address is ready to use as a send-as alias.
	//   "pending" - The address is awaiting verification by the owner.
	VerificationStatus string `json:"verificationStatus,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SendAs: 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.

func (*SendAs) MarshalJSON

func (s *SendAs) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Users *UsersService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SignAndEncryptKeyPairs added in v0.144.0

type SignAndEncryptKeyPairs struct {
	// EncryptionKeyPairId: The ID of the CseKeyPair that encrypts signed outgoing
	// mail.
	EncryptionKeyPairId string `json:"encryptionKeyPairId,omitempty"`
	// SigningKeyPairId: The ID of the CseKeyPair that signs outgoing mail.
	SigningKeyPairId string `json:"signingKeyPairId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EncryptionKeyPairId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EncryptionKeyPairId") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*SignAndEncryptKeyPairs) MarshalJSON added in v0.144.0

func (s *SignAndEncryptKeyPairs) MarshalJSON() ([]byte, error)

type SmimeInfo

type SmimeInfo struct {
	// EncryptedKeyPassword: Encrypted key password, when key is encrypted.
	EncryptedKeyPassword string `json:"encryptedKeyPassword,omitempty"`
	// Expiration: When the certificate expires (in milliseconds since epoch).
	Expiration int64 `json:"expiration,omitempty,string"`
	// Id: The immutable ID for the SmimeInfo.
	Id string `json:"id,omitempty"`
	// IsDefault: Whether this SmimeInfo is the default one for this user's send-as
	// address.
	IsDefault bool `json:"isDefault,omitempty"`
	// IssuerCn: The S/MIME certificate issuer's common name.
	IssuerCn string `json:"issuerCn,omitempty"`
	// Pem: PEM formatted X509 concatenated certificate string (standard base64
	// encoding). Format used for returning key, which includes public key as well
	// as certificate chain (not private key).
	Pem string `json:"pem,omitempty"`
	// Pkcs12: PKCS#12 format containing a single private/public key pair and
	// certificate chain. This format is only accepted from client for creating a
	// new SmimeInfo and is never returned, because the private key is not intended
	// to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword
	// should be set appropriately.
	Pkcs12 string `json:"pkcs12,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EncryptedKeyPassword") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EncryptedKeyPassword") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SmimeInfo: An S/MIME email config.

func (*SmimeInfo) MarshalJSON

func (s *SmimeInfo) MarshalJSON() ([]byte, error)

type SmtpMsa

type SmtpMsa struct {
	// Host: The hostname of the SMTP service. Required.
	Host string `json:"host,omitempty"`
	// Password: The password that will be used for authentication with the SMTP
	// service. This is a write-only field that can be specified in requests to
	// create or update SendAs settings; it is never populated in responses.
	Password string `json:"password,omitempty"`
	// Port: The port of the SMTP service. Required.
	Port int64 `json:"port,omitempty"`
	// SecurityMode: The protocol that will be used to secure communication with
	// the SMTP service. Required.
	//
	// Possible values:
	//   "securityModeUnspecified" - Unspecified security mode.
	//   "none" - Communication with the remote SMTP service is unsecured. Requires
	// port 25.
	//   "ssl" - Communication with the remote SMTP service is secured using SSL.
	//   "starttls" - Communication with the remote SMTP service is secured using
	// STARTTLS.
	SecurityMode string `json:"securityMode,omitempty"`
	// Username: The username that will be used for authentication with the SMTP
	// service. This is a write-only field that can be specified in requests to
	// create or update SendAs settings; it is never populated in responses.
	Username string `json:"username,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Host") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Host") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SmtpMsa: Configuration for communication with an SMTP service.

func (*SmtpMsa) MarshalJSON

func (s *SmtpMsa) MarshalJSON() ([]byte, error)

type Thread

type Thread struct {
	// HistoryId: The ID of the last history record that modified this thread.
	HistoryId uint64 `json:"historyId,omitempty,string"`
	// Id: The unique ID of the thread.
	Id string `json:"id,omitempty"`
	// Messages: The list of messages in the thread.
	Messages []*Message `json:"messages,omitempty"`
	// Snippet: A short part of the message text.
	Snippet string `json:"snippet,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "HistoryId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "HistoryId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Thread: A collection of messages representing a conversation.

func (*Thread) MarshalJSON

func (s *Thread) MarshalJSON() ([]byte, error)

type UsersDraftsCreateCall

type UsersDraftsCreateCall struct {
	// contains filtered or unexported fields
}

func (*UsersDraftsCreateCall) Context

Context sets the context to be used in this call's Do method. This context will supersede any context previously provided to the ResumableMedia method.

func (*UsersDraftsCreateCall) Do

Do executes the "gmail.users.drafts.create" call. Any non-2xx status code is an error. Response headers are in either *Draft.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersDraftsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersDraftsCreateCall) Header

func (c *UsersDraftsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersDraftsCreateCall) Media

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.

func (*UsersDraftsCreateCall) ProgressUpdater

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*UsersDraftsCreateCall) ResumableMedia deprecated

func (c *UsersDraftsCreateCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *UsersDraftsCreateCall

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type UsersDraftsDeleteCall

type UsersDraftsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersDraftsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersDraftsDeleteCall) Do

Do executes the "gmail.users.drafts.delete" call.

func (*UsersDraftsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersDraftsDeleteCall) Header

func (c *UsersDraftsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersDraftsGetCall

type UsersDraftsGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersDraftsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersDraftsGetCall) Do

func (c *UsersDraftsGetCall) Do(opts ...googleapi.CallOption) (*Draft, error)

Do executes the "gmail.users.drafts.get" call. Any non-2xx status code is an error. Response headers are in either *Draft.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersDraftsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersDraftsGetCall) Format

func (c *UsersDraftsGetCall) Format(format string) *UsersDraftsGetCall

Format sets the optional parameter "format": The format to return the draft in.

Possible values:

"minimal" - Returns only email message ID and labels; does not return the

email headers, body, or payload.

"full" (default) - Returns the full email message data with body content

parsed in the `payload` field; the `raw` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.

"raw" - Returns the full email message data with body content in the `raw`

field as a base64url encoded string; the `payload` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.

"metadata" - Returns only email message ID, labels, and email headers.

func (*UsersDraftsGetCall) Header

func (c *UsersDraftsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersDraftsGetCall) IfNoneMatch

func (c *UsersDraftsGetCall) IfNoneMatch(entityTag string) *UsersDraftsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersDraftsListCall

type UsersDraftsListCall struct {
	// contains filtered or unexported fields
}

func (*UsersDraftsListCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersDraftsListCall) Do

Do executes the "gmail.users.drafts.list" call. Any non-2xx status code is an error. Response headers are in either *ListDraftsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersDraftsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersDraftsListCall) Header

func (c *UsersDraftsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersDraftsListCall) IfNoneMatch

func (c *UsersDraftsListCall) IfNoneMatch(entityTag string) *UsersDraftsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*UsersDraftsListCall) IncludeSpamTrash

func (c *UsersDraftsListCall) IncludeSpamTrash(includeSpamTrash bool) *UsersDraftsListCall

IncludeSpamTrash sets the optional parameter "includeSpamTrash": Include drafts from `SPAM` and `TRASH` in the results.

func (*UsersDraftsListCall) MaxResults

func (c *UsersDraftsListCall) MaxResults(maxResults int64) *UsersDraftsListCall

MaxResults sets the optional parameter "maxResults": Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.

func (*UsersDraftsListCall) PageToken

func (c *UsersDraftsListCall) PageToken(pageToken string) *UsersDraftsListCall

PageToken sets the optional parameter "pageToken": Page token to retrieve a specific page of results in the list.

func (*UsersDraftsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*UsersDraftsListCall) Q

Q sets the optional parameter "q": 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".

type UsersDraftsSendCall

type UsersDraftsSendCall struct {
	// contains filtered or unexported fields
}

func (*UsersDraftsSendCall) Context

Context sets the context to be used in this call's Do method. This context will supersede any context previously provided to the ResumableMedia method.

func (*UsersDraftsSendCall) Do

Do executes the "gmail.users.drafts.send" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersDraftsSendCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersDraftsSendCall) Header

func (c *UsersDraftsSendCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersDraftsSendCall) Media

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.

func (*UsersDraftsSendCall) ProgressUpdater

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*UsersDraftsSendCall) ResumableMedia deprecated

func (c *UsersDraftsSendCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *UsersDraftsSendCall

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type UsersDraftsService

type UsersDraftsService struct {
	// contains filtered or unexported fields
}

func NewUsersDraftsService

func NewUsersDraftsService(s *Service) *UsersDraftsService

func (*UsersDraftsService) Create

func (r *UsersDraftsService) Create(userId string, draft *Draft) *UsersDraftsCreateCall

Create: Creates a new draft with the `DRAFT` label.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersDraftsService) Delete

func (r *UsersDraftsService) Delete(userId string, id string) *UsersDraftsDeleteCall

Delete: Immediately and permanently deletes the specified draft. Does not simply trash it.

  • id: The ID of the draft to delete.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersDraftsService) Get

func (r *UsersDraftsService) Get(userId string, id string) *UsersDraftsGetCall

Get: Gets the specified draft.

  • id: The ID of the draft to retrieve.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersDraftsService) List

List: Lists the drafts in the user's mailbox.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersDraftsService) Send

func (r *UsersDraftsService) Send(userId string, draft *Draft) *UsersDraftsSendCall

Send: Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersDraftsService) Update

func (r *UsersDraftsService) Update(userId string, id string, draft *Draft) *UsersDraftsUpdateCall

Update: Replaces a draft's content.

  • id: The ID of the draft to update.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

type UsersDraftsUpdateCall

type UsersDraftsUpdateCall struct {
	// contains filtered or unexported fields
}

func (*UsersDraftsUpdateCall) Context

Context sets the context to be used in this call's Do method. This context will supersede any context previously provided to the ResumableMedia method.

func (*UsersDraftsUpdateCall) Do

Do executes the "gmail.users.drafts.update" call. Any non-2xx status code is an error. Response headers are in either *Draft.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersDraftsUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersDraftsUpdateCall) Header

func (c *UsersDraftsUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersDraftsUpdateCall) Media

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.

func (*UsersDraftsUpdateCall) ProgressUpdater

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*UsersDraftsUpdateCall) ResumableMedia deprecated

func (c *UsersDraftsUpdateCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *UsersDraftsUpdateCall

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type UsersGetProfileCall

type UsersGetProfileCall struct {
	// contains filtered or unexported fields
}

func (*UsersGetProfileCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersGetProfileCall) Do

Do executes the "gmail.users.getProfile" call. Any non-2xx status code is an error. Response headers are in either *Profile.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersGetProfileCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersGetProfileCall) Header

func (c *UsersGetProfileCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersGetProfileCall) IfNoneMatch

func (c *UsersGetProfileCall) IfNoneMatch(entityTag string) *UsersGetProfileCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*UsersGetProfileCall) TemporaryEeccBypass added in v0.177.0

func (c *UsersGetProfileCall) TemporaryEeccBypass(temporaryEeccBypass bool) *UsersGetProfileCall

TemporaryEeccBypass sets the optional parameter "temporaryEeccBypass":

type UsersHistoryListCall

type UsersHistoryListCall struct {
	// contains filtered or unexported fields
}

func (*UsersHistoryListCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersHistoryListCall) Do

Do executes the "gmail.users.history.list" call. Any non-2xx status code is an error. Response headers are in either *ListHistoryResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersHistoryListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersHistoryListCall) Header

func (c *UsersHistoryListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersHistoryListCall) HistoryTypes

func (c *UsersHistoryListCall) HistoryTypes(historyTypes ...string) *UsersHistoryListCall

HistoryTypes sets the optional parameter "historyTypes": History types to be returned by the function

Possible values:

"messageAdded"
"messageDeleted"
"labelAdded"
"labelRemoved"

func (*UsersHistoryListCall) IfNoneMatch

func (c *UsersHistoryListCall) IfNoneMatch(entityTag string) *UsersHistoryListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*UsersHistoryListCall) LabelId

func (c *UsersHistoryListCall) LabelId(labelId string) *UsersHistoryListCall

LabelId sets the optional parameter "labelId": Only return messages with a label matching the ID.

func (*UsersHistoryListCall) MaxResults

func (c *UsersHistoryListCall) MaxResults(maxResults int64) *UsersHistoryListCall

MaxResults sets the optional parameter "maxResults": Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.

func (*UsersHistoryListCall) PageToken

func (c *UsersHistoryListCall) PageToken(pageToken string) *UsersHistoryListCall

PageToken sets the optional parameter "pageToken": Page token to retrieve a specific page of results in the list.

func (*UsersHistoryListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*UsersHistoryListCall) StartHistoryId

func (c *UsersHistoryListCall) StartHistoryId(startHistoryId uint64) *UsersHistoryListCall

StartHistoryId sets the optional parameter "startHistoryId": 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.

type UsersHistoryService

type UsersHistoryService struct {
	// contains filtered or unexported fields
}

func NewUsersHistoryService

func NewUsersHistoryService(s *Service) *UsersHistoryService

func (*UsersHistoryService) List

List: Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`).

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

type UsersLabelsCreateCall

type UsersLabelsCreateCall struct {
	// contains filtered or unexported fields
}

func (*UsersLabelsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersLabelsCreateCall) Do

Do executes the "gmail.users.labels.create" call. Any non-2xx status code is an error. Response headers are in either *Label.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersLabelsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersLabelsCreateCall) Header

func (c *UsersLabelsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersLabelsDeleteCall

type UsersLabelsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersLabelsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersLabelsDeleteCall) Do

Do executes the "gmail.users.labels.delete" call.

func (*UsersLabelsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersLabelsDeleteCall) Header

func (c *UsersLabelsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersLabelsGetCall

type UsersLabelsGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersLabelsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersLabelsGetCall) Do

func (c *UsersLabelsGetCall) Do(opts ...googleapi.CallOption) (*Label, error)

Do executes the "gmail.users.labels.get" call. Any non-2xx status code is an error. Response headers are in either *Label.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersLabelsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersLabelsGetCall) Header

func (c *UsersLabelsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersLabelsGetCall) IfNoneMatch

func (c *UsersLabelsGetCall) IfNoneMatch(entityTag string) *UsersLabelsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersLabelsListCall

type UsersLabelsListCall struct {
	// contains filtered or unexported fields
}

func (*UsersLabelsListCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersLabelsListCall) Do

Do executes the "gmail.users.labels.list" call. Any non-2xx status code is an error. Response headers are in either *ListLabelsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersLabelsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersLabelsListCall) Header

func (c *UsersLabelsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersLabelsListCall) IfNoneMatch

func (c *UsersLabelsListCall) IfNoneMatch(entityTag string) *UsersLabelsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersLabelsPatchCall

type UsersLabelsPatchCall struct {
	// contains filtered or unexported fields
}

func (*UsersLabelsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersLabelsPatchCall) Do

Do executes the "gmail.users.labels.patch" call. Any non-2xx status code is an error. Response headers are in either *Label.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersLabelsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersLabelsPatchCall) Header

func (c *UsersLabelsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersLabelsService

type UsersLabelsService struct {
	// contains filtered or unexported fields
}

func NewUsersLabelsService

func NewUsersLabelsService(s *Service) *UsersLabelsService

func (*UsersLabelsService) Create

func (r *UsersLabelsService) Create(userId string, label *Label) *UsersLabelsCreateCall

Create: Creates a new label.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersLabelsService) Delete

func (r *UsersLabelsService) Delete(userId string, id string) *UsersLabelsDeleteCall

Delete: Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.

  • id: The ID of the label to delete.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersLabelsService) Get

func (r *UsersLabelsService) Get(userId string, id string) *UsersLabelsGetCall

Get: Gets the specified label.

  • id: The ID of the label to retrieve.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersLabelsService) List

List: Lists all labels in the user's mailbox.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersLabelsService) Patch

func (r *UsersLabelsService) Patch(userId string, id string, label *Label) *UsersLabelsPatchCall

Patch: Patch the specified label.

  • id: The ID of the label to update.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersLabelsService) Update

func (r *UsersLabelsService) Update(userId string, id string, label *Label) *UsersLabelsUpdateCall

Update: Updates the specified label.

  • id: The ID of the label to update.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

type UsersLabelsUpdateCall

type UsersLabelsUpdateCall struct {
	// contains filtered or unexported fields
}

func (*UsersLabelsUpdateCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersLabelsUpdateCall) Do

Do executes the "gmail.users.labels.update" call. Any non-2xx status code is an error. Response headers are in either *Label.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersLabelsUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersLabelsUpdateCall) Header

func (c *UsersLabelsUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersMessagesAttachmentsGetCall

type UsersMessagesAttachmentsGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesAttachmentsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersMessagesAttachmentsGetCall) Do

Do executes the "gmail.users.messages.attachments.get" call. Any non-2xx status code is an error. Response headers are in either *MessagePartBody.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersMessagesAttachmentsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesAttachmentsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersMessagesAttachmentsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*UsersMessagesAttachmentsGetCall) TemporaryEeccBypass added in v0.177.0

func (c *UsersMessagesAttachmentsGetCall) TemporaryEeccBypass(temporaryEeccBypass bool) *UsersMessagesAttachmentsGetCall

TemporaryEeccBypass sets the optional parameter "temporaryEeccBypass":

type UsersMessagesAttachmentsService

type UsersMessagesAttachmentsService struct {
	// contains filtered or unexported fields
}

func NewUsersMessagesAttachmentsService

func NewUsersMessagesAttachmentsService(s *Service) *UsersMessagesAttachmentsService

func (*UsersMessagesAttachmentsService) Get

Get: Gets the specified message attachment.

  • id: The ID of the attachment.
  • messageId: The ID of the message containing the attachment.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

type UsersMessagesBatchDeleteCall

type UsersMessagesBatchDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesBatchDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersMessagesBatchDeleteCall) Do

Do executes the "gmail.users.messages.batchDelete" call.

func (*UsersMessagesBatchDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesBatchDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersMessagesBatchModifyCall

type UsersMessagesBatchModifyCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesBatchModifyCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersMessagesBatchModifyCall) Do

Do executes the "gmail.users.messages.batchModify" call.

func (*UsersMessagesBatchModifyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesBatchModifyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersMessagesDeleteCall

type UsersMessagesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersMessagesDeleteCall) Do

Do executes the "gmail.users.messages.delete" call.

func (*UsersMessagesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesDeleteCall) Header

func (c *UsersMessagesDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersMessagesGetCall

type UsersMessagesGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersMessagesGetCall) Do

Do executes the "gmail.users.messages.get" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersMessagesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesGetCall) Format

Format sets the optional parameter "format": The format to return the message in.

Possible values:

"minimal" - Returns only email message ID and labels; does not return the

email headers, body, or payload.

"full" (default) - Returns the full email message data with body content

parsed in the `payload` field; the `raw` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.

"raw" - Returns the full email message data with body content in the `raw`

field as a base64url encoded string; the `payload` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.

"metadata" - Returns only email message ID, labels, and email headers.

func (*UsersMessagesGetCall) Header

func (c *UsersMessagesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersMessagesGetCall) IfNoneMatch

func (c *UsersMessagesGetCall) IfNoneMatch(entityTag string) *UsersMessagesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*UsersMessagesGetCall) MetadataHeaders

func (c *UsersMessagesGetCall) MetadataHeaders(metadataHeaders ...string) *UsersMessagesGetCall

MetadataHeaders sets the optional parameter "metadataHeaders": When given and format is `METADATA`, only include headers specified.

func (*UsersMessagesGetCall) TemporaryEeccBypass added in v0.177.0

func (c *UsersMessagesGetCall) TemporaryEeccBypass(temporaryEeccBypass bool) *UsersMessagesGetCall

TemporaryEeccBypass sets the optional parameter "temporaryEeccBypass":

type UsersMessagesImportCall

type UsersMessagesImportCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesImportCall) Context

Context sets the context to be used in this call's Do method. This context will supersede any context previously provided to the ResumableMedia method.

func (*UsersMessagesImportCall) Deleted

Deleted sets the optional parameter "deleted": Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.

func (*UsersMessagesImportCall) Do

Do executes the "gmail.users.messages.import" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersMessagesImportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesImportCall) Header

func (c *UsersMessagesImportCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersMessagesImportCall) InternalDateSource

func (c *UsersMessagesImportCall) InternalDateSource(internalDateSource string) *UsersMessagesImportCall

InternalDateSource sets the optional parameter "internalDateSource": Source for Gmail's internal date of the message.

Possible values:

"receivedTime" - Internal message date set to current time when received

by Gmail.

"dateHeader" (default) - Internal message time based on 'Date' header in

email, when valid.

func (*UsersMessagesImportCall) Media

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.

func (*UsersMessagesImportCall) NeverMarkSpam

func (c *UsersMessagesImportCall) NeverMarkSpam(neverMarkSpam bool) *UsersMessagesImportCall

NeverMarkSpam sets the optional parameter "neverMarkSpam": Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.

func (*UsersMessagesImportCall) ProcessForCalendar

func (c *UsersMessagesImportCall) ProcessForCalendar(processForCalendar bool) *UsersMessagesImportCall

ProcessForCalendar sets the optional parameter "processForCalendar": Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.

func (*UsersMessagesImportCall) ProgressUpdater

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*UsersMessagesImportCall) ResumableMedia deprecated

func (c *UsersMessagesImportCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *UsersMessagesImportCall

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type UsersMessagesInsertCall

type UsersMessagesInsertCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesInsertCall) Context

Context sets the context to be used in this call's Do method. This context will supersede any context previously provided to the ResumableMedia method.

func (*UsersMessagesInsertCall) Deleted

Deleted sets the optional parameter "deleted": Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.

func (*UsersMessagesInsertCall) Do

Do executes the "gmail.users.messages.insert" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersMessagesInsertCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesInsertCall) Header

func (c *UsersMessagesInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersMessagesInsertCall) InternalDateSource

func (c *UsersMessagesInsertCall) InternalDateSource(internalDateSource string) *UsersMessagesInsertCall

InternalDateSource sets the optional parameter "internalDateSource": Source for Gmail's internal date of the message.

Possible values:

"receivedTime" (default) - Internal message date set to current time when

received by Gmail.

"dateHeader" - Internal message time based on 'Date' header in email, when

valid.

func (*UsersMessagesInsertCall) Media

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.

func (*UsersMessagesInsertCall) ProgressUpdater

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*UsersMessagesInsertCall) ResumableMedia deprecated

func (c *UsersMessagesInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *UsersMessagesInsertCall

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type UsersMessagesListCall

type UsersMessagesListCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesListCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersMessagesListCall) Do

Do executes the "gmail.users.messages.list" call. Any non-2xx status code is an error. Response headers are in either *ListMessagesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersMessagesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesListCall) Header

func (c *UsersMessagesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersMessagesListCall) IfNoneMatch

func (c *UsersMessagesListCall) IfNoneMatch(entityTag string) *UsersMessagesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*UsersMessagesListCall) IncludeSpamTrash

func (c *UsersMessagesListCall) IncludeSpamTrash(includeSpamTrash bool) *UsersMessagesListCall

IncludeSpamTrash sets the optional parameter "includeSpamTrash": Include messages from `SPAM` and `TRASH` in the results.

func (*UsersMessagesListCall) LabelIds

func (c *UsersMessagesListCall) LabelIds(labelIds ...string) *UsersMessagesListCall

LabelIds sets the optional parameter "labelIds": Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see Manage labels on messages and threads (https://developers.google.com/gmail/api/guides/labels#manage_labels_on_messages_threads).

func (*UsersMessagesListCall) MaxResults

func (c *UsersMessagesListCall) MaxResults(maxResults int64) *UsersMessagesListCall

MaxResults sets the optional parameter "maxResults": Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.

func (*UsersMessagesListCall) PageToken

func (c *UsersMessagesListCall) PageToken(pageToken string) *UsersMessagesListCall

PageToken sets the optional parameter "pageToken": Page token to retrieve a specific page of results in the list.

func (*UsersMessagesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*UsersMessagesListCall) Q

Q sets the optional parameter "q": 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.

func (*UsersMessagesListCall) TemporaryEeccBypass added in v0.177.0

func (c *UsersMessagesListCall) TemporaryEeccBypass(temporaryEeccBypass bool) *UsersMessagesListCall

TemporaryEeccBypass sets the optional parameter "temporaryEeccBypass":

type UsersMessagesModifyCall

type UsersMessagesModifyCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesModifyCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersMessagesModifyCall) Do

Do executes the "gmail.users.messages.modify" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersMessagesModifyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesModifyCall) Header

func (c *UsersMessagesModifyCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersMessagesSendCall

type UsersMessagesSendCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesSendCall) Context

Context sets the context to be used in this call's Do method. This context will supersede any context previously provided to the ResumableMedia method.

func (*UsersMessagesSendCall) Do

Do executes the "gmail.users.messages.send" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersMessagesSendCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesSendCall) Header

func (c *UsersMessagesSendCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersMessagesSendCall) Media

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.

func (*UsersMessagesSendCall) ProgressUpdater

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*UsersMessagesSendCall) ResumableMedia deprecated

func (c *UsersMessagesSendCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *UsersMessagesSendCall

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type UsersMessagesService

type UsersMessagesService struct {
	Attachments *UsersMessagesAttachmentsService
	// contains filtered or unexported fields
}

func NewUsersMessagesService

func NewUsersMessagesService(s *Service) *UsersMessagesService

func (*UsersMessagesService) BatchDelete

func (r *UsersMessagesService) BatchDelete(userId string, batchdeletemessagesrequest *BatchDeleteMessagesRequest) *UsersMessagesBatchDeleteCall

BatchDelete: Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) BatchModify

func (r *UsersMessagesService) BatchModify(userId string, batchmodifymessagesrequest *BatchModifyMessagesRequest) *UsersMessagesBatchModifyCall

BatchModify: Modifies the labels on the specified messages.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) Delete

Delete: Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.

  • id: The ID of the message to delete.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) Get

Get: Gets the specified message.

  • id: The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`).
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) Import

func (r *UsersMessagesService) Import(userId string, message *Message) *UsersMessagesImportCall

Import: Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) Insert

func (r *UsersMessagesService) Insert(userId string, message *Message) *UsersMessagesInsertCall

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.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) List

List: Lists the messages in the user's mailbox.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) Modify

func (r *UsersMessagesService) Modify(userId string, id string, modifymessagerequest *ModifyMessageRequest) *UsersMessagesModifyCall

Modify: Modifies the labels on the specified message.

  • id: The ID of the message to modify.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) Send

func (r *UsersMessagesService) Send(userId string, message *Message) *UsersMessagesSendCall

Send: Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For example usage, see Sending email (https://developers.google.com/gmail/api/guides/sending).

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) Trash

Trash: Moves the specified message to the trash.

  • id: The ID of the message to Trash.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersMessagesService) Untrash

Untrash: Removes the specified message from the trash.

  • id: The ID of the message to remove from Trash.
  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

type UsersMessagesTrashCall

type UsersMessagesTrashCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesTrashCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersMessagesTrashCall) Do

Do executes the "gmail.users.messages.trash" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersMessagesTrashCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesTrashCall) Header

func (c *UsersMessagesTrashCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersMessagesUntrashCall

type UsersMessagesUntrashCall struct {
	// contains filtered or unexported fields
}

func (*UsersMessagesUntrashCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersMessagesUntrashCall) Do

Do executes the "gmail.users.messages.untrash" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersMessagesUntrashCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersMessagesUntrashCall) Header

func (c *UsersMessagesUntrashCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersService

type UsersService struct {
	Drafts *UsersDraftsService

	History *UsersHistoryService

	Labels *UsersLabelsService

	Messages *UsersMessagesService

	Settings *UsersSettingsService

	Threads *UsersThreadsService
	// contains filtered or unexported fields
}

func NewUsersService

func NewUsersService(s *Service) *UsersService

func (*UsersService) GetProfile

func (r *UsersService) GetProfile(userId string) *UsersGetProfileCall

GetProfile: Gets the current user's Gmail profile.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersService) Stop

func (r *UsersService) Stop(userId string) *UsersStopCall

Stop: Stop receiving push notifications for the given user mailbox.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

func (*UsersService) Watch

func (r *UsersService) Watch(userId string, watchrequest *WatchRequest) *UsersWatchCall

Watch: Set up or update a push notification watch on the given user mailbox.

  • userId: The user's email address. The special value `me` can be used to indicate the authenticated user.

type UsersSettingsCseIdentitiesCreateCall added in v0.106.0

type UsersSettingsCseIdentitiesCreateCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseIdentitiesCreateCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseIdentitiesCreateCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.identities.create" call. Any non-2xx status code is an error. Response headers are in either *CseIdentity.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsCseIdentitiesCreateCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseIdentitiesCreateCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsCseIdentitiesDeleteCall added in v0.106.0

type UsersSettingsCseIdentitiesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseIdentitiesDeleteCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseIdentitiesDeleteCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.identities.delete" call.

func (*UsersSettingsCseIdentitiesDeleteCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseIdentitiesDeleteCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsCseIdentitiesGetCall added in v0.106.0

type UsersSettingsCseIdentitiesGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseIdentitiesGetCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseIdentitiesGetCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.identities.get" call. Any non-2xx status code is an error. Response headers are in either *CseIdentity.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsCseIdentitiesGetCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseIdentitiesGetCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsCseIdentitiesGetCall) IfNoneMatch added in v0.106.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsCseIdentitiesListCall added in v0.106.0

type UsersSettingsCseIdentitiesListCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseIdentitiesListCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseIdentitiesListCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.identities.list" call. Any non-2xx status code is an error. Response headers are in either *ListCseIdentitiesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsCseIdentitiesListCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseIdentitiesListCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsCseIdentitiesListCall) IfNoneMatch added in v0.106.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*UsersSettingsCseIdentitiesListCall) PageSize added in v0.106.0

PageSize sets the optional parameter "pageSize": The number of identities to return. If not provided, the page size will default to 20 entries.

func (*UsersSettingsCseIdentitiesListCall) PageToken added in v0.106.0

PageToken sets the optional parameter "pageToken": Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.

func (*UsersSettingsCseIdentitiesListCall) Pages added in v0.106.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type UsersSettingsCseIdentitiesPatchCall added in v0.106.0

type UsersSettingsCseIdentitiesPatchCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseIdentitiesPatchCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseIdentitiesPatchCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.identities.patch" call. Any non-2xx status code is an error. Response headers are in either *CseIdentity.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsCseIdentitiesPatchCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseIdentitiesPatchCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsCseIdentitiesService added in v0.106.0

type UsersSettingsCseIdentitiesService struct {
	// contains filtered or unexported fields
}

func NewUsersSettingsCseIdentitiesService added in v0.106.0

func NewUsersSettingsCseIdentitiesService(s *Service) *UsersSettingsCseIdentitiesService

func (*UsersSettingsCseIdentitiesService) Create added in v0.106.0

Create: Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity.

  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

func (*UsersSettingsCseIdentitiesService) Delete added in v0.106.0

Delete: Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration.

  • cseEmailAddress: The primary email address associated with the client-side encryption identity configuration that's removed.
  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

func (*UsersSettingsCseIdentitiesService) Get added in v0.106.0

Get: Retrieves a client-side encryption identity configuration.

  • cseEmailAddress: The primary email address associated with the client-side encryption identity configuration that's retrieved.
  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

func (*UsersSettingsCseIdentitiesService) List added in v0.106.0

List: Lists the client-side encrypted identities for an authenticated user.

  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

func (*UsersSettingsCseIdentitiesService) Patch added in v0.106.0

Patch: Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles (https://support.google.com/a/answer/7300887).

  • emailAddress: The email address of the client-side encryption identity to update.
  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

type UsersSettingsCseKeypairsCreateCall added in v0.106.0

type UsersSettingsCseKeypairsCreateCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseKeypairsCreateCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseKeypairsCreateCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.keypairs.create" call. Any non-2xx status code is an error. Response headers are in either *CseKeyPair.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsCseKeypairsCreateCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseKeypairsCreateCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsCseKeypairsDisableCall added in v0.106.0

type UsersSettingsCseKeypairsDisableCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseKeypairsDisableCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseKeypairsDisableCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.keypairs.disable" call. Any non-2xx status code is an error. Response headers are in either *CseKeyPair.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsCseKeypairsDisableCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseKeypairsDisableCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsCseKeypairsEnableCall added in v0.106.0

type UsersSettingsCseKeypairsEnableCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseKeypairsEnableCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseKeypairsEnableCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.keypairs.enable" call. Any non-2xx status code is an error. Response headers are in either *CseKeyPair.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsCseKeypairsEnableCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseKeypairsEnableCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsCseKeypairsGetCall added in v0.106.0

type UsersSettingsCseKeypairsGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseKeypairsGetCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseKeypairsGetCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.keypairs.get" call. Any non-2xx status code is an error. Response headers are in either *CseKeyPair.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsCseKeypairsGetCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseKeypairsGetCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsCseKeypairsGetCall) IfNoneMatch added in v0.106.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsCseKeypairsListCall added in v0.106.0

type UsersSettingsCseKeypairsListCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseKeypairsListCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseKeypairsListCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.keypairs.list" call. Any non-2xx status code is an error. Response headers are in either *ListCseKeyPairsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsCseKeypairsListCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseKeypairsListCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsCseKeypairsListCall) IfNoneMatch added in v0.106.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*UsersSettingsCseKeypairsListCall) PageSize added in v0.106.0

PageSize sets the optional parameter "pageSize": The number of key pairs to return. If not provided, the page size will default to 20 entries.

func (*UsersSettingsCseKeypairsListCall) PageToken added in v0.106.0

PageToken sets the optional parameter "pageToken": Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.

func (*UsersSettingsCseKeypairsListCall) Pages added in v0.106.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type UsersSettingsCseKeypairsObliterateCall added in v0.106.0

type UsersSettingsCseKeypairsObliterateCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsCseKeypairsObliterateCall) Context added in v0.106.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsCseKeypairsObliterateCall) Do added in v0.106.0

Do executes the "gmail.users.settings.cse.keypairs.obliterate" call.

func (*UsersSettingsCseKeypairsObliterateCall) Fields added in v0.106.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsCseKeypairsObliterateCall) Header added in v0.106.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsCseKeypairsService added in v0.106.0

type UsersSettingsCseKeypairsService struct {
	// contains filtered or unexported fields
}

func NewUsersSettingsCseKeypairsService added in v0.106.0

func NewUsersSettingsCseKeypairsService(s *Service) *UsersSettingsCseKeypairsService

func (*UsersSettingsCseKeypairsService) Create added in v0.106.0

Create: Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.

  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

func (*UsersSettingsCseKeypairsService) Disable added in v0.106.0

func (r *UsersSettingsCseKeypairsService) Disable(userId string, keyPairId string, disablecsekeypairrequest *DisableCseKeyPairRequest) *UsersSettingsCseKeypairsDisableCall

Disable: Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method.

  • keyPairId: The identifier of the key pair to turn off.
  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

func (*UsersSettingsCseKeypairsService) Enable added in v0.106.0

func (r *UsersSettingsCseKeypairsService) Enable(userId string, keyPairId string, enablecsekeypairrequest *EnableCseKeyPairRequest) *UsersSettingsCseKeypairsEnableCall

Enable: Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities.

  • keyPairId: The identifier of the key pair to turn on.
  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

func (*UsersSettingsCseKeypairsService) Get added in v0.106.0

Get: Retrieves an existing client-side encryption key pair.

  • keyPairId: The identifier of the key pair to retrieve.
  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

func (*UsersSettingsCseKeypairsService) List added in v0.106.0

List: Lists client-side encryption key pairs for an authenticated user.

  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

func (*UsersSettingsCseKeypairsService) Obliterate added in v0.106.0

func (r *UsersSettingsCseKeypairsService) Obliterate(userId string, keyPairId string, obliteratecsekeypairrequest *ObliterateCseKeyPairRequest) *UsersSettingsCseKeypairsObliterateCall

Obliterate: Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages.

  • keyPairId: The identifier of the key pair to obliterate.
  • userId: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

type UsersSettingsCseService added in v0.106.0

type UsersSettingsCseService struct {
	Identities *UsersSettingsCseIdentitiesService

	Keypairs *UsersSettingsCseKeypairsService
	// contains filtered or unexported fields
}

func NewUsersSettingsCseService added in v0.106.0

func NewUsersSettingsCseService(s *Service) *UsersSettingsCseService

type UsersSettingsDelegatesCreateCall

type UsersSettingsDelegatesCreateCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsDelegatesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsDelegatesCreateCall) Do

Do executes the "gmail.users.settings.delegates.create" call. Any non-2xx status code is an error. Response headers are in either *Delegate.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsDelegatesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsDelegatesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsDelegatesDeleteCall

type UsersSettingsDelegatesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsDelegatesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsDelegatesDeleteCall) Do

Do executes the "gmail.users.settings.delegates.delete" call.

func (*UsersSettingsDelegatesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsDelegatesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsDelegatesGetCall

type UsersSettingsDelegatesGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsDelegatesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsDelegatesGetCall) Do

Do executes the "gmail.users.settings.delegates.get" call. Any non-2xx status code is an error. Response headers are in either *Delegate.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsDelegatesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsDelegatesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsDelegatesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsDelegatesListCall

type UsersSettingsDelegatesListCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsDelegatesListCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsDelegatesListCall) Do

Do executes the "gmail.users.settings.delegates.list" call. Any non-2xx status code is an error. Response headers are in either *ListDelegatesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsDelegatesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsDelegatesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsDelegatesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsDelegatesService

type UsersSettingsDelegatesService struct {
	// contains filtered or unexported fields
}

func NewUsersSettingsDelegatesService

func NewUsersSettingsDelegatesService(s *Service) *UsersSettingsDelegatesService

func (*UsersSettingsDelegatesService) Create

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 Google Workspace organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a Google Workspace 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.

  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

func (*UsersSettingsDelegatesService) Delete

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.

  • delegateEmail: The email address of the user to be removed as a delegate.
  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

func (*UsersSettingsDelegatesService) Get

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.

  • delegateEmail: The email address of the user whose delegate relationship is to be retrieved.
  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

func (*UsersSettingsDelegatesService) List

List: Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.

  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

type UsersSettingsFiltersCreateCall

type UsersSettingsFiltersCreateCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsFiltersCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsFiltersCreateCall) Do

Do executes the "gmail.users.settings.filters.create" call. Any non-2xx status code is an error. Response headers are in either *Filter.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsFiltersCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsFiltersCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsFiltersDeleteCall

type UsersSettingsFiltersDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsFiltersDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsFiltersDeleteCall) Do

Do executes the "gmail.users.settings.filters.delete" call.

func (*UsersSettingsFiltersDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsFiltersDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsFiltersGetCall

type UsersSettingsFiltersGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsFiltersGetCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsFiltersGetCall) Do

Do executes the "gmail.users.settings.filters.get" call. Any non-2xx status code is an error. Response headers are in either *Filter.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsFiltersGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsFiltersGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsFiltersGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsFiltersListCall

type UsersSettingsFiltersListCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsFiltersListCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsFiltersListCall) Do

Do executes the "gmail.users.settings.filters.list" call. Any non-2xx status code is an error. Response headers are in either *ListFiltersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsFiltersListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsFiltersListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsFiltersListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsFiltersService

type UsersSettingsFiltersService struct {
	// contains filtered or unexported fields
}

func NewUsersSettingsFiltersService

func NewUsersSettingsFiltersService(s *Service) *UsersSettingsFiltersService

func (*UsersSettingsFiltersService) Create

Create: Creates a filter. Note: you can only create a maximum of 1,000 filters.

  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

func (*UsersSettingsFiltersService) Delete

Delete: Immediately and permanently deletes the specified filter.

  • id: The ID of the filter to be deleted.
  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

func (*UsersSettingsFiltersService) Get

Get: Gets a filter.

  • id: The ID of the filter to be fetched.
  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

func (*UsersSettingsFiltersService) List

List: Lists the message filters of a Gmail user.

  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

type UsersSettingsForwardingAddressesCreateCall

type UsersSettingsForwardingAddressesCreateCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsForwardingAddressesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsForwardingAddressesCreateCall) Do

Do executes the "gmail.users.settings.forwardingAddresses.create" call. Any non-2xx status code is an error. Response headers are in either *ForwardingAddress.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsForwardingAddressesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsForwardingAddressesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsForwardingAddressesDeleteCall

type UsersSettingsForwardingAddressesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsForwardingAddressesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsForwardingAddressesDeleteCall) Do

Do executes the "gmail.users.settings.forwardingAddresses.delete" call.

func (*UsersSettingsForwardingAddressesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsForwardingAddressesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsForwardingAddressesGetCall

type UsersSettingsForwardingAddressesGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsForwardingAddressesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsForwardingAddressesGetCall) Do

Do executes the "gmail.users.settings.forwardingAddresses.get" call. Any non-2xx status code is an error. Response headers are in either *ForwardingAddress.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsForwardingAddressesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsForwardingAddressesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsForwardingAddressesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsForwardingAddressesListCall

type UsersSettingsForwardingAddressesListCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsForwardingAddressesListCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsForwardingAddressesListCall) Do

Do executes the "gmail.users.settings.forwardingAddresses.list" call. Any non-2xx status code is an error. Response headers are in either *ListForwardingAddressesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsForwardingAddressesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsForwardingAddressesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsForwardingAddressesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsForwardingAddressesService

type UsersSettingsForwardingAddressesService struct {
	// contains filtered or unexported fields
}

func NewUsersSettingsForwardingAddressesService

func NewUsersSettingsForwardingAddressesService(s *Service) *UsersSettingsForwardingAddressesService

func (*UsersSettingsForwardingAddressesService) Create

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.

  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

func (*UsersSettingsForwardingAddressesService) Delete

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.

  • forwardingEmail: The forwarding address to be deleted.
  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

func (*UsersSettingsForwardingAddressesService) Get

Get: Gets the specified forwarding address.

  • forwardingEmail: The forwarding address to be retrieved.
  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

func (*UsersSettingsForwardingAddressesService) List

List: Lists the forwarding addresses for the specified account.

  • userId: User's email address. The special value "me" can be used to indicate the authenticated user.

type UsersSettingsGetAutoForwardingCall

type UsersSettingsGetAutoForwardingCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsGetAutoForwardingCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsGetAutoForwardingCall) Do

Do executes the "gmail.users.settings.getAutoForwarding" call. Any non-2xx status code is an error. Response headers are in either *AutoForwarding.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsGetAutoForwardingCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsGetAutoForwardingCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsGetAutoForwardingCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsGetImapCall

type UsersSettingsGetImapCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsGetImapCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsGetImapCall) Do

Do executes the "gmail.users.settings.getImap" call. Any non-2xx status code is an error. Response headers are in either *ImapSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsGetImapCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsGetImapCall) Header

func (c *UsersSettingsGetImapCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsGetImapCall) IfNoneMatch

func (c *UsersSettingsGetImapCall) IfNoneMatch(entityTag string) *UsersSettingsGetImapCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsGetLanguageCall added in v0.5.0

type UsersSettingsGetLanguageCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsGetLanguageCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method.

func (*UsersSettingsGetLanguageCall) Do added in v0.5.0

Do executes the "gmail.users.settings.getLanguage" call. Any non-2xx status code is an error. Response headers are in either *LanguageSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsGetLanguageCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsGetLanguageCall) Header added in v0.5.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsGetLanguageCall) IfNoneMatch added in v0.5.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsGetPopCall

type UsersSettingsGetPopCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsGetPopCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsGetPopCall) Do

Do executes the "gmail.users.settings.getPop" call. Any non-2xx status code is an error. Response headers are in either *PopSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsGetPopCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsGetPopCall) Header

func (c *UsersSettingsGetPopCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsGetPopCall) IfNoneMatch

func (c *UsersSettingsGetPopCall) IfNoneMatch(entityTag string) *UsersSettingsGetPopCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsGetVacationCall

type UsersSettingsGetVacationCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsGetVacationCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsGetVacationCall) Do

Do executes the "gmail.users.settings.getVacation" call. Any non-2xx status code is an error. Response headers are in either *VacationSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsGetVacationCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsGetVacationCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersSettingsGetVacationCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersSettingsSendAsCreateCall

type UsersSettingsSendAsCreateCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsSendAsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsSendAsCreateCall) Do

Do executes the "gmail.users.settings.sendAs.create" call. Any non-2xx status code is an error. Response headers are in either *SendAs.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersSettingsSendAsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsSendAsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsSendAsDeleteCall

type UsersSettingsSendAsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsSendAsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsSendAsDeleteCall) Do

Do executes the "gmail.users.settings.sendAs.delete" call.

func (*UsersSettingsSendAsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersSettingsSendAsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersSettingsSendAsGetCall

type UsersSettingsSendAsGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersSettingsSendAsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*UsersSettingsSendAsGetCall) Do

Do executes the "gmail.users.settings.sendAs.get" call. Any non-2xx status code is an error. Response