Autogenerated update (2020-05-14)
Update: - appengine_v1 - appengine_v1beta - bigqueryreservation_v1 - bigqueryreservation_v1alpha2 - bigqueryreservation_v1beta1 - container_v1 - firebasehosting_v1beta1 - games_management_v1management - gameservices_v1beta - gmail_v1 - healthcare_v1 - healthcare_v1beta1 - jobs_v3p1beta1 - run_v1 - run_v1alpha1 - storage_v1 - testing_v1 - toolresults_v1beta3 - youtube_partner_v1
This commit is contained in:
1 parent
aa700b68f4
commit
f2fb36e6f1
51 files changed
+1875
-1857
No files matched your search
@@ -31,8 +31,8 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :disposition
|
||||
|
||||
# Email address to which all incoming messages are forwarded. This email
|
||||
# address must be a verified member of the forwarding addresses.
|
||||
# Email address to which all incoming messages are forwarded. This email address
|
||||
# must be a verified member of the forwarding addresses.
|
||||
# Corresponds to the JSON property `emailAddress`
|
||||
# @return [String]
|
||||
attr_accessor :email_address
|
||||
@@ -83,8 +83,7 @@ module Google
|
||||
# @return [Array<String>]
|
||||
attr_accessor :add_label_ids
|
||||
|
||||
# The IDs of the messages to modify. There is a limit of 1000 ids per
|
||||
# request.
|
||||
# The IDs of the messages to modify. There is a limit of 1000 ids per request.
|
||||
# Corresponds to the JSON property `ids`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :ids
|
||||
@@ -107,9 +106,8 @@ module Google
|
||||
end
|
||||
|
||||
# Settings for a delegate. Delegates can read, send, and delete messages, as
|
||||
# well as view and add contacts, for the delegator's account. See
|
||||
# <a href="https://support.google.com/mail/answer/138350">"Set up
|
||||
# mail delegation"</a> for more information about delegates.
|
||||
# well as view and add contacts, for the delegator's account. See "Set up mail
|
||||
# delegation" for more information about delegates.
|
||||
class Delegate
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
@@ -118,8 +116,8 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :delegate_email
|
||||
|
||||
# Indicates whether this address has been verified and can act as a delegate
|
||||
# for the account. Read-only.
|
||||
# Indicates whether this address has been verified and can act as a delegate for
|
||||
# the account. Read-only.
|
||||
# Corresponds to the JSON property `verificationStatus`
|
||||
# @return [String]
|
||||
attr_accessor :verification_status
|
||||
@@ -244,18 +242,16 @@ module Google
|
||||
attr_accessor :has_attachment
|
||||
alias_method :has_attachment?, :has_attachment
|
||||
|
||||
# Only return messages not matching the specified query. Supports the same
|
||||
# query format as the Gmail search box. For example,
|
||||
# <code>"from:someuser@example.com rfc822msgid:<somemsgid@example.com>
|
||||
# is:unread"</code>.
|
||||
# Only return messages not matching the specified query. Supports the same query
|
||||
# format as the Gmail search box. For example, "from:someuser@example.com
|
||||
# rfc822msgid: is:unread".
|
||||
# Corresponds to the JSON property `negatedQuery`
|
||||
# @return [String]
|
||||
attr_accessor :negated_query
|
||||
|
||||
# Only return messages matching the specified query. Supports the same
|
||||
# query format as the Gmail search box. For example,
|
||||
# <code>"from:someuser@example.com rfc822msgid:<somemsgid@example.com>
|
||||
# is:unread"</code>.
|
||||
# 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".
|
||||
# Corresponds to the JSON property `query`
|
||||
# @return [String]
|
||||
attr_accessor :query
|
||||
@@ -271,16 +267,16 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :size_comparison
|
||||
|
||||
# Case-insensitive phrase found in the message's subject. Trailing and
|
||||
# leading whitespace are be trimmed and adjacent spaces are collapsed.
|
||||
# Case-insensitive phrase found in the message's subject. Trailing and leading
|
||||
# whitespace are be trimmed and adjacent spaces are collapsed.
|
||||
# Corresponds to the JSON property `subject`
|
||||
# @return [String]
|
||||
attr_accessor :subject
|
||||
|
||||
# The recipient's display name or email address. Includes recipients in the
|
||||
# "to", "cc", and "bcc" header fields. You can use simply the local part of
|
||||
# the email address. For example, "example" and "example@" both match
|
||||
# "example@gmail.com". This field is case-insensitive.
|
||||
# The recipient's display name or email address. Includes recipients in the "to",
|
||||
# "cc", and "bcc" header fields. You can use simply the local part of the email
|
||||
# address. For example, "example" and "example@" both match "example@gmail.com".
|
||||
# This field is case-insensitive.
|
||||
# Corresponds to the JSON property `to`
|
||||
# @return [String]
|
||||
attr_accessor :to
|
||||
@@ -312,8 +308,8 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :forwarding_email
|
||||
|
||||
# Indicates whether this address has been verified and is usable for
|
||||
# forwarding. Read-only.
|
||||
# Indicates whether this address has been verified and is usable for forwarding.
|
||||
# Read-only.
|
||||
# Corresponds to the JSON property `verificationStatus`
|
||||
# @return [String]
|
||||
attr_accessor :verification_status
|
||||
@@ -349,10 +345,9 @@ module Google
|
||||
# @return [Array<Google::Apis::GmailV1::HistoryLabelRemoved>]
|
||||
attr_accessor :labels_removed
|
||||
|
||||
# List of messages changed in this history record. The fields for specific
|
||||
# change types, such as <code>messagesAdded</code> may duplicate messages in
|
||||
# this field. We recommend using the specific change-type fields instead
|
||||
# of this.
|
||||
# List of messages changed in this history record. The fields for specific
|
||||
# change types, such as messagesAdded may duplicate messages in this field. We
|
||||
# recommend using the specific change-type fields instead of this.
|
||||
# Corresponds to the JSON property `messages`
|
||||
# @return [Array<Google::Apis::GmailV1::Message>]
|
||||
attr_accessor :messages
|
||||
@@ -475,8 +470,8 @@ module Google
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# If this value is true, Gmail will immediately expunge a message when it is
|
||||
# marked as deleted in IMAP. Otherwise, Gmail will wait for an update from
|
||||
# the client before expunging messages marked as deleted.
|
||||
# marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the
|
||||
# client before expunging messages marked as deleted.
|
||||
# Corresponds to the JSON property `autoExpunge`
|
||||
# @return [Boolean]
|
||||
attr_accessor :auto_expunge
|
||||
@@ -488,15 +483,15 @@ module Google
|
||||
attr_accessor :enabled
|
||||
alias_method :enabled?, :enabled
|
||||
|
||||
# The action that will be executed on a message when it is marked as deleted
|
||||
# and expunged from the last visible IMAP folder.
|
||||
# The action that will be executed on a message when it is marked as deleted and
|
||||
# expunged from the last visible IMAP folder.
|
||||
# Corresponds to the JSON property `expungeBehavior`
|
||||
# @return [String]
|
||||
attr_accessor :expunge_behavior
|
||||
|
||||
# An optional limit on the number of messages that an IMAP folder may
|
||||
# contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero
|
||||
# is interpreted to mean that there is no limit.
|
||||
# An optional limit on the number of messages that an IMAP folder may contain.
|
||||
# Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted
|
||||
# to mean that there is no limit.
|
||||
# Corresponds to the JSON property `maxFolderSize`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :max_folder_size
|
||||
@@ -514,14 +509,12 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
# Labels are used to categorize messages and threads within the
|
||||
# user's mailbox.
|
||||
# Labels are used to categorize messages and threads within the user's mailbox.
|
||||
class Label
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The color to assign to the label. Color is only available for labels that
|
||||
# have their <code>type</code> set to <code>user</code>.
|
||||
# @mutable gmail.users.labels.create gmail.users.labels.update
|
||||
# The color to assign to the label. Color is only available for labels that have
|
||||
# their type set to user.
|
||||
# Corresponds to the JSON property `color`
|
||||
# @return [Google::Apis::GmailV1::LabelColor]
|
||||
attr_accessor :color
|
||||
@@ -532,14 +525,11 @@ module Google
|
||||
attr_accessor :id
|
||||
|
||||
# The visibility of the label in the label list in the Gmail web interface.
|
||||
# @mutable gmail.users.labels.create gmail.users.labels.update
|
||||
# Corresponds to the JSON property `labelListVisibility`
|
||||
# @return [String]
|
||||
attr_accessor :label_list_visibility
|
||||
|
||||
# The visibility of the label in the message list in the
|
||||
# Gmail web interface.
|
||||
# @mutable gmail.users.labels.create gmail.users.labels.update
|
||||
# The visibility of the label in the message list in the Gmail web interface.
|
||||
# Corresponds to the JSON property `messageListVisibility`
|
||||
# @return [String]
|
||||
attr_accessor :message_list_visibility
|
||||
@@ -555,7 +545,6 @@ module Google
|
||||
attr_accessor :messages_unread
|
||||
|
||||
# The display name of the label.
|
||||
# @mutable gmail.users.labels.create gmail.users.labels.update
|
||||
# Corresponds to the JSON property `name`
|
||||
# @return [String]
|
||||
attr_accessor :name
|
||||
@@ -570,15 +559,14 @@ module Google
|
||||
# @return [Fixnum]
|
||||
attr_accessor :threads_unread
|
||||
|
||||
# The owner type for the label. User labels are created by the user and
|
||||
# can be modified and deleted by the user and can be applied to any
|
||||
# message or thread. System labels are internally created and cannot be
|
||||
# added, modified, or deleted. System labels may be able to be applied to or
|
||||
# removed from messages and threads under some circumstances but this is
|
||||
# not guaranteed. For example, users can apply and remove the
|
||||
# <code>INBOX</code> and <code>UNREAD</code> labels from messages and
|
||||
# threads, but cannot apply or remove the <code>DRAFTS</code> or
|
||||
# <code>SENT</code> labels from messages or threads.
|
||||
# The owner type for the label. User labels are created by the user and can be
|
||||
# modified and deleted by the user and can be applied to any message or thread.
|
||||
# System labels are internally created and cannot be added, modified, or deleted.
|
||||
# System labels may be able to be applied to or removed from messages and
|
||||
# threads under some circumstances but this is not guaranteed. For example,
|
||||
# users can apply and remove the INBOX and UNREAD labels from messages and
|
||||
# threads, but cannot apply or remove the DRAFTS or SENT labels from messages or
|
||||
# threads.
|
||||
# Corresponds to the JSON property `type`
|
||||
# @return [String]
|
||||
attr_accessor :type
|
||||
@@ -606,46 +594,40 @@ module Google
|
||||
class LabelColor
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The background color represented as hex string #RRGGBB (ex #000000).
|
||||
# This field is required in order to set the color of a label.
|
||||
# Only the following predefined set of color values are allowed:
|
||||
# <br/>
|
||||
# # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
|
||||
# # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
|
||||
# # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
|
||||
# # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
|
||||
# # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
|
||||
# # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
|
||||
# # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
|
||||
# # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
|
||||
# # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
|
||||
# # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
|
||||
# # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
|
||||
# # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
|
||||
# # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
|
||||
# @mutable gmail.users.labels.create gmail.users.labels.update
|
||||
# The background color represented as hex string #RRGGBB (ex #000000). This
|
||||
# field is required in order to set the color of a label. Only the following
|
||||
# predefined set of color values are allowed:
|
||||
# #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #
|
||||
# fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be,
|
||||
# #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #
|
||||
# ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b,
|
||||
# #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #
|
||||
# f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49,
|
||||
# #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #
|
||||
# 076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5,
|
||||
# #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #
|
||||
# 7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30,
|
||||
# #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #
|
||||
# f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
|
||||
# Corresponds to the JSON property `backgroundColor`
|
||||
# @return [String]
|
||||
attr_accessor :background_color
|
||||
|
||||
# The text color of the label, represented as hex string.
|
||||
# This field is required in order to set the color of a label.
|
||||
# Only the following predefined set of color values are allowed:
|
||||
# <br/>
|
||||
# # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
|
||||
# # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
|
||||
# # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
|
||||
# # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
|
||||
# # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
|
||||
# # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
|
||||
# # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
|
||||
# # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
|
||||
# # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
|
||||
# # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
|
||||
# # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
|
||||
# # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
|
||||
# # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
|
||||
# @mutable gmail.users.labels.create gmail.users.labels.update
|
||||
# The text color of the label, represented as hex string. This field is required
|
||||
# in order to set the color of a label. Only the following predefined set of
|
||||
# color values are allowed:
|
||||
# #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #
|
||||
# fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be,
|
||||
# #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #
|
||||
# ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b,
|
||||
# #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #
|
||||
# f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49,
|
||||
# #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #
|
||||
# 076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5,
|
||||
# #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #
|
||||
# 7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30,
|
||||
# #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #
|
||||
# f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
|
||||
# Corresponds to the JSON property `textColor`
|
||||
# @return [String]
|
||||
attr_accessor :text_color
|
||||
@@ -661,28 +643,21 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
# Language settings for an account. These settings correspond to
|
||||
# the <a href="https://support.google.com/mail/answer/17091">"Language
|
||||
# settings"</a> feature in the web interface.
|
||||
# Language settings for an account. These settings correspond to the "Language
|
||||
# settings" feature in the web interface.
|
||||
class LanguageSettings
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The language to display Gmail in, formatted as an
|
||||
# <a href="https://www.w3.org/International/articles/language-tags/">RFC 3066
|
||||
# Language Tag</a> (for example <code>en-GB</code>, <code>fr</code> or
|
||||
# <code>ja</code> for British English, French, or Japanese respectively).
|
||||
# The set of languages supported by Gmail evolves over time, so please refer
|
||||
# to the "Language" dropdown in the
|
||||
# <a href="https://mail.google.com/mail/u/0/#settings/general">Gmail settings
|
||||
# </a> for all available options, as described in the
|
||||
# <a href="https://support.google.com/mail/answer/17091">language settings
|
||||
# help article</a>. A table of sample values is also provided in the
|
||||
# <a href="/gmail/api/guides/language_settings#display_language">Managing
|
||||
# Language Settings guide</a>
|
||||
# Not all Gmail clients can display the same set of languages. In the case
|
||||
# that a user's display language is not available for use on a particular
|
||||
# client, said client automatically chooses to display in the closest
|
||||
# supported variant (or a reasonable default).
|
||||
# The language to display Gmail in, formatted as an RFC 3066 Language Tag (for
|
||||
# example en-GB, fr or ja for British English, French, or Japanese respectively).
|
||||
# The set of languages supported by Gmail evolves over time, so please refer to
|
||||
# the "Language" dropdown in the Gmail settings for all available options, as
|
||||
# described in the language settings help article. A table of sample values is
|
||||
# also provided in the Managing Language Settings guide
|
||||
# Not all Gmail clients can display the same set of languages. In the case that
|
||||
# a user's display language is not available for use on a particular client,
|
||||
# said client automatically chooses to display in the closest supported variant (
|
||||
# or a reasonable default).
|
||||
# Corresponds to the JSON property `displayLanguage`
|
||||
# @return [String]
|
||||
attr_accessor :display_language
|
||||
@@ -720,11 +695,9 @@ module Google
|
||||
class ListDraftsResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# List of drafts. Note that the <code>Message</code> property in each
|
||||
# <code>Draft</code> resource only contains an <code>id</code> and a
|
||||
# <code>threadId</code>. The
|
||||
# <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a>
|
||||
# method can fetch additional message details.
|
||||
# List of drafts. Note that the Message property in each Draft resource only
|
||||
# contains an id and a threadId. The messages.get method can fetch additional
|
||||
# message details.
|
||||
# Corresponds to the JSON property `drafts`
|
||||
# @return [Array<Google::Apis::GmailV1::Draft>]
|
||||
attr_accessor :drafts
|
||||
@@ -793,9 +766,8 @@ module Google
|
||||
class ListHistoryResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# List of history records. Any <code>messages</code> contained in the
|
||||
# response will typically only have <code>id</code> and
|
||||
# <code>threadId</code> fields populated.
|
||||
# List of history records. Any messages contained in the response will typically
|
||||
# only have id and threadId fields populated.
|
||||
# Corresponds to the JSON property `history`
|
||||
# @return [Array<Google::Apis::GmailV1::History>]
|
||||
attr_accessor :history
|
||||
@@ -826,10 +798,8 @@ module Google
|
||||
class ListLabelsResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# List of labels. Note that each label resource only contains an
|
||||
# <code>id</code>, <code>name</code>, <code>messageListVisibility</code>,
|
||||
# <code>labelListVisibility</code>, and <code>type</code>. The
|
||||
# <a href="/gmail/api/v1/reference/users/labels/get">labels.get</a> method
|
||||
# List of labels. Note that each label resource only contains an id, name,
|
||||
# messageListVisibility, labelListVisibility, and type. The labels.get method
|
||||
# can fetch additional label details.
|
||||
# Corresponds to the JSON property `labels`
|
||||
# @return [Array<Google::Apis::GmailV1::Label>]
|
||||
@@ -849,10 +819,8 @@ module Google
|
||||
class ListMessagesResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# List of messages. Note that each message resource contains only an
|
||||
# <code>id</code> and a <code>threadId</code>. Additional message details can
|
||||
# be fetched using the
|
||||
# <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a>
|
||||
# List of messages. Note that each message resource contains only an id and a
|
||||
# threadId. Additional message details can be fetched using the messages.get
|
||||
# method.
|
||||
# Corresponds to the JSON property `messages`
|
||||
# @return [Array<Google::Apis::GmailV1::Message>]
|
||||
@@ -933,9 +901,8 @@ module Google
|
||||
attr_accessor :result_size_estimate
|
||||
|
||||
# List of threads. Note that each thread resource does not contain a list of
|
||||
# <code>messages</code>. The list of <code>messages</code> for a given thread
|
||||
# can be fetched using the
|
||||
# <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> method.
|
||||
# messages. The list of messages for a given thread can be fetched using the
|
||||
# threads.get method.
|
||||
# Corresponds to the JSON property `threads`
|
||||
# @return [Array<Google::Apis::GmailV1::Thread>]
|
||||
attr_accessor :threads
|
||||
@@ -966,17 +933,16 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :id
|
||||
|
||||
# The internal message creation timestamp (epoch ms), which determines
|
||||
# ordering in the inbox. For normal SMTP-received email, this represents the
|
||||
# time the message was originally accepted by Google, which is more reliable
|
||||
# than the <code>Date</code> header. However, for API-migrated mail, it can
|
||||
# be configured by client to be based on the <code>Date</code> header.
|
||||
# The internal message creation timestamp (epoch ms), which determines ordering
|
||||
# in the inbox. For normal SMTP-received email, this represents the time the
|
||||
# message was originally accepted by Google, which is more reliable than the
|
||||
# Date header. However, for API-migrated mail, it can be configured by client to
|
||||
# be based on the Date header.
|
||||
# Corresponds to the JSON property `internalDate`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :internal_date
|
||||
|
||||
# List of IDs of labels applied to this message.
|
||||
# @mutable gmail.users.messages.insert gmail.users.messages.modify
|
||||
# Corresponds to the JSON property `labelIds`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :label_ids
|
||||
@@ -986,12 +952,9 @@ module Google
|
||||
# @return [Google::Apis::GmailV1::MessagePart]
|
||||
attr_accessor :payload
|
||||
|
||||
# The entire email message in an RFC 2822 formatted and base64url
|
||||
# encoded string. Returned in <code>messages.get</code> and
|
||||
# <code>drafts.get</code> responses when the <code>format=RAW</code>
|
||||
# The entire email message in an RFC 2822 formatted and base64url encoded string.
|
||||
# Returned in messages.get and drafts.get responses when the format=RAW
|
||||
# parameter is supplied.
|
||||
# @mutable gmail.users.messages.insert gmail.users.messages.send
|
||||
# @mutable gmail.users.drafts.create gmail.users.drafts.update
|
||||
# Corresponds to the JSON property `raw`
|
||||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||||
# @return [String]
|
||||
@@ -1007,17 +970,13 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :snippet
|
||||
|
||||
# The ID of the thread the message belongs to. To add a message or draft to
|
||||
# a thread, the following criteria must be met:
|
||||
# <ol><li>The requested <code>threadId</code> must be specified on the
|
||||
# <code>Message</code> or <code>Draft.Message</code> you supply with your
|
||||
# request.</li>
|
||||
# <li>The <code>References</code> and <code>In-Reply-To</code> headers must
|
||||
# be set in compliance with the
|
||||
# <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
|
||||
# <li>The <code>Subject</code> headers must match.
|
||||
# @mutable gmail.users.messages.insert gmail.users.messages.send
|
||||
# @mutable gmail.users.drafts.create gmail.users.drafts.update
|
||||
# The ID of the thread the message belongs to. To add a message or draft to a
|
||||
# thread, the following criteria must be met:
|
||||
# - The requested threadId must be specified on the Message or Draft.Message you
|
||||
# supply with your request.
|
||||
# - The References and In-Reply-To headers must be set in compliance with the
|
||||
# RFC 2822 standard.
|
||||
# - The Subject headers must match.
|
||||
# Corresponds to the JSON property `threadId`
|
||||
# @return [String]
|
||||
attr_accessor :thread_id
|
||||
@@ -1049,16 +1008,15 @@ module Google
|
||||
# @return [Google::Apis::GmailV1::MessagePartBody]
|
||||
attr_accessor :body
|
||||
|
||||
# The filename of the attachment. Only present if this message part
|
||||
# represents an attachment.
|
||||
# The filename of the attachment. Only present if this message part represents
|
||||
# an attachment.
|
||||
# Corresponds to the JSON property `filename`
|
||||
# @return [String]
|
||||
attr_accessor :filename
|
||||
|
||||
# List of headers on this message part. For the top-level message part,
|
||||
# representing the entire message payload, it will contain the standard
|
||||
# RFC 2822 email headers such as <code>To</code>, <code>From</code>, and
|
||||
# <code>Subject</code>.
|
||||
# representing the entire message payload, it will contain the standard RFC 2822
|
||||
# email headers such as To, From, and Subject.
|
||||
# Corresponds to the JSON property `headers`
|
||||
# @return [Array<Google::Apis::GmailV1::MessagePartHeader>]
|
||||
attr_accessor :headers
|
||||
@@ -1073,11 +1031,10 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :part_id
|
||||
|
||||
# The child MIME message parts of this part. This only applies to container
|
||||
# MIME message parts, for example <code>multipart/*</code>. For non-
|
||||
# container MIME message part types, such as <code>text/plain</code>, this
|
||||
# field is empty. For more information, see
|
||||
# <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
|
||||
# The child MIME message parts of this part. This only applies to container MIME
|
||||
# message parts, for example multipart/*. For non- container MIME message part
|
||||
# types, such as text/plain, this field is empty. For more information, see RFC
|
||||
# 1521.
|
||||
# Corresponds to the JSON property `parts`
|
||||
# @return [Array<Google::Apis::GmailV1::MessagePart>]
|
||||
attr_accessor :parts
|
||||
@@ -1101,19 +1058,17 @@ module Google
|
||||
class MessagePartBody
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# When present, contains the ID of an external attachment that can be
|
||||
# retrieved in a separate <code>messages.attachments.get</code> request.
|
||||
# When not present, the entire content of the message part body is
|
||||
# contained in the data field.
|
||||
# When present, contains the ID of an external attachment that can be retrieved
|
||||
# in a separate messages.attachments.get request. When not present, the entire
|
||||
# content of the message part body is contained in the data field.
|
||||
# Corresponds to the JSON property `attachmentId`
|
||||
# @return [String]
|
||||
attr_accessor :attachment_id
|
||||
|
||||
# The body data of a MIME message part as a base64url encoded string.
|
||||
# May be empty for MIME container
|
||||
# types that have no message body or when the body data is sent as a
|
||||
# separate attachment. An attachment ID is present if the body data is
|
||||
# contained in a separate attachment.
|
||||
# The body data of a MIME message part as a base64url encoded string. May be
|
||||
# empty for MIME container types that have no message body or when the body data
|
||||
# is sent as a separate attachment. An attachment ID is present if the body data
|
||||
# is contained in a separate attachment.
|
||||
# Corresponds to the JSON property `data`
|
||||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||||
# @return [String]
|
||||
@@ -1140,14 +1095,13 @@ module Google
|
||||
class MessagePartHeader
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The name of the header before the <code>:</code> separator. For
|
||||
# example, <code>To</code>.
|
||||
# The name of the header before the : separator. For example, To.
|
||||
# Corresponds to the JSON property `name`
|
||||
# @return [String]
|
||||
attr_accessor :name
|
||||
|
||||
# The value of the header after the <code>:</code> separator. For example,
|
||||
# <code>someuser@example.com</code>.
|
||||
# The value of the header after the : separator. For example, someuser@example.
|
||||
# com.
|
||||
# Corresponds to the JSON property `value`
|
||||
# @return [String]
|
||||
attr_accessor :value
|
||||
@@ -1277,53 +1231,48 @@ module Google
|
||||
end
|
||||
|
||||
# Settings associated with a send-as alias, which can be either the primary
|
||||
# login address associated with the account or a custom "from" address.
|
||||
# Send-as aliases correspond to the
|
||||
# <a href="https://support.google.com/mail/answer/22370">"Send Mail As"</a>
|
||||
# feature in the web interface.
|
||||
# login address associated with the account or a custom "from" address. Send-as
|
||||
# aliases correspond to the "Send Mail As" feature in the web interface.
|
||||
class SendAs
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# A name that appears in the "From:" header for mail sent using this alias.
|
||||
# For custom "from" addresses, when this is empty, Gmail will populate the
|
||||
# "From:" header with the name that is used for the primary address
|
||||
# associated with the account.
|
||||
# If the admin has disabled the ability for users to update their name
|
||||
# format, requests to update this field for the primary login will silently
|
||||
# fail.
|
||||
# A name that appears in the "From:" header for mail sent using this alias. For
|
||||
# custom "from" addresses, when this is empty, Gmail will populate the "From:"
|
||||
# header with the name that is used for the primary address associated with the
|
||||
# account. If the admin has disabled the ability for users to update their name
|
||||
# format, requests to update this field for the primary login will silently fail.
|
||||
# Corresponds to the JSON property `displayName`
|
||||
# @return [String]
|
||||
attr_accessor :display_name
|
||||
|
||||
# Whether this address is selected as the default "From:" address in
|
||||
# situations such as composing a new message or sending a vacation
|
||||
# auto-reply. Every Gmail account has exactly one default send-as address,
|
||||
# so the only legal value that clients may write to this field is
|
||||
# <code>true</code>. Changing this from <code>false</code> to
|
||||
# <code>true</code> for an address will result in this field becoming
|
||||
# <code>false</code> for the other previous default address.
|
||||
# Whether this address is selected as the default "From:" address in situations
|
||||
# such as composing a new message or sending a vacation auto-reply. Every Gmail
|
||||
# account has exactly one default send-as address, so the only legal value that
|
||||
# clients may write to this field is true. Changing this from false to true for
|
||||
# an address will result in this field becoming false for the other previous
|
||||
# default address.
|
||||
# Corresponds to the JSON property `isDefault`
|
||||
# @return [Boolean]
|
||||
attr_accessor :is_default
|
||||
alias_method :is_default?, :is_default
|
||||
|
||||
# Whether this address is the primary address used to login to the account.
|
||||
# Every Gmail account has exactly one primary address, and it cannot be
|
||||
# deleted from the collection of send-as aliases. This field is read-only.
|
||||
# Every Gmail account has exactly one primary address, and it cannot be deleted
|
||||
# from the collection of send-as aliases. This field is read-only.
|
||||
# Corresponds to the JSON property `isPrimary`
|
||||
# @return [Boolean]
|
||||
attr_accessor :is_primary
|
||||
alias_method :is_primary?, :is_primary
|
||||
|
||||
# An optional email address that is included in a "Reply-To:" header for mail
|
||||
# sent using this alias. If this is empty, Gmail will not generate a
|
||||
# "Reply-To:" header.
|
||||
# sent using this alias. If this is empty, Gmail will not generate a "Reply-To:"
|
||||
# header.
|
||||
# Corresponds to the JSON property `replyToAddress`
|
||||
# @return [String]
|
||||
attr_accessor :reply_to_address
|
||||
|
||||
# The email address that appears in the "From:" header for mail sent using
|
||||
# this alias. This is read-only for all operations except create.
|
||||
# The email address that appears in the "From:" header for mail sent using this
|
||||
# alias. This is read-only for all operations except create.
|
||||
# Corresponds to the JSON property `sendAsEmail`
|
||||
# @return [String]
|
||||
attr_accessor :send_as_email
|
||||
@@ -1339,16 +1288,15 @@ module Google
|
||||
# @return [Google::Apis::GmailV1::SmtpMsa]
|
||||
attr_accessor :smtp_msa
|
||||
|
||||
# Whether Gmail should <a href="https://support.google.com/a/answer/1710338">
|
||||
# treat this address as an alias</a> for the user's primary email address.
|
||||
# This setting only applies to custom "from" aliases.
|
||||
# Whether Gmail should treat this address as an alias for the user's primary
|
||||
# email address. This setting only applies to custom "from" aliases.
|
||||
# Corresponds to the JSON property `treatAsAlias`
|
||||
# @return [Boolean]
|
||||
attr_accessor :treat_as_alias
|
||||
alias_method :treat_as_alias?, :treat_as_alias
|
||||
|
||||
# Indicates whether this address has been verified for use as a send-as
|
||||
# alias. Read-only. This setting only applies to custom "from" aliases.
|
||||
# Indicates whether this address has been verified for use as a send-as alias.
|
||||
# Read-only. This setting only applies to custom "from" aliases.
|
||||
# Corresponds to the JSON property `verificationStatus`
|
||||
# @return [String]
|
||||
attr_accessor :verification_status
|
||||
@@ -1401,18 +1349,18 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :issuer_cn
|
||||
|
||||
# PEM formatted X509 concatenated certificate string (standard base64
|
||||
# encoding). Format used for returning key, which includes public key
|
||||
# as well as certificate chain (not private key).
|
||||
# PEM formatted X509 concatenated certificate string (standard base64 encoding).
|
||||
# Format used for returning key, which includes public key as well as
|
||||
# certificate chain (not private key).
|
||||
# Corresponds to the JSON property `pem`
|
||||
# @return [String]
|
||||
attr_accessor :pem
|
||||
|
||||
# PKCS#12 format containing a single private/public key pair and
|
||||
# certificate chain. This format is only accepted from client
|
||||
# for creating a new SmimeInfo and is never returned, because the
|
||||
# private key is not intended to be exported. PKCS#12 may be encrypted,
|
||||
# in which case encryptedKeyPassword should be set appropriately.
|
||||
# PKCS#12 format containing a single private/public key pair and certificate
|
||||
# chain. This format is only accepted from client for creating a new SmimeInfo
|
||||
# and is never returned, because the private key is not intended to be exported.
|
||||
# PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set
|
||||
# appropriately.
|
||||
# Corresponds to the JSON property `pkcs12`
|
||||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||||
# @return [String]
|
||||
@@ -1438,32 +1386,32 @@ module Google
|
||||
class SmtpMsa
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The hostname of the SMTP service. Required.
|
||||
# The hostname of the SMTP service. Required.
|
||||
# Corresponds to the JSON property `host`
|
||||
# @return [String]
|
||||
attr_accessor :host
|
||||
|
||||
# The password that will be used for authentication with the SMTP service.
|
||||
# This is a write-only field that can be specified in requests to create or
|
||||
# update SendAs settings; it is never populated in responses.
|
||||
# The password that will be used for authentication with the SMTP service. This
|
||||
# is a write-only field that can be specified in requests to create or update
|
||||
# SendAs settings; it is never populated in responses.
|
||||
# Corresponds to the JSON property `password`
|
||||
# @return [String]
|
||||
attr_accessor :password
|
||||
|
||||
# The port of the SMTP service. Required.
|
||||
# The port of the SMTP service. Required.
|
||||
# Corresponds to the JSON property `port`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :port
|
||||
|
||||
# The protocol that will be used to secure communication with the SMTP
|
||||
# service. Required.
|
||||
# The protocol that will be used to secure communication with the SMTP service.
|
||||
# Required.
|
||||
# Corresponds to the JSON property `securityMode`
|
||||
# @return [String]
|
||||
attr_accessor :security_mode
|
||||
|
||||
# The username that will be used for authentication with the SMTP service.
|
||||
# This is a write-only field that can be specified in requests to create or
|
||||
# update SendAs settings; it is never populated in responses.
|
||||
# The username that will be used for authentication with the SMTP service. This
|
||||
# is a write-only field that can be specified in requests to create or update
|
||||
# SendAs settings; it is never populated in responses.
|
||||
# Corresponds to the JSON property `username`
|
||||
# @return [String]
|
||||
attr_accessor :username
|
||||
@@ -1519,9 +1467,8 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
# Vacation auto-reply settings for an account. These settings correspond to
|
||||
# the <a href="https://support.google.com/mail/answer/25922">"Vacation
|
||||
# responder"</a> feature in the web interface.
|
||||
# Vacation auto-reply settings for an account. These settings correspond to the "
|
||||
# Vacation responder" feature in the web interface.
|
||||
class VacationSettings
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
@@ -1531,17 +1478,15 @@ module Google
|
||||
attr_accessor :enable_auto_reply
|
||||
alias_method :enable_auto_reply?, :enable_auto_reply
|
||||
|
||||
# An optional end time for sending auto-replies (epoch ms).
|
||||
# When this is specified, Gmail will automatically reply only to messages
|
||||
# that it receives before the end time. If both <code>startTime</code> and
|
||||
# <code>endTime</code> are specified, <code>startTime</code> must precede
|
||||
# <code>endTime</code>.
|
||||
# An optional end time for sending auto-replies (epoch ms). When this is
|
||||
# specified, Gmail will automatically reply only to messages that it receives
|
||||
# before the end time. If both startTime and endTime are specified, startTime
|
||||
# must precede endTime.
|
||||
# Corresponds to the JSON property `endTime`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :end_time
|
||||
|
||||
# Response body in HTML format. Gmail will sanitize the HTML before
|
||||
# storing it.
|
||||
# Response body in HTML format. Gmail will sanitize the HTML before storing it.
|
||||
# Corresponds to the JSON property `responseBodyHtml`
|
||||
# @return [String]
|
||||
attr_accessor :response_body_html
|
||||
@@ -1551,33 +1496,31 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :response_body_plain_text
|
||||
|
||||
# Optional text to prepend to the subject line in vacation responses. In
|
||||
# order to enable auto-replies, either the response subject or the response
|
||||
# body must be nonempty.
|
||||
# Optional text to prepend to the subject line in vacation responses. In order
|
||||
# to enable auto-replies, either the response subject or the response body must
|
||||
# be nonempty.
|
||||
# Corresponds to the JSON property `responseSubject`
|
||||
# @return [String]
|
||||
attr_accessor :response_subject
|
||||
|
||||
# Flag that determines whether responses are sent to recipients who are not
|
||||
# in the user's list of contacts.
|
||||
# Flag that determines whether responses are sent to recipients who are not in
|
||||
# the user's list of contacts.
|
||||
# Corresponds to the JSON property `restrictToContacts`
|
||||
# @return [Boolean]
|
||||
attr_accessor :restrict_to_contacts
|
||||
alias_method :restrict_to_contacts?, :restrict_to_contacts
|
||||
|
||||
# Flag that determines whether responses are sent to recipients who are
|
||||
# outside of the user's domain. This feature is only available for G Suite
|
||||
# users.
|
||||
# Flag that determines whether responses are sent to recipients who are outside
|
||||
# of the user's domain. This feature is only available for G Suite users.
|
||||
# Corresponds to the JSON property `restrictToDomain`
|
||||
# @return [Boolean]
|
||||
attr_accessor :restrict_to_domain
|
||||
alias_method :restrict_to_domain?, :restrict_to_domain
|
||||
|
||||
# An optional start time for sending auto-replies (epoch ms).
|
||||
# When this is specified, Gmail will automatically reply only to messages
|
||||
# that it receives after the start time. If both <code>startTime</code> and
|
||||
# <code>endTime</code> are specified, <code>startTime</code> must precede
|
||||
# <code>endTime</code>.
|
||||
# An optional start time for sending auto-replies (epoch ms). When this is
|
||||
# specified, Gmail will automatically reply only to messages that it receives
|
||||
# after the start time. If both startTime and endTime are specified, startTime
|
||||
# must precede endTime.
|
||||
# Corresponds to the JSON property `startTime`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :start_time
|
||||
@@ -1608,21 +1551,20 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :label_filter_action
|
||||
|
||||
# List of label_ids to restrict notifications about. By default,
|
||||
# if unspecified, all changes are pushed out. If specified then
|
||||
# dictates which labels are required for a push notification to
|
||||
# be generated.
|
||||
# List of label_ids to restrict notifications about. By default, if unspecified,
|
||||
# all changes are pushed out. If specified then dictates which labels are
|
||||
# required for a push notification to be generated.
|
||||
# Corresponds to the JSON property `labelIds`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :label_ids
|
||||
|
||||
# A fully qualified Google Cloud Pub/Sub API topic name to publish the
|
||||
# events to. This topic name **must** already exist in Cloud Pub/Sub and
|
||||
# you **must** have already granted gmail "publish" permission on it.
|
||||
# For example, "projects/my-project-identifier/topics/my-topic-name"
|
||||
# (using the Cloud Pub/Sub "v1" topic naming format).
|
||||
# Note that the "my-project-identifier" portion must exactly match your
|
||||
# Google developer project id (the one executing this watch request).
|
||||
# A fully qualified Google Cloud Pub/Sub API topic name to publish the events to.
|
||||
# This topic name **must** already exist in Cloud Pub/Sub and you **must** have
|
||||
# already granted gmail "publish" permission on it. For example, "projects/my-
|
||||
# project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic
|
||||
# naming format).
|
||||
# Note that the "my-project-identifier" portion must exactly match your Google
|
||||
# developer project id (the one executing this watch request).
|
||||
# Corresponds to the JSON property `topicName`
|
||||
# @return [String]
|
||||
attr_accessor :topic_name
|
||||
@@ -1643,9 +1585,8 @@ module Google
|
||||
class WatchResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# When Gmail will stop sending notifications for mailbox updates
|
||||
# (epoch millis). Call <code>watch</code> again before this time to renew
|
||||
# the watch.
|
||||
# When Gmail will stop sending notifications for mailbox updates (epoch millis).
|
||||
# Call watch again before this time to renew the watch.
|
||||
# Corresponds to the JSON property `expiration`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :expiration
|
||||
|
||||
Reference in new issue
Block a user