generated/google/apis/gmail_v1/service.rb in google-api-client-0.42.2 vs generated/google/apis/gmail_v1/service.rb in google-api-client-0.43.0

- old
+ new

@@ -20,12 +20,12 @@ module Google module Apis module GmailV1 # Gmail API # - # The Gmail API lets you view and manage Gmail mailbox data like - # threads, messages, and labels. + # The Gmail API lets you view and manage Gmail mailbox data like threads, + # messages, and labels. # # @example # require 'google/apis/gmail_v1' # # Gmail = Google::Apis::GmailV1 # Alias the module @@ -48,12 +48,12 @@ @batch_path = 'batch/gmail/v1' end # Gets the current user's Gmail profile. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -79,12 +79,12 @@ execute_or_queue_command(command, &block) end # Stop receiving push notifications for the given user mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -108,12 +108,12 @@ execute_or_queue_command(command, &block) end # Set up or update a push notification watch on the given user mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::WatchRequest] watch_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -142,12 +142,12 @@ execute_or_queue_command(command, &block) end # Creates a new draft with the `DRAFT` label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Draft] draft_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -184,15 +184,15 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Immediately and permanently deletes the specified draft. - # Does not simply trash it. + # Immediately and permanently deletes the specified draft. Does not simply trash + # it. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the draft to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -219,12 +219,12 @@ execute_or_queue_command(command, &block) end # Gets the specified draft. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the draft to retrieve. # @param [String] format # The format to return the draft in. # @param [String] fields @@ -256,24 +256,22 @@ execute_or_queue_command(command, &block) end # Lists the drafts in the user's mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Boolean] include_spam_trash - # Include drafts from `SPAM` and `TRASH` - # in the results. + # Include drafts from `SPAM` and `TRASH` in the results. # @param [Fixnum] max_results # Maximum number of drafts to return. # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q # Only return draft messages matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> - # is:unread"`. + # query format as the Gmail search box. For example, `"from:someuser@example.com + # rfc822msgid: is:unread"`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -301,15 +299,15 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Sends the specified, existing draft to the recipients in the - # `To`, `Cc`, and `Bcc` headers. + # Sends the specified, existing draft to the recipients in the `To`, `Cc`, and ` + # Bcc` headers. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Draft] draft_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -348,12 +346,12 @@ execute_or_queue_command(command, &block) end # Replaces a draft's content. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the draft to update. # @param [Google::Apis::GmailV1::Draft] draft_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -396,34 +394,31 @@ end # Lists the history of all changes to the given mailbox. History results are # returned in chronological order (increasing `historyId`). # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Array<String>, String] history_types # History types to be returned by the function # @param [String] label_id # Only return messages with a label matching the ID. # @param [Fixnum] max_results # The maximum number of history records to return. # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [Fixnum] start_history_id - # 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. + # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -454,12 +449,12 @@ execute_or_queue_command(command, &block) end # Creates a new label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Label] label_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -489,12 +484,12 @@ end # Immediately and permanently deletes the specified label and removes it from # any messages and threads that it is applied to. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -521,12 +516,12 @@ execute_or_queue_command(command, &block) end # Gets the specified label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to retrieve. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -555,12 +550,12 @@ execute_or_queue_command(command, &block) end # Lists all labels in the user's mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -586,12 +581,12 @@ execute_or_queue_command(command, &block) end # Patch the specified label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to update. # @param [Google::Apis::GmailV1::Label] label_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -623,12 +618,12 @@ execute_or_queue_command(command, &block) end # Updates the specified label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to update. # @param [Google::Apis::GmailV1::Label] label_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -658,15 +653,15 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Deletes many messages by message ID. Provides no guarantees that messages - # were not already deleted or even existed at all. + # Deletes many messages by message ID. Provides no guarantees that messages were + # not already deleted or even existed at all. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::BatchDeleteMessagesRequest] batch_delete_messages_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -693,12 +688,12 @@ execute_or_queue_command(command, &block) end # Modifies the labels on the specified messages. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::BatchModifyMessagesRequest] batch_modify_messages_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -724,14 +719,14 @@ command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Immediately and permanently deletes the specified message. This operation - # cannot be undone. Prefer `messages.trash` instead. + # cannot be undone. Prefer `messages.trash` instead. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -758,19 +753,18 @@ execute_or_queue_command(command, &block) end # Gets the specified message. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to retrieve. # @param [String] format # The format to return the message in. # @param [Array<String>, String] metadata_headers - # When given and format is `METADATA`, only include headers - # specified. + # When given and format is `METADATA`, only include headers specified. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -797,30 +791,28 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Imports a message into only this user's mailbox, with standard - # email delivery scanning and classification similar to receiving via SMTP. - # Does not send a message. + # Imports a message into only this user's mailbox, with standard email delivery + # scanning and classification similar to receiving via SMTP. Does not send a + # message. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [Boolean] deleted - # Mark the email as permanently deleted (not TRASH) and - # only visible in - # <a href="http://support.google.com/vault/">Google Vault</a> to - # a Vault administrator. Only used for G Suite accounts. + # Mark the email as permanently deleted (not TRASH) and only visible in Google + # Vault to a Vault administrator. Only used for G Suite accounts. # @param [String] internal_date_source # Source for Gmail's internal date of the message. # @param [Boolean] never_mark_spam - # Ignore the Gmail spam classifier decision and never mark - # this email as SPAM in the mailbox. + # Ignore the Gmail spam classifier decision and never mark this email as SPAM in + # the mailbox. # @param [Boolean] process_for_calendar - # Process calendar invites in the email and add any extracted - # meetings to the Google Calendar for this user. + # Process calendar invites in the email and add any extracted meetings to the + # Google Calendar for this user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -860,22 +852,19 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Directly inserts a message into only this user's mailbox similar to - # `IMAP APPEND`, bypassing most scanning and classification. - # Does not send a 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. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [Boolean] deleted - # Mark the email as permanently deleted (not TRASH) and - # only visible in - # <a href="http://support.google.com/vault/">Google Vault</a> to - # a Vault administrator. Only used for G Suite accounts. + # Mark the email as permanently deleted (not TRASH) and only visible in Google + # Vault to a Vault administrator. Only used for G Suite accounts. # @param [String] internal_date_source # Source for Gmail's internal date of the message. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -917,26 +906,24 @@ execute_or_queue_command(command, &block) end # Lists the messages in the user's mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Boolean] include_spam_trash - # Include messages from `SPAM` and `TRASH` - # in the results. + # Include messages from `SPAM` and `TRASH` in the results. # @param [Array<String>, String] label_ids # Only return messages with labels that match all of the specified label IDs. # @param [Fixnum] max_results # Maximum number of messages to return. # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q - # Only return messages matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> - # is:unread"`. Parameter cannot be used when accessing the api + # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -968,12 +955,12 @@ execute_or_queue_command(command, &block) end # Modifies the labels on the specified message. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to modify. # @param [Google::Apis::GmailV1::ModifyMessageRequest] modify_message_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1003,15 +990,15 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Sends the specified message to the recipients in the - # `To`, `Cc`, and `Bcc` headers. + # Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` + # headers. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1050,12 +1037,12 @@ execute_or_queue_command(command, &block) end # Moves the specified message to the trash. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to Trash. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1084,12 +1071,12 @@ execute_or_queue_command(command, &block) end # Removes the specified message from the trash. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to remove from Trash. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1118,12 +1105,12 @@ execute_or_queue_command(command, &block) end # Gets the specified message attachment. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] message_id # The ID of the message containing the attachment. # @param [String] id # The ID of the attachment. # @param [String] fields @@ -1155,12 +1142,12 @@ execute_or_queue_command(command, &block) end # Gets the auto-forwarding setting for the specified account. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -1186,12 +1173,12 @@ execute_or_queue_command(command, &block) end # Gets IMAP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -1217,12 +1204,12 @@ execute_or_queue_command(command, &block) end # Gets language settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -1248,12 +1235,12 @@ execute_or_queue_command(command, &block) end # Gets POP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -1279,12 +1266,12 @@ execute_or_queue_command(command, &block) end # Gets vacation responder settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -1308,17 +1295,17 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Updates the auto-forwarding setting for the specified account. A verified - # forwarding address must be specified when auto-forwarding is enabled. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Updates the auto-forwarding setting for the specified account. A verified + # forwarding address must be specified when auto-forwarding is enabled. This + # method is only available to service account clients that have been delegated + # domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::AutoForwarding] auto_forwarding_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1347,12 +1334,12 @@ execute_or_queue_command(command, &block) end # Updates IMAP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::ImapSettings] imap_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1379,19 +1366,18 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Updates 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 + # Updates 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. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::LanguageSettings] language_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1420,12 +1406,12 @@ execute_or_queue_command(command, &block) end # Updates POP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::PopSettings] pop_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1454,12 +1440,12 @@ execute_or_queue_command(command, &block) end # Updates vacation responder settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::VacationSettings] vacation_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1486,27 +1472,24 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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 G Suite organization as the - # delegator user. - # Gmail imposes limitations on the number of delegates and delegators each - # user in a G Suite organization can have. These limits depend on your - # organization, but in general each user can have up to 25 delegates and - # up to 10 delegators. - # Note that a delegate user must be referred to by their primary email - # address, and not an email alias. - # Also note that when a new delegate is created, there may be up to a one - # minute delay before the new delegate is available for use. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # 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 G Suite organization as the delegator user. Gmail imposes limitations + # on the number of delegates and delegators each user in a G Suite organization + # can have. These limits depend on your organization, but in general each user + # can have up to 25 delegates and up to 10 delegators. Note that a delegate user + # must be referred to by their primary email address, and not an email alias. + # Also note that when a new delegate is created, there may be up to a one minute + # delay before the new delegate is available for use. This method is only + # available to service account clients that have been delegated domain-wide + # authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Delegate] delegate_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1533,19 +1516,18 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Removes the specified delegate (which can be of any verification status), - # and revokes any verification that may have been required for using it. - # Note that a delegate user must be referred to by their primary email - # address, and not an email alias. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Removes the specified delegate (which can be of any verification status), and + # revokes any verification that may have been required for using it. Note that a + # delegate user must be referred to by their primary email address, and not an + # email alias. This method is only available to service account clients that + # have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] delegate_email # The email address of the user to be removed as a delegate. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1570,21 +1552,19 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Gets the specified delegate. - # Note that a delegate user must be referred to by their primary email - # address, and not an email alias. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Gets the specified delegate. Note that a delegate user must be referred to by + # their primary email address, and not an email alias. This method is only + # available to service account clients that have been delegated domain-wide + # authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] delegate_email - # The email address of the user whose delegate relationship is to be - # retrieved. + # The email address of the user whose delegate relationship is to be retrieved. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -1609,16 +1589,15 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Lists the delegates for the specified account. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Lists the delegates for the specified account. This method is only available + # to service account clients that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -1644,12 +1623,12 @@ execute_or_queue_command(command, &block) end # Creates a filter. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Filter] filter_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1678,12 +1657,12 @@ execute_or_queue_command(command, &block) end # Deletes a filter. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] id # The ID of the filter to be deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1710,12 +1689,12 @@ execute_or_queue_command(command, &block) end # Gets a filter. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] id # The ID of the filter to be fetched. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1744,12 +1723,12 @@ execute_or_queue_command(command, &block) end # Lists the message filters of a Gmail user. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -1773,19 +1752,18 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Creates a forwarding address. If ownership verification is required, a - # message will be sent to the recipient and the resource's verification - # status will be set to `pending`; otherwise, the resource will be - # created with verification status set to `accepted`. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Creates a forwarding address. If ownership verification is required, a message + # will be sent to the recipient and the resource's verification status will be + # set to `pending`; otherwise, the resource will be created with verification + # status set to `accepted`. This method is only available to service account + # clients that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::ForwardingAddress] forwarding_address_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1812,17 +1790,16 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Deletes the specified forwarding address and revokes any verification that - # may have been required. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Deletes the specified forwarding address and revokes any verification that may + # have been required. This method is only available to service account clients + # that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] forwarding_email # The forwarding address to be deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1849,12 +1826,12 @@ execute_or_queue_command(command, &block) end # Gets the specified forwarding address. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] forwarding_email # The forwarding address to be retrieved. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1883,12 +1860,12 @@ execute_or_queue_command(command, &block) end # Lists the forwarding addresses for the specified account. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -1912,23 +1889,22 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # 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. This method is only + # available to service account clients that have been delegated domain-wide + # authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::SendAs] send_as_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -1955,17 +1931,16 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Deletes the specified send-as alias. Revokes any verification that may - # have been required for using it. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Deletes the specified send-as alias. Revokes any verification that may have + # been required for using it. This method is only available to service account + # clients that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1990,15 +1965,15 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Gets the specified send-as alias. Fails with an HTTP 404 error if the + # Gets the specified send-as alias. Fails with an HTTP 404 error if the # specified address is not a member of the collection. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be retrieved. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2025,16 +2000,16 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -2060,12 +2035,12 @@ execute_or_queue_command(command, &block) end # Patch the specified send-as alias. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be updated. # @param [Google::Apis::GmailV1::SendAs] send_as_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2095,18 +2070,17 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Updates a send-as alias. If a signature is provided, Gmail will sanitize - # the HTML before saving it with the alias. - # Addresses other than the primary address for the account can only be - # updated by service account clients that have been delegated domain-wide - # authority. + # Updates a send-as alias. If a signature is provided, Gmail will sanitize the + # HTML before saving it with the alias. Addresses other than the primary address + # for the account can only be updated by service account clients that have been + # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be updated. # @param [Google::Apis::GmailV1::SendAs] send_as_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2136,17 +2110,16 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Sends a verification email to the specified send-as alias address. - # The verification status must be `pending`. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Sends a verification email to the specified send-as alias address. The + # verification status must be `pending`. This method is only available to + # service account clients that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be verified. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2173,15 +2146,15 @@ execute_or_queue_command(command, &block) end # Deletes the specified S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] id # The immutable ID for the SmimeInfo. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2209,15 +2182,15 @@ execute_or_queue_command(command, &block) end # Gets the specified S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] id # The immutable ID for the SmimeInfo. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2245,18 +2218,18 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Insert (upload) the given S/MIME config for the specified send-as alias. - # Note that pkcs12 format is required for the key. + # Insert (upload) the given S/MIME config for the specified send-as alias. Note + # that pkcs12 format is required for the key. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [Google::Apis::GmailV1::SmimeInfo] smime_info_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -2286,15 +2259,15 @@ execute_or_queue_command(command, &block) end # Lists S/MIME configs for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. @@ -2321,15 +2294,15 @@ execute_or_queue_command(command, &block) end # Sets the default S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] id # The immutable ID for the SmimeInfo. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2358,12 +2331,12 @@ end # Immediately and permanently deletes the specified thread. This operation # cannot be undone. Prefer `threads.trash` instead. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # ID of the Thread to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2390,12 +2363,12 @@ execute_or_queue_command(command, &block) end # Gets the specified thread. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to retrieve. # @param [String] format # The format to return the messages in. # @param [Array<String>, String] metadata_headers @@ -2430,26 +2403,24 @@ execute_or_queue_command(command, &block) end # Lists the threads in the user's mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Boolean] include_spam_trash - # Include threads from `SPAM` and `TRASH` - # in the results. + # Include threads from `SPAM` and `TRASH` in the results. # @param [Array<String>, String] label_ids # Only return threads with labels that match all of the specified label IDs. # @param [Fixnum] max_results # Maximum number of threads to return. # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q - # Only return threads matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # `"from:someuser@example.com rfc822msgid:<somemsgid@example.com> - # is:unread"`. Parameter cannot be used when accessing the api + # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -2479,15 +2450,15 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # Modifies the labels applied to the thread. This applies to all messages - # in the thread. + # Modifies the labels applied to the thread. This applies to all messages in the + # thread. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to modify. # @param [Google::Apis::GmailV1::ModifyThreadRequest] modify_thread_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2519,12 +2490,12 @@ execute_or_queue_command(command, &block) end # Moves the specified thread to the trash. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to Trash. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2553,11 +2524,11 @@ execute_or_queue_command(command, &block) end # Removes the specified thread from the trash. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to remove from Trash. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user