Class: Google::Apis::GmailV1::GmailService

Inherits:

Core::BaseService

Object
Core::BaseService
Google::Apis::GmailV1::GmailService

show all

Defined in:: lib/google/apis/gmail_v1/service.rb

Overview

Gmail API

The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.

Examples:

require 'google/apis/gmail_v1'

Gmail = Google::Apis::GmailV1 # Alias the module
service = Gmail::GmailService.new

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =

"https://gmail.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.

Instance Method Summary collapse

#batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes many messages by message ID.
#batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Modifies the labels and the Classification Label values on the specified messages.
#create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Draft
Creates a draft with the DRAFT label.
#create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Label
Creates a label.
#create_user_setting_cse_identity(user_id, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseIdentity
Creates and configures a client-side encryption identity that's authorized to send mail from the user account.
#create_user_setting_cse_keypair(user_id, cse_key_pair_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseKeyPair
Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.
#create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Delegate
Adds a delegate with its verification status set directly to accepted, without sending any verification email.
#create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Filter
Creates a filter.
#create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ForwardingAddress
Creates a forwarding address.
#create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SendAs
Creates a custom "from" send-as alias.
#delete_user_draft(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Immediately and permanently deletes the specified draft.
#delete_user_label(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Immediately and permanently deletes the specified label and removes it from any messages and threads that it's applied to.
#delete_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Immediately and permanently deletes the specified message.
#delete_user_setting_cse_identity(user_id, cse_email_address, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes a client-side encryption identity.
#delete_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it.
#delete_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Immediately and permanently deletes the specified filter.
#delete_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes the specified forwarding address and revokes any verification that may have been required.
#delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes the specified S/MIME config for the specified send-as alias.
#delete_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes the specified send-as alias.
#delete_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Immediately and permanently deletes the specified thread.
#disable_keypair_cse_key_pair(user_id, key_pair_id, disable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseKeyPair
Turns off a client-side encryption key pair.
#enable_keypair_cse_key_pair(user_id, key_pair_id, enable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseKeyPair
Turns on a client-side encryption key pair that was turned off.
#get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Draft
Gets the specified draft.
#get_user_label(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Label
Gets the specified label.
#get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message
Gets the specified message.
#get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::MessagePartBody
Gets the specified message attachment.
#get_user_profile(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Profile
Gets the current user's Gmail profile.
#get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::AutoForwarding
Gets the auto-forwarding setting for the specified account.
#get_user_setting_cse_identity(user_id, cse_email_address, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseIdentity
Retrieves a client-side encryption identity configuration.
#get_user_setting_cse_keypair(user_id, key_pair_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseKeyPair
Retrieves an existing client-side encryption key pair.
#get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Delegate
Gets the specified delegate.
#get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Filter
Gets a filter.
#get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ForwardingAddress
Gets the specified forwarding address.
#get_user_setting_imap(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ImapSettings
Gets IMAP settings.
#get_user_setting_language(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::LanguageSettings
Gets language settings.
#get_user_setting_pop(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::PopSettings
Gets POP settings.
#get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SmimeInfo
Gets the specified S/MIME config for the specified send-as alias.
#get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SendAs
Gets the specified send-as alias.
#get_user_setting_vacation(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::VacationSettings
Gets vacation responder settings.
#get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Thread
Gets the specified thread.
#import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message
Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP.
#initialize ⇒ GmailService constructor
A new instance of GmailService.
#insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message
Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification.
#insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SmimeInfo
Insert (upload) the given S/MIME config for the specified send-as alias.
#list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListDraftsResponse
Lists the drafts in the user's mailbox.
#list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListHistoryResponse
Lists the history of all changes to the given mailbox.
#list_user_labels(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListLabelsResponse
Lists all labels in the user's mailbox.
#list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListMessagesResponse
Lists the messages in the user's mailbox.
#list_user_setting_cse_identities(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListCseIdentitiesResponse
Lists the client-side encrypted identities for an authenticated user.
#list_user_setting_cse_keypairs(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListCseKeyPairsResponse
Lists client-side encryption key pairs for an authenticated user.
#list_user_setting_delegates(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListDelegatesResponse
Lists the delegates for the specified account.
#list_user_setting_filters(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListFiltersResponse
Lists the message filters of a Gmail user.
#list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListForwardingAddressesResponse
Lists the forwarding addresses for the specified account.
#list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListSmimeInfoResponse
Lists S/MIME configs for the specified send-as alias.
#list_user_setting_send_as(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListSendAsResponse
Lists the send-as aliases for the specified account.
#list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListThreadsResponse
Lists the threads in the user's mailbox.
#modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message
Modifies the labels and the Classification Label values on the specified message.
#modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Thread
Modifies the labels applied to the thread.
#obliterate_keypair_cse_key_pair(user_id, key_pair_id, obliterate_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes a client-side encryption key pair permanently and immediately.
#patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Label
Patch the specified label.
#patch_user_setting_cse_identity(user_id, email_address, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseIdentity
Associates a different key pair with an existing client-side encryption identity.
#patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SendAs
Patch the specified send-as alias.
#send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message
Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.
#send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message
Sends the specified message to the recipients in the To, Cc, and Bcc headers.
#set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Sets the default S/MIME config for the specified send-as alias.
#stop_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Turn off push notification delivery for the given user mailbox.
#trash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message
Moves the specified message to the trash.
#trash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Thread
Moves the specified thread to the trash.
#untrash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message
Removes the specified message from the trash.
#untrash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Thread
Removes the specified thread from the trash.
#update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Draft
Replaces a draft's content.
#update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Label
Updates the specified label.
#update_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::AutoForwarding
Updates the auto-forwarding setting for the specified account.
#update_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ImapSettings
Updates IMAP settings.
#update_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::LanguageSettings
Updates language settings.
#update_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::PopSettings
Updates POP settings.
#update_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SendAs
Updates a send-as alias.
#update_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::VacationSettings
Updates vacation responder settings.
#verify_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Sends a verification email to the specified send-as alias address.
#watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::WatchResponse
Set up or update a push notification watch on the given user mailbox.

Constructor Details

#initialize ⇒ `GmailService`

Returns a new instance of GmailService.

# File 'lib/google/apis/gmail_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-gmail_v1',
        client_version: Google::Apis::GmailV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ `String`

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

(String) —
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



41
42
43

# File 'lib/google/apis/gmail_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ `String`

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

(String) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



46
47
48

# File 'lib/google/apis/gmail_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

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

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
batch_delete_messages_request_object (Google::Apis::GmailV1::BatchDeleteMessagesRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 708

def batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/batchDelete', options)
  command.request_representation = Google::Apis::GmailV1::BatchDeleteMessagesRequest::Representation
  command.request_object = batch_delete_messages_request_object
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Modifies the labels and the Classification Label values on the specified messages. For administrators modifying messages for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.modify.restricted scope.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
batch_modify_messages_request_object (Google::Apis::GmailV1::BatchModifyMessagesRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 746

def batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/batchModify', options)
  command.request_representation = Google::Apis::GmailV1::BatchModifyMessagesRequest::Representation
  command.request_object = batch_modify_messages_request_object
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Draft`

Creates a draft with the DRAFT label. For more information, see Create and send draft emails.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
draft_object (Google::Apis::GmailV1::Draft) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_source (IO, String) (defaults to: nil) —
IO stream or filename containing content to upload
content_type (String) (defaults to: nil) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Draft) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Draft)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 181

def create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'gmail/v1/users/{userId}/drafts', options)
  else
    command = make_upload_command(:post, 'gmail/v1/users/{userId}/drafts', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::GmailV1::Draft::Representation
  command.request_object = draft_object
  command.response_representation = Google::Apis::GmailV1::Draft::Representation
  command.response_class = Google::Apis::GmailV1::Draft
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Label`

Creates a label. For more information, see Manage labels.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
label_object (Google::Apis::GmailV1::Label) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Label) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Label)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 495

def create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/labels', options)
  command.request_representation = Google::Apis::GmailV1::Label::Representation
  command.request_object = label_object
  command.response_representation = Google::Apis::GmailV1::Label::Representation
  command.response_class = Google::Apis::GmailV1::Label
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user_setting_cse_identity(user_id, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseIdentity`

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. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https: //www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
cse_identity_object (Google::Apis::GmailV1::CseIdentity) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::CseIdentity) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::CseIdentity)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1581

def create_user_setting_cse_identity(user_id, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/cse/identities', options)
  command.request_representation = Google::Apis::GmailV1::CseIdentity::Representation
  command.request_object = cse_identity_object
  command.response_representation = Google::Apis::GmailV1::CseIdentity::Representation
  command.response_class = Google::Apis::GmailV1::CseIdentity
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user_setting_cse_keypair(user_id, cse_key_pair_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseKeyPair`

Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https: //www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
cse_key_pair_object (Google::Apis::GmailV1::CseKeyPair) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::CseKeyPair) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::CseKeyPair)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1807

def create_user_setting_cse_keypair(user_id, cse_key_pair_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/cse/keypairs', options)
  command.request_representation = Google::Apis::GmailV1::CseKeyPair::Representation
  command.request_object = cse_key_pair_object
  command.response_representation = Google::Apis::GmailV1::CseKeyPair::Representation
  command.response_class = Google::Apis::GmailV1::CseKeyPair
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Delegate`

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. For more information, see Manage delegates. 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. A delegate user must be referred to by their primary email address, and not an email alias. 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.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
delegate_object (Google::Apis::GmailV1::Delegate) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Delegate) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Delegate)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2086

def create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/delegates', options)
  command.request_representation = Google::Apis::GmailV1::Delegate::Representation
  command.request_object = delegate_object
  command.response_representation = Google::Apis::GmailV1::Delegate::Representation
  command.response_class = Google::Apis::GmailV1::Delegate
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Filter`

Creates a filter. Note: you can only create a maximum of 1,000 filters. For more information, see Manage Gmail filters.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
filter_object (Google::Apis::GmailV1::Filter) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Filter) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Filter)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2232

def create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/filters', options)
  command.request_representation = Google::Apis::GmailV1::Filter::Representation
  command.request_object = filter_object
  command.response_representation = Google::Apis::GmailV1::Filter::Representation
  command.response_class = Google::Apis::GmailV1::Filter
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ForwardingAddress`

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. For more information, see Manage email forwarding. This method is only available to service account clients that have been delegated domain-wide authority.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
forwarding_address_object (Google::Apis::GmailV1::ForwardingAddress) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ForwardingAddress) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ForwardingAddress)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2374

def create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/forwardingAddresses', options)
  command.request_representation = Google::Apis::GmailV1::ForwardingAddress::Representation
  command.request_object = forwarding_address_object
  command.response_representation = Google::Apis::GmailV1::ForwardingAddress::Representation
  command.response_class = Google::Apis::GmailV1::ForwardingAddress
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SendAs`

Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. For more information, see Manage aliases and signatures with the Gmail API. This method is only available to service account clients that have been delegated domain-wide authority.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_object (Google::Apis::GmailV1::SendAs) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::SendAs) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::SendAs)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2523

def create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs', options)
  command.request_representation = Google::Apis::GmailV1::SendAs::Representation
  command.request_object = send_as_object
  command.response_representation = Google::Apis::GmailV1::SendAs::Representation
  command.response_class = Google::Apis::GmailV1::SendAs
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_draft(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Immediately and permanently deletes the specified draft. Does not simply trash it. For more information, see Create and send draft emails.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the draft to delete.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 224

def delete_user_draft(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/drafts/{id}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_label(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Immediately and permanently deletes the specified label and removes it from any messages and threads that it's applied to. For more information, see Manage labels .

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the label to delete.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 533

def delete_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/labels/{id}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

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

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the message to delete.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 780

def delete_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/messages/{id}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_setting_cse_identity(user_id, cse_email_address, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

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. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https: //www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
cse_email_address (String) —
The primary email address associated with the client-side encryption identity configuration that's removed.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1628

def delete_user_setting_cse_identity(user_id, cse_email_address, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['cseEmailAddress'] = cse_email_address unless cse_email_address.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. For more information, see Manage delegates. 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.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
delegate_email (String) —
The email address of the user to be removed as a delegate.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2127

def delete_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/delegates/{delegateEmail}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['delegateEmail'] = delegate_email unless delegate_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Immediately and permanently deletes the specified filter. For more information, see Manage Gmail filters.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
id (String) —
The ID of the filter to be deleted.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2269

def delete_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/filters/{id}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes the specified forwarding address and revokes any verification that may have been required. For more information, see Manage email forwarding. This method is only available to service account clients that have been delegated domain-wide authority.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
forwarding_email (String) —
The forwarding address to be deleted.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2413

def delete_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['forwardingEmail'] = forwarding_email unless forwarding_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes the specified S/MIME config for the specified send-as alias. For more information, see Manage S/MIME certificates with the Gmail API.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (String) —
The email address that appears in the "From:" header for mail sent using this alias.
id (String) —
The immutable ID for the SmimeInfo.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2789

def delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes the specified send-as alias. Revokes any verification that may have been required for using it. For more information, see Manage aliases and signatures with the Gmail API. This method is only available to service account clients that have been delegated domain-wide authority.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (String) —
The send-as alias to be deleted.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2562

def delete_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer threads.trash instead. For more information, see Manage threads.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
ID of the Thread to delete.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2981

def delete_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'gmail/v1/users/{userId}/threads/{id}', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#disable_keypair_cse_key_pair(user_id, key_pair_id, disable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseKeyPair`

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. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/ auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
key_pair_id (String) —
The identifier of the key pair to turn off.
disable_cse_key_pair_request_object (Google::Apis::GmailV1::DisableCseKeyPairRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::CseKeyPair) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::CseKeyPair)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1855

def disable_keypair_cse_key_pair(user_id, key_pair_id, disable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable', options)
  command.request_representation = Google::Apis::GmailV1::DisableCseKeyPairRequest::Representation
  command.request_object = disable_cse_key_pair_request_object
  command.response_representation = Google::Apis::GmailV1::CseKeyPair::Representation
  command.response_class = Google::Apis::GmailV1::CseKeyPair
  command.params['userId'] = user_id unless user_id.nil?
  command.params['keyPairId'] = key_pair_id unless key_pair_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_keypair_cse_key_pair(user_id, key_pair_id, enable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseKeyPair`

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. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
key_pair_id (String) —
The identifier of the key pair to turn on.
enable_cse_key_pair_request_object (Google::Apis::GmailV1::EnableCseKeyPairRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::CseKeyPair) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::CseKeyPair)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1902

def enable_keypair_cse_key_pair(user_id, key_pair_id, enable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable', options)
  command.request_representation = Google::Apis::GmailV1::EnableCseKeyPairRequest::Representation
  command.request_object = enable_cse_key_pair_request_object
  command.response_representation = Google::Apis::GmailV1::CseKeyPair::Representation
  command.response_class = Google::Apis::GmailV1::CseKeyPair
  command.params['userId'] = user_id unless user_id.nil?
  command.params['keyPairId'] = key_pair_id unless key_pair_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Draft`

Gets the specified draft. For more information, see Create and send draft emails.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the draft to retrieve.
format (String) (defaults to: nil) —
The format to return the draft in.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Draft) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Draft)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 259

def get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/drafts/{id}', options)
  command.response_representation = Google::Apis::GmailV1::Draft::Representation
  command.response_class = Google::Apis::GmailV1::Draft
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['format'] = format unless format.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_label(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Label`

Gets the specified label. For more information, see Manage labels.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the label to retrieve.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Label) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Label)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 566

def get_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/labels/{id}', options)
  command.response_representation = Google::Apis::GmailV1::Label::Representation
  command.response_class = Google::Apis::GmailV1::Label
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

Gets the specified message.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
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).
format (String) (defaults to: nil) —
The format to return the message in.
metadata_headers (Array<String>, String) (defaults to: nil) —
When given and format is METADATA, only include headers specified.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Message) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Message)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 818

def get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages/{id}', options)
  command.response_representation = Google::Apis::GmailV1::Message::Representation
  command.response_class = Google::Apis::GmailV1::Message
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['format'] = format unless format.nil?
  command.query['metadataHeaders'] = metadata_headers unless metadata_headers.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::MessagePartBody`

Gets the specified message attachment.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
message_id (String) —
The ID of the message containing the attachment.
id (String) —
The ID of the attachment.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::MessagePartBody) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::MessagePartBody)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1186

def get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}', options)
  command.response_representation = Google::Apis::GmailV1::MessagePartBody::Representation
  command.response_class = Google::Apis::GmailV1::MessagePartBody
  command.params['userId'] = user_id unless user_id.nil?
  command.params['messageId'] = message_id unless message_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_profile(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Profile`

Gets the current user's Gmail profile.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Profile) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Profile)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 76

def get_user_profile(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/profile', options)
  command.response_representation = Google::Apis::GmailV1::Profile::Representation
  command.response_class = Google::Apis::GmailV1::Profile
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::AutoForwarding`

Gets the auto-forwarding setting for the specified account. For more information, see Manage email forwarding.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::AutoForwarding) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::AutoForwarding)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1221

def get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/autoForwarding', options)
  command.response_representation = Google::Apis::GmailV1::AutoForwarding::Representation
  command.response_class = Google::Apis::GmailV1::AutoForwarding
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_cse_identity(user_id, cse_email_address, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseIdentity`

Retrieves a client-side encryption identity configuration. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https: //www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
cse_email_address (String) —
The primary email address associated with the client-side encryption identity configuration that's retrieved.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::CseIdentity) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::CseIdentity)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1669

def get_user_setting_cse_identity(user_id, cse_email_address, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}', options)
  command.response_representation = Google::Apis::GmailV1::CseIdentity::Representation
  command.response_class = Google::Apis::GmailV1::CseIdentity
  command.params['userId'] = user_id unless user_id.nil?
  command.params['cseEmailAddress'] = cse_email_address unless cse_email_address.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_cse_keypair(user_id, key_pair_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseKeyPair`

Retrieves an existing client-side encryption key pair. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https: //www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
key_pair_id (String) —
The identifier of the key pair to retrieve.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::CseKeyPair) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::CseKeyPair)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1946

def get_user_setting_cse_keypair(user_id, key_pair_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}', options)
  command.response_representation = Google::Apis::GmailV1::CseKeyPair::Representation
  command.response_class = Google::Apis::GmailV1::CseKeyPair
  command.params['userId'] = user_id unless user_id.nil?
  command.params['keyPairId'] = key_pair_id unless key_pair_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Delegate`

Gets the specified delegate. For more information, see Manage delegates. 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.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
delegate_email (String) —
The email address of the user whose delegate relationship is to be retrieved.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Delegate) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Delegate)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2163

def get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/delegates/{delegateEmail}', options)
  command.response_representation = Google::Apis::GmailV1::Delegate::Representation
  command.response_class = Google::Apis::GmailV1::Delegate
  command.params['userId'] = user_id unless user_id.nil?
  command.params['delegateEmail'] = delegate_email unless delegate_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Filter`

Gets a filter. For more information, see Manage Gmail filters.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
id (String) —
The ID of the filter to be fetched.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Filter) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Filter)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2302

def get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/filters/{id}', options)
  command.response_representation = Google::Apis::GmailV1::Filter::Representation
  command.response_class = Google::Apis::GmailV1::Filter
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ForwardingAddress`

Gets the specified forwarding address. For more information, see Manage email forwarding.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
forwarding_email (String) —
The forwarding address to be retrieved.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ForwardingAddress) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ForwardingAddress)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2447

def get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}', options)
  command.response_representation = Google::Apis::GmailV1::ForwardingAddress::Representation
  command.response_class = Google::Apis::GmailV1::ForwardingAddress
  command.params['userId'] = user_id unless user_id.nil?
  command.params['forwardingEmail'] = forwarding_email unless forwarding_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_imap(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ImapSettings`

Gets IMAP settings. For more information, see Configure POP and IMAP settings with the Gmail API.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ImapSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ImapSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1254

def get_user_setting_imap(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/imap', options)
  command.response_representation = Google::Apis::GmailV1::ImapSettings::Representation
  command.response_class = Google::Apis::GmailV1::ImapSettings
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_language(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::LanguageSettings`

Gets language settings. For more information, see Manage language settings.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::LanguageSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::LanguageSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1286

def get_user_setting_language(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/language', options)
  command.response_representation = Google::Apis::GmailV1::LanguageSettings::Representation
  command.response_class = Google::Apis::GmailV1::LanguageSettings
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_pop(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::PopSettings`

Gets POP settings. For more information, see Configure POP and IMAP settings with the Gmail API.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::PopSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::PopSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1319

def get_user_setting_pop(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/pop', options)
  command.response_representation = Google::Apis::GmailV1::PopSettings::Representation
  command.response_class = Google::Apis::GmailV1::PopSettings
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SmimeInfo`

Gets the specified S/MIME config for the specified send-as alias. For more information, see Manage S/MIME certificates with the Gmail API.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (String) —
The email address that appears in the "From:" header for mail sent using this alias.
id (String) —
The immutable ID for the SmimeInfo.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::SmimeInfo) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::SmimeInfo)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2827

def get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options)
  command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation
  command.response_class = Google::Apis::GmailV1::SmimeInfo
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SendAs`

Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. For more information, see Manage aliases and signatures with the Gmail API.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (String) —
The send-as alias to be retrieved.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::SendAs) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::SendAs)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2597

def get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options)
  command.response_representation = Google::Apis::GmailV1::SendAs::Representation
  command.response_class = Google::Apis::GmailV1::SendAs
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_setting_vacation(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::VacationSettings`

Gets vacation responder settings. For more information, see Manage vacation settings with the Gmail API.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::VacationSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::VacationSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1352

def get_user_setting_vacation(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/vacation', options)
  command.response_representation = Google::Apis::GmailV1::VacationSettings::Representation
  command.response_class = Google::Apis::GmailV1::VacationSettings
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Thread`

Gets the specified thread. For more information, see Manage threads.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the thread to retrieve.
format (String) (defaults to: nil) —
The format to return the messages in.
metadata_headers (Array<String>, String) (defaults to: nil) —
When given and format is METADATA, only include headers specified.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Thread) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Thread)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 3018

def get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/threads/{id}', options)
  command.response_representation = Google::Apis::GmailV1::Thread::Representation
  command.response_class = Google::Apis::GmailV1::Thread
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['format'] = format unless format.nil?
  command.query['metadataHeaders'] = metadata_headers unless metadata_headers.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

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. Note that the maximum size of the message is 150 MB.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
message_object (Google::Apis::GmailV1::Message) (defaults to: nil)
deleted (Boolean) (defaults to: nil) —
Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
internal_date_source (String) (defaults to: nil) —
Source for Gmail's internal date of the message.
never_mark_spam (Boolean) (defaults to: nil) —
Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
process_for_calendar (Boolean) (defaults to: nil) —
Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_source (IO, String) (defaults to: nil) —
IO stream or filename containing content to upload
content_type (String) (defaults to: nil) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Message) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Message)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 872

def import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/import', options)
  else
    command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages/import', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::GmailV1::Message::Representation
  command.request_object = message_object
  command.response_representation = Google::Apis::GmailV1::Message::Representation
  command.response_class = Google::Apis::GmailV1::Message
  command.params['userId'] = user_id unless user_id.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['internalDateSource'] = internal_date_source unless internal_date_source.nil?
  command.query['neverMarkSpam'] = never_mark_spam unless never_mark_spam.nil?
  command.query['processForCalendar'] = process_for_calendar unless process_for_calendar.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. For more information, see Create and send email messages.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
message_object (Google::Apis::GmailV1::Message) (defaults to: nil)
deleted (Boolean) (defaults to: nil) —
Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
internal_date_source (String) (defaults to: nil) —
Source for Gmail's internal date of the message.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_source (IO, String) (defaults to: nil) —
IO stream or filename containing content to upload
content_type (String) (defaults to: nil) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Message) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Message)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 928

def insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages', options)
  else
    command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::GmailV1::Message::Representation
  command.request_object = message_object
  command.response_representation = Google::Apis::GmailV1::Message::Representation
  command.response_class = Google::Apis::GmailV1::Message
  command.params['userId'] = user_id unless user_id.nil?
  command.query['deleted'] = deleted unless deleted.nil?
  command.query['internalDateSource'] = internal_date_source unless internal_date_source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SmimeInfo`

Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key. For more information, see Manage S/MIME certificates with the Gmail API.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (String) —
The email address that appears in the "From:" header for mail sent using this alias.
smime_info_object (Google::Apis::GmailV1::SmimeInfo) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::SmimeInfo) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::SmimeInfo)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2867

def insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options)
  command.request_representation = Google::Apis::GmailV1::SmimeInfo::Representation
  command.request_object = smime_info_object
  command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation
  command.response_class = Google::Apis::GmailV1::SmimeInfo
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListDraftsResponse`

Lists the drafts in the user's mailbox. For more information, see Create and send draft emails.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
include_spam_trash (Boolean) (defaults to: nil) —
Include drafts from SPAM and TRASH in the results.
max_results (Fixnum) (defaults to: nil) —
Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.
page_token (String) (defaults to: nil) —
Page token to retrieve a specific page of results in the list.
q (String) (defaults to: nil) —
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".
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListDraftsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListDraftsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 305

def list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/drafts', options)
  command.response_representation = Google::Apis::GmailV1::ListDraftsResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListDraftsResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['includeSpamTrash'] = include_spam_trash unless include_spam_trash.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListHistoryResponse`

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). For more information, see Synchronize clients with Gmail.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
history_types (Array<String>, String) (defaults to: nil) —
History types to be returned by the function
label_id (String) (defaults to: nil) —
Only return messages with a label matching the ID.
max_results (Fixnum) (defaults to: nil) —
Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.
page_token (String) (defaults to: nil) —
Page token to retrieve a specific page of results in the list.
start_history_id (Fixnum) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListHistoryResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListHistoryResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 457

def list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/history', options)
  command.response_representation = Google::Apis::GmailV1::ListHistoryResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListHistoryResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['historyTypes'] = history_types unless history_types.nil?
  command.query['labelId'] = label_id unless label_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startHistoryId'] = start_history_id unless start_history_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_labels(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListLabelsResponse`

Lists all labels in the user's mailbox. For more information, see Manage labels.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListLabelsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListLabelsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 599

def list_user_labels(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/labels', options)
  command.response_representation = Google::Apis::GmailV1::ListLabelsResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListLabelsResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListMessagesResponse`

Lists the messages in the user's mailbox. For more information, see List Gmail messages.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
include_spam_trash (Boolean) (defaults to: nil) —
Include messages from SPAM and TRASH in the results.
label_ids (Array<String>, String) (defaults to: nil) —
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.
max_results (Fixnum) (defaults to: nil) —
Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.
page_token (String) (defaults to: nil) —
Page token to retrieve a specific page of results in the list.
q (String) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListMessagesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListMessagesResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 989

def list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages', options)
  command.response_representation = Google::Apis::GmailV1::ListMessagesResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListMessagesResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['includeSpamTrash'] = include_spam_trash unless include_spam_trash.nil?
  command.query['labelIds'] = label_ids unless label_ids.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_setting_cse_identities(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListCseIdentitiesResponse`

Lists the client-side encrypted identities for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
page_size (Fixnum) (defaults to: nil) —
The number of identities to return. If not provided, the page size will default to 20 entries.
page_token (String) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListCseIdentitiesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListCseIdentitiesResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1716

def list_user_setting_cse_identities(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/cse/identities', options)
  command.response_representation = Google::Apis::GmailV1::ListCseIdentitiesResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListCseIdentitiesResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_setting_cse_keypairs(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListCseKeyPairsResponse`

Lists client-side encryption key pairs for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
page_size (Fixnum) (defaults to: nil) —
The number of key pairs to return. If not provided, the page size will default to 20 entries.
page_token (String) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListCseKeyPairsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListCseKeyPairsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1993

def list_user_setting_cse_keypairs(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/cse/keypairs', options)
  command.response_representation = Google::Apis::GmailV1::ListCseKeyPairsResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListCseKeyPairsResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_setting_delegates(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListDelegatesResponse`

Lists the delegates for the specified account. For more information, see Manage delegates. This method is only available to service account clients that have been delegated domain-wide authority.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListDelegatesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListDelegatesResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2198

def list_user_setting_delegates(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/delegates', options)
  command.response_representation = Google::Apis::GmailV1::ListDelegatesResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListDelegatesResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_setting_filters(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListFiltersResponse`

Lists the message filters of a Gmail user. For more information, see Manage Gmail filters.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListFiltersResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListFiltersResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2336

def list_user_setting_filters(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/filters', options)
  command.response_representation = Google::Apis::GmailV1::ListFiltersResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListFiltersResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListForwardingAddressesResponse`

Lists the forwarding addresses for the specified account. For more information, see Manage email forwarding.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListForwardingAddressesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListForwardingAddressesResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2481

def list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/forwardingAddresses', options)
  command.response_representation = Google::Apis::GmailV1::ListForwardingAddressesResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListForwardingAddressesResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListSmimeInfoResponse`

Lists S/MIME configs for the specified send-as alias. For more information, see Manage S/MIME certificates with the Gmail API.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (String) —
The email address that appears in the "From:" header for mail sent using this alias.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListSmimeInfoResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListSmimeInfoResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2906

def list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options)
  command.response_representation = Google::Apis::GmailV1::ListSmimeInfoResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListSmimeInfoResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_setting_send_as(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListSendAsResponse`

Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom " from" aliases. For more information, see Manage aliases and signatures with the Gmail API.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListSendAsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListSendAsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2633

def list_user_setting_send_as(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs', options)
  command.response_representation = Google::Apis::GmailV1::ListSendAsResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListSendAsResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListThreadsResponse`

Lists the threads in the user's mailbox. For more information, see Manage threads.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
include_spam_trash (Boolean) (defaults to: nil) —
Include threads from SPAM and TRASH in the results.
label_ids (Array<String>, String) (defaults to: nil) —
Only return threads with labels that match all of the specified label IDs.
max_results (Fixnum) (defaults to: nil) —
Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500.
page_token (String) (defaults to: nil) —
Page token to retrieve a specific page of results in the list.
q (String) (defaults to: nil) —
Only return threads 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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ListThreadsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ListThreadsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 3067

def list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'gmail/v1/users/{userId}/threads', options)
  command.response_representation = Google::Apis::GmailV1::ListThreadsResponse::Representation
  command.response_class = Google::Apis::GmailV1::ListThreadsResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['includeSpamTrash'] = include_spam_trash unless include_spam_trash.nil?
  command.query['labelIds'] = label_ids unless label_ids.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

Modifies the labels and the Classification Label values on the specified message. For administrators modifying message for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https: //www.googleapis.com/auth/gmail.modify.restricted scope.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the message to modify.
modify_message_request_object (Google::Apis::GmailV1::ModifyMessageRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Message) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Message)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1034

def modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/modify', options)
  command.request_representation = Google::Apis::GmailV1::ModifyMessageRequest::Representation
  command.request_object = modify_message_request_object
  command.response_representation = Google::Apis::GmailV1::Message::Representation
  command.response_class = Google::Apis::GmailV1::Message
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Thread`

Modifies the labels applied to the thread. This applies to all messages in the thread. For more information, see Manage threads.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the thread to modify.
modify_thread_request_object (Google::Apis::GmailV1::ModifyThreadRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Thread) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Thread)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 3108

def modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/threads/{id}/modify', options)
  command.request_representation = Google::Apis::GmailV1::ModifyThreadRequest::Representation
  command.request_object = modify_thread_request_object
  command.response_representation = Google::Apis::GmailV1::Thread::Representation
  command.response_class = Google::Apis::GmailV1::Thread
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#obliterate_keypair_cse_key_pair(user_id, key_pair_id, obliterate_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

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. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/ auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
key_pair_id (String) —
The identifier of the key pair to obliterate.
obliterate_cse_key_pair_request_object (Google::Apis::GmailV1::ObliterateCseKeyPairRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2042

def obliterate_keypair_cse_key_pair(user_id, key_pair_id, obliterate_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate', options)
  command.request_representation = Google::Apis::GmailV1::ObliterateCseKeyPairRequest::Representation
  command.request_object = obliterate_cse_key_pair_request_object
  command.params['userId'] = user_id unless user_id.nil?
  command.params['keyPairId'] = key_pair_id unless key_pair_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Label`

Patch the specified label. For more information, see Manage labels.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the label to update.
label_object (Google::Apis::GmailV1::Label) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Label) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Label)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 634

def patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'gmail/v1/users/{userId}/labels/{id}', options)
  command.request_representation = Google::Apis::GmailV1::Label::Representation
  command.request_object = label_object
  command.response_representation = Google::Apis::GmailV1::Label::Representation
  command.response_class = Google::Apis::GmailV1::Label
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_setting_cse_identity(user_id, email_address, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseIdentity`

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. For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account that has domain-wide delegation authority to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic scope. For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.

Parameters:

user_id (String) —
The requester's primary email address. To indicate the authenticated user, you can use the special value me.
email_address (String) —
The email address of the client-side encryption identity to update.
cse_identity_object (Google::Apis::GmailV1::CseIdentity) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::CseIdentity) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::CseIdentity)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1763

def patch_user_setting_cse_identity(user_id, email_address, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}', options)
  command.request_representation = Google::Apis::GmailV1::CseIdentity::Representation
  command.request_object = cse_identity_object
  command.response_representation = Google::Apis::GmailV1::CseIdentity::Representation
  command.response_class = Google::Apis::GmailV1::CseIdentity
  command.params['userId'] = user_id unless user_id.nil?
  command.params['emailAddress'] = email_address unless email_address.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SendAs`

Patch the specified send-as alias. For more information, see Manage aliases and signatures with the Gmail API.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (String) —
The send-as alias to be updated.
send_as_object (Google::Apis::GmailV1::SendAs) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::SendAs) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::SendAs)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2669

def patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options)
  command.request_representation = Google::Apis::GmailV1::SendAs::Representation
  command.request_object = send_as_object
  command.response_representation = Google::Apis::GmailV1::SendAs::Representation
  command.response_class = Google::Apis::GmailV1::SendAs
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. For more information, see Create and send draft emails.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
draft_object (Google::Apis::GmailV1::Draft) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_source (IO, String) (defaults to: nil) —
IO stream or filename containing content to upload
content_type (String) (defaults to: nil) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Message) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Message)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 347

def send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'gmail/v1/users/{userId}/drafts/send', options)
  else
    command = make_upload_command(:post, 'gmail/v1/users/{userId}/drafts/send', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::GmailV1::Draft::Representation
  command.request_object = draft_object
  command.response_representation = Google::Apis::GmailV1::Message::Representation
  command.response_class = Google::Apis::GmailV1::Message
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

Sends the specified message to the recipients in the To, Cc, and Bcc headers. For more information, see Create and send email messages.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
message_object (Google::Apis::GmailV1::Message) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_source (IO, String) (defaults to: nil) —
IO stream or filename containing content to upload
content_type (String) (defaults to: nil) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Message) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Message)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1075

def send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/send', options)
  else
    command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages/send', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::GmailV1::Message::Representation
  command.request_object = message_object
  command.response_representation = Google::Apis::GmailV1::Message::Representation
  command.response_class = Google::Apis::GmailV1::Message
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Sets the default S/MIME config for the specified send-as alias. For more information, see Manage S/MIME certificates with the Gmail API.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (String) —
The email address that appears in the "From:" header for mail sent using this alias.
id (String) —
The immutable ID for the SmimeInfo.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2945

def set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Turn off push notification delivery for the given user mailbox. For more information, see Configure push notifications in Gmail API.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 109

def stop_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/stop', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#trash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

Moves the specified message to the trash.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the message to Trash.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Message) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Message)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1116

def trash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/trash', options)
  command.response_representation = Google::Apis::GmailV1::Message::Representation
  command.response_class = Google::Apis::GmailV1::Message
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#trash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Thread`

Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. For more information, see Manage threads.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the thread to Trash.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Thread) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Thread)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 3146

def trash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/threads/{id}/trash', options)
  command.response_representation = Google::Apis::GmailV1::Thread::Representation
  command.response_class = Google::Apis::GmailV1::Thread
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#untrash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

Removes the specified message from the trash.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the message to remove from Trash.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Message) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Message)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1150

def untrash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/untrash', options)
  command.response_representation = Google::Apis::GmailV1::Message::Representation
  command.response_class = Google::Apis::GmailV1::Message
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#untrash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Thread`

Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash. For more information, see Manage threads.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the thread to remove from Trash.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Thread) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Thread)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 3182

def untrash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/threads/{id}/untrash', options)
  command.response_representation = Google::Apis::GmailV1::Thread::Representation
  command.response_class = Google::Apis::GmailV1::Thread
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Draft`

Replaces a draft's content. For more information, see Create and send draft emails.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the draft to update.
draft_object (Google::Apis::GmailV1::Draft) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_source (IO, String) (defaults to: nil) —
IO stream or filename containing content to upload
content_type (String) (defaults to: nil) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Draft) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Draft)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 394

def update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:put, 'gmail/v1/users/{userId}/drafts/{id}', options)
  else
    command = make_upload_command(:put, 'gmail/v1/users/{userId}/drafts/{id}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::GmailV1::Draft::Representation
  command.request_object = draft_object
  command.response_representation = Google::Apis::GmailV1::Draft::Representation
  command.response_class = Google::Apis::GmailV1::Draft
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Label`

Updates the specified label. For more information, see Manage labels.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
id (String) —
The ID of the label to update.
label_object (Google::Apis::GmailV1::Label) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::Label) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::Label)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 672

def update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'gmail/v1/users/{userId}/labels/{id}', options)
  command.request_representation = Google::Apis::GmailV1::Label::Representation
  command.request_object = label_object
  command.response_representation = Google::Apis::GmailV1::Label::Representation
  command.response_class = Google::Apis::GmailV1::Label
  command.params['userId'] = user_id unless user_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::AutoForwarding`

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. For more information, see Manage email forwarding. This method is only available to service account clients that have been delegated domain-wide authority.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
auto_forwarding_object (Google::Apis::GmailV1::AutoForwarding) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::AutoForwarding) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::AutoForwarding)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1388

def update_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/autoForwarding', options)
  command.request_representation = Google::Apis::GmailV1::AutoForwarding::Representation
  command.request_object = auto_forwarding_object
  command.response_representation = Google::Apis::GmailV1::AutoForwarding::Representation
  command.response_class = Google::Apis::GmailV1::AutoForwarding
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ImapSettings`

Updates IMAP settings. For more information, see Configure POP and IMAP settings with the Gmail API.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
imap_settings_object (Google::Apis::GmailV1::ImapSettings) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::ImapSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::ImapSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1424

def update_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/imap', options)
  command.request_representation = Google::Apis::GmailV1::ImapSettings::Representation
  command.request_object = imap_settings_object
  command.response_representation = Google::Apis::GmailV1::ImapSettings::Representation
  command.response_class = Google::Apis::GmailV1::ImapSettings
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::LanguageSettings`

Updates language settings. For more information, see Manage language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
language_settings_object (Google::Apis::GmailV1::LanguageSettings) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::LanguageSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::LanguageSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1464

def update_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/language', options)
  command.request_representation = Google::Apis::GmailV1::LanguageSettings::Representation
  command.request_object = language_settings_object
  command.response_representation = Google::Apis::GmailV1::LanguageSettings::Representation
  command.response_class = Google::Apis::GmailV1::LanguageSettings
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::PopSettings`

Updates POP settings. For more information, see Configure POP and IMAP settings with the Gmail API.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
pop_settings_object (Google::Apis::GmailV1::PopSettings) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::PopSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::PopSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1500

def update_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/pop', options)
  command.request_representation = Google::Apis::GmailV1::PopSettings::Representation
  command.request_object = pop_settings_object
  command.response_representation = Google::Apis::GmailV1::PopSettings::Representation
  command.response_class = Google::Apis::GmailV1::PopSettings
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SendAs`

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. For more information, see Manage aliases and signatures with the Gmail API. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (String) —
The send-as alias to be updated.
send_as_object (Google::Apis::GmailV1::SendAs) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::SendAs) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::SendAs)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2711

def update_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options)
  command.request_representation = Google::Apis::GmailV1::SendAs::Representation
  command.request_object = send_as_object
  command.response_representation = Google::Apis::GmailV1::SendAs::Representation
  command.response_class = Google::Apis::GmailV1::SendAs
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::VacationSettings`

Updates vacation responder settings. For more information, see Manage vacation settings with the Gmail API.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
vacation_settings_object (Google::Apis::GmailV1::VacationSettings) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::VacationSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::VacationSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 1536

def update_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/vacation', options)
  command.request_representation = Google::Apis::GmailV1::VacationSettings::Representation
  command.request_object = vacation_settings_object
  command.response_representation = Google::Apis::GmailV1::VacationSettings::Representation
  command.response_class = Google::Apis::GmailV1::VacationSettings
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#verify_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Sends a verification email to the specified send-as alias address. The verification status must be pending. For more information, see Manage aliases and signatures with the Gmail API. This method is only available to service account clients that have been delegated domain-wide authority.

Parameters:

user_id (String) —
User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (String) —
The send-as alias to be verified.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 2752

def verify_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify', options)
  command.params['userId'] = user_id unless user_id.nil?
  command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::WatchResponse`

Set up or update a push notification watch on the given user mailbox. For more information, see Configure push notifications in Gmail API.

Parameters:

user_id (String) —
The user's email address. The special value me can be used to indicate the authenticated user.
watch_request_object (Google::Apis::GmailV1::WatchRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::GmailV1::WatchResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GmailV1::WatchResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/gmail_v1/service.rb', line 141

def watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'gmail/v1/users/{userId}/watch', options)
  command.request_representation = Google::Apis::GmailV1::WatchRequest::Representation
  command.request_object = watch_request_object
  command.response_representation = Google::Apis::GmailV1::WatchResponse::Representation
  command.response_class = Google::Apis::GmailV1::WatchResponse
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Class: Google::Apis::GmailV1::GmailService

Overview

Examples:

Constant Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GmailService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

Instance Method Details

#batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Draft

#create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Label

#create_user_setting_cse_identity(user_id, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseIdentity

#create_user_setting_cse_keypair(user_id, cse_key_pair_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseKeyPair

#create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Delegate

#create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Filter

#create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ForwardingAddress

#create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SendAs

#delete_user_draft(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_user_label(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_user_setting_cse_identity(user_id, cse_email_address, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#disable_keypair_cse_key_pair(user_id, key_pair_id, disable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseKeyPair

#enable_keypair_cse_key_pair(user_id, key_pair_id, enable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseKeyPair

#get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Draft

#get_user_label(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Label

#get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message

#get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::MessagePartBody

#get_user_profile(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Profile

#get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::AutoForwarding

#get_user_setting_cse_identity(user_id, cse_email_address, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseIdentity

#get_user_setting_cse_keypair(user_id, key_pair_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseKeyPair

#get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Delegate

#get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Filter

#get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ForwardingAddress

#get_user_setting_imap(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ImapSettings

#get_user_setting_language(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::LanguageSettings

#get_user_setting_pop(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::PopSettings

#get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SmimeInfo

#get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SendAs

#get_user_setting_vacation(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::VacationSettings

#get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Thread

#import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message

#insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message

#insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SmimeInfo

#list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListDraftsResponse

#list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListHistoryResponse

#list_user_labels(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListLabelsResponse

#list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListMessagesResponse

#list_user_setting_cse_identities(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListCseIdentitiesResponse

#list_user_setting_cse_keypairs(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListCseKeyPairsResponse

#list_user_setting_delegates(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListDelegatesResponse

#list_user_setting_filters(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListFiltersResponse

#list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListForwardingAddressesResponse

#list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListSmimeInfoResponse

#list_user_setting_send_as(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListSendAsResponse

#list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::ListThreadsResponse

#modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message

#modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Thread

#obliterate_keypair_cse_key_pair(user_id, key_pair_id, obliterate_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Label

#patch_user_setting_cse_identity(user_id, email_address, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::CseIdentity

#patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::SendAs

#send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message

#send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message

#set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#stop_user(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#trash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message

#trash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Thread

#untrash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GmailV1::Message

#initialize ⇒ `GmailService`

#key ⇒ `String`

#quota_user ⇒ `String`

#create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Draft`

#create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Label`

#create_user_setting_cse_identity(user_id, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseIdentity`

#create_user_setting_cse_keypair(user_id, cse_key_pair_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseKeyPair`

#create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Delegate`

#create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Filter`

#create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ForwardingAddress`

#create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SendAs`

#disable_keypair_cse_key_pair(user_id, key_pair_id, disable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseKeyPair`

#enable_keypair_cse_key_pair(user_id, key_pair_id, enable_cse_key_pair_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseKeyPair`

#get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Draft`

#get_user_label(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Label`

#get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

#get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::MessagePartBody`

#get_user_profile(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Profile`

#get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::AutoForwarding`

#get_user_setting_cse_identity(user_id, cse_email_address, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseIdentity`

#get_user_setting_cse_keypair(user_id, key_pair_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseKeyPair`

#get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Delegate`

#get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Filter`

#get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ForwardingAddress`

#get_user_setting_imap(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ImapSettings`

#get_user_setting_language(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::LanguageSettings`

#get_user_setting_pop(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::PopSettings`

#get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SmimeInfo`

#get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SendAs`

#get_user_setting_vacation(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::VacationSettings`

#get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Thread`

#import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

#insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

#insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SmimeInfo`

#list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListDraftsResponse`

#list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListHistoryResponse`

#list_user_labels(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListLabelsResponse`

#list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListMessagesResponse`

#list_user_setting_cse_identities(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListCseIdentitiesResponse`

#list_user_setting_cse_keypairs(user_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListCseKeyPairsResponse`

#list_user_setting_delegates(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListDelegatesResponse`

#list_user_setting_filters(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListFiltersResponse`

#list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListForwardingAddressesResponse`

#list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListSmimeInfoResponse`

#list_user_setting_send_as(user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListSendAsResponse`

#list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ListThreadsResponse`

#modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

#modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Thread`

#patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Label`

#patch_user_setting_cse_identity(user_id, email_address, cse_identity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::CseIdentity`

#patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SendAs`

#send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

#send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

#trash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

#trash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Thread`

#untrash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Message`

#untrash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Thread`

#update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Draft`

#update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::Label`

#update_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::AutoForwarding`

#update_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::ImapSettings`

#update_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::LanguageSettings`

#update_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::PopSettings`

#update_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::SendAs`

#update_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::VacationSettings`

#watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GmailV1::WatchResponse`