google-apis-gmail_v1 0.46.0 → 0.53.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +28 -0
- data/OVERVIEW.md +1 -1
- data/lib/google/apis/gmail_v1/classes.rb +60 -15
- data/lib/google/apis/gmail_v1/gem_version.rb +3 -3
- data/lib/google/apis/gmail_v1/representations.rb +6 -0
- data/lib/google/apis/gmail_v1/service.rb +201 -90
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7d4ccaada39f12bfff345379ac51b61388887bc8b9a6c322567b39af99582d46
|
|
4
|
+
data.tar.gz: 8e8497d7067ad19397785b963e98c1b08579bf645eb9c6e728576571652d6445
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a8fb9beb4611f23bdd0a681e452cfebf8fb8ebdb4ef1750fd2e8e387f78ad19c1c6d25edbe8d7758dd31ccc5691376c4ba35354224806e5475cea7686d0d73a4
|
|
7
|
+
data.tar.gz: 71b2708afe55bcb55ef3b29db6ae759b9feef934da5a19c1e3e406dd4ce3b58a057abd3c53ccd7912c7f8e0af165b4179e96c6f4a2764ae82287f098e3a732d5
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,33 @@
|
|
|
1
1
|
# Release history for google-apis-gmail_v1
|
|
2
2
|
|
|
3
|
+
### v0.53.0 (2026-08-02)
|
|
4
|
+
|
|
5
|
+
* Regenerated from discovery document revision 20260727
|
|
6
|
+
|
|
7
|
+
### v0.52.0 (2026-06-14)
|
|
8
|
+
|
|
9
|
+
* Regenerated using generator version 0.19.0
|
|
10
|
+
|
|
11
|
+
### v0.51.0 (2026-05-31)
|
|
12
|
+
|
|
13
|
+
* Regenerated from discovery document revision 20260525
|
|
14
|
+
|
|
15
|
+
### v0.50.0 (2026-05-17)
|
|
16
|
+
|
|
17
|
+
* Regenerated from discovery document revision 20260511
|
|
18
|
+
|
|
19
|
+
### v0.49.0 (2026-05-03)
|
|
20
|
+
|
|
21
|
+
* Regenerated from discovery document revision 20260427
|
|
22
|
+
|
|
23
|
+
### v0.48.0 (2026-04-19)
|
|
24
|
+
|
|
25
|
+
* Regenerated from discovery document revision 20260413
|
|
26
|
+
|
|
27
|
+
### v0.47.0 (2025-12-07)
|
|
28
|
+
|
|
29
|
+
* Regenerated from discovery document revision 20251201
|
|
30
|
+
|
|
3
31
|
### v0.46.0 (2025-11-16)
|
|
4
32
|
|
|
5
33
|
* Regenerated from discovery document revision 20251110
|
data/OVERVIEW.md
CHANGED
|
@@ -83,7 +83,7 @@ The [product documentation](https://developers.google.com/workspace/gmail/api/)
|
|
|
83
83
|
|
|
84
84
|
## Supported Ruby versions
|
|
85
85
|
|
|
86
|
-
This library is supported on Ruby 3.
|
|
86
|
+
This library is supported on Ruby 3.2+.
|
|
87
87
|
|
|
88
88
|
Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
|
|
89
89
|
|
|
@@ -78,6 +78,17 @@ module Google
|
|
|
78
78
|
class BatchModifyMessagesRequest
|
|
79
79
|
include Google::Apis::Core::Hashable
|
|
80
80
|
|
|
81
|
+
# A list of Classification Label values to add. If a Classification Label with
|
|
82
|
+
# the same label ID is already applied to the message, fields with existing
|
|
83
|
+
# field IDs will be updated and fields with new field IDs will be added. There's
|
|
84
|
+
# a limit of 20 Classification Label values per request. If the message is
|
|
85
|
+
# already classified and the final total number of Classification Label values
|
|
86
|
+
# exceeds the maximum allowed number of Classification Label values per message,
|
|
87
|
+
# the modification fails.
|
|
88
|
+
# Corresponds to the JSON property `addClassificationLabels`
|
|
89
|
+
# @return [Array<Google::Apis::GmailV1::ClassificationLabelValue>]
|
|
90
|
+
attr_accessor :add_classification_labels
|
|
91
|
+
|
|
81
92
|
# A list of label IDs to add to messages.
|
|
82
93
|
# Corresponds to the JSON property `addLabelIds`
|
|
83
94
|
# @return [Array<String>]
|
|
@@ -88,6 +99,11 @@ module Google
|
|
|
88
99
|
# @return [Array<String>]
|
|
89
100
|
attr_accessor :ids
|
|
90
101
|
|
|
102
|
+
# A list of Classification Label values to remove from messages.
|
|
103
|
+
# Corresponds to the JSON property `removeClassificationLabelIds`
|
|
104
|
+
# @return [Array<String>]
|
|
105
|
+
attr_accessor :remove_classification_label_ids
|
|
106
|
+
|
|
91
107
|
# A list of label IDs to remove from messages.
|
|
92
108
|
# Corresponds to the JSON property `removeLabelIds`
|
|
93
109
|
# @return [Array<String>]
|
|
@@ -99,8 +115,10 @@ module Google
|
|
|
99
115
|
|
|
100
116
|
# Update properties of this object
|
|
101
117
|
def update!(**args)
|
|
118
|
+
@add_classification_labels = args[:add_classification_labels] if args.key?(:add_classification_labels)
|
|
102
119
|
@add_label_ids = args[:add_label_ids] if args.key?(:add_label_ids)
|
|
103
120
|
@ids = args[:ids] if args.key?(:ids)
|
|
121
|
+
@remove_classification_label_ids = args[:remove_classification_label_ids] if args.key?(:remove_classification_label_ids)
|
|
104
122
|
@remove_label_ids = args[:remove_label_ids] if args.key?(:remove_label_ids)
|
|
105
123
|
end
|
|
106
124
|
end
|
|
@@ -437,7 +455,9 @@ module Google
|
|
|
437
455
|
# @return [Array<String>]
|
|
438
456
|
attr_accessor :add_label_ids
|
|
439
457
|
|
|
440
|
-
# Email address that the message should be forwarded to.
|
|
458
|
+
# Email address that the message should be forwarded to. This effectively
|
|
459
|
+
# redirects the message to the address specified in this field, maintaining the
|
|
460
|
+
# original sender in the "From" field.
|
|
441
461
|
# Corresponds to the JSON property `forward`
|
|
442
462
|
# @return [String]
|
|
443
463
|
attr_accessor :forward
|
|
@@ -895,12 +915,13 @@ module Google
|
|
|
895
915
|
# 44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #
|
|
896
916
|
# 149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #
|
|
897
917
|
# 0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #
|
|
898
|
-
# 076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #
|
|
899
|
-
# #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #
|
|
900
|
-
# 7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #
|
|
901
|
-
# 0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #
|
|
902
|
-
# 994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #
|
|
903
|
-
# 42d692, #16a765
|
|
918
|
+
# 076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #
|
|
919
|
+
# b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #
|
|
920
|
+
# f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #
|
|
921
|
+
# fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #
|
|
922
|
+
# b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #
|
|
923
|
+
# 094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #
|
|
924
|
+
# d93025, #54240e, #633e04, #521d28, #202124, \#083018
|
|
904
925
|
# Corresponds to the JSON property `backgroundColor`
|
|
905
926
|
# @return [String]
|
|
906
927
|
attr_accessor :background_color
|
|
@@ -915,11 +936,13 @@ module Google
|
|
|
915
936
|
# 6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #
|
|
916
937
|
# 3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #
|
|
917
938
|
# 285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #
|
|
918
|
-
# 1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #
|
|
919
|
-
# #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #
|
|
920
|
-
# 7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #
|
|
921
|
-
# 04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #
|
|
922
|
-
# ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #
|
|
939
|
+
# 1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #
|
|
940
|
+
# 98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #
|
|
941
|
+
# ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #
|
|
942
|
+
# b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #
|
|
943
|
+
# f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #
|
|
944
|
+
# 16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #
|
|
945
|
+
# 633e04, #521d28, #202124, \#083018
|
|
923
946
|
# Corresponds to the JSON property `textColor`
|
|
924
947
|
# @return [String]
|
|
925
948
|
attr_accessor :text_color
|
|
@@ -1278,7 +1301,9 @@ module Google
|
|
|
1278
1301
|
# schemas can be queried using the Google Drive Labels API. Each classification
|
|
1279
1302
|
# label ID must be unique. If duplicate IDs are provided, only one will be
|
|
1280
1303
|
# retained, and the selection is arbitrary. Only used for Google Workspace
|
|
1281
|
-
# accounts.
|
|
1304
|
+
# accounts. There's a limit of 20 Classification Label values per request. If
|
|
1305
|
+
# the Classification Label values exceeds the maximum allowed number, the
|
|
1306
|
+
# request fails.
|
|
1282
1307
|
# Corresponds to the JSON property `classificationLabelValues`
|
|
1283
1308
|
# @return [Array<Google::Apis::GmailV1::ClassificationLabelValue>]
|
|
1284
1309
|
attr_accessor :classification_label_values
|
|
@@ -1314,7 +1339,8 @@ module Google
|
|
|
1314
1339
|
|
|
1315
1340
|
# The entire email message in an RFC 2822 formatted and base64url encoded string.
|
|
1316
1341
|
# Returned in `messages.get` and `drafts.get` responses when the `format=RAW`
|
|
1317
|
-
# parameter is supplied.
|
|
1342
|
+
# parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.
|
|
1343
|
+
# update
|
|
1318
1344
|
# Corresponds to the JSON property `raw`
|
|
1319
1345
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
1320
1346
|
# @return [String]
|
|
@@ -1481,12 +1507,28 @@ module Google
|
|
|
1481
1507
|
class ModifyMessageRequest
|
|
1482
1508
|
include Google::Apis::Core::Hashable
|
|
1483
1509
|
|
|
1510
|
+
# A list of classification label values to add. If a Classification Label with
|
|
1511
|
+
# the same label ID is already applied to the message, fields with existing
|
|
1512
|
+
# field IDs will be updated and fields with new field IDs will be added. There's
|
|
1513
|
+
# a limit of 20 Classification Label values per request. If the message is
|
|
1514
|
+
# already classified and the final total number of Classification Label values
|
|
1515
|
+
# exceeds the maximum allowed number of Classification Label values per message,
|
|
1516
|
+
# the modification fails.
|
|
1517
|
+
# Corresponds to the JSON property `addClassificationLabels`
|
|
1518
|
+
# @return [Array<Google::Apis::GmailV1::ClassificationLabelValue>]
|
|
1519
|
+
attr_accessor :add_classification_labels
|
|
1520
|
+
|
|
1484
1521
|
# A list of IDs of labels to add to this message. You can add up to 100 labels
|
|
1485
1522
|
# with each update.
|
|
1486
1523
|
# Corresponds to the JSON property `addLabelIds`
|
|
1487
1524
|
# @return [Array<String>]
|
|
1488
1525
|
attr_accessor :add_label_ids
|
|
1489
1526
|
|
|
1527
|
+
# A list of Classification Label values to remove from this message.
|
|
1528
|
+
# Corresponds to the JSON property `removeClassificationLabelIds`
|
|
1529
|
+
# @return [Array<String>]
|
|
1530
|
+
attr_accessor :remove_classification_label_ids
|
|
1531
|
+
|
|
1490
1532
|
# A list IDs of labels to remove from this message. You can remove up to 100
|
|
1491
1533
|
# labels with each update.
|
|
1492
1534
|
# Corresponds to the JSON property `removeLabelIds`
|
|
@@ -1499,7 +1541,9 @@ module Google
|
|
|
1499
1541
|
|
|
1500
1542
|
# Update properties of this object
|
|
1501
1543
|
def update!(**args)
|
|
1544
|
+
@add_classification_labels = args[:add_classification_labels] if args.key?(:add_classification_labels)
|
|
1502
1545
|
@add_label_ids = args[:add_label_ids] if args.key?(:add_label_ids)
|
|
1546
|
+
@remove_classification_label_ids = args[:remove_classification_label_ids] if args.key?(:remove_classification_label_ids)
|
|
1503
1547
|
@remove_label_ids = args[:remove_label_ids] if args.key?(:remove_label_ids)
|
|
1504
1548
|
end
|
|
1505
1549
|
end
|
|
@@ -1609,7 +1653,8 @@ module Google
|
|
|
1609
1653
|
|
|
1610
1654
|
# Settings associated with a send-as alias, which can be either the primary
|
|
1611
1655
|
# login address associated with the account or a custom "from" address. Send-as
|
|
1612
|
-
# aliases correspond to the "Send Mail As" feature in the web interface.
|
|
1656
|
+
# aliases correspond to the "Send Mail As" feature in the web interface. The
|
|
1657
|
+
# send-as alias must be a valid email address.
|
|
1613
1658
|
class SendAs
|
|
1614
1659
|
include Google::Apis::Core::Hashable
|
|
1615
1660
|
|
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module GmailV1
|
|
18
18
|
# Version of the google-apis-gmail_v1 gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.53.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
|
-
GENERATOR_VERSION = "0.
|
|
22
|
+
GENERATOR_VERSION = "0.19.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20260727"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -377,8 +377,11 @@ module Google
|
|
|
377
377
|
class BatchModifyMessagesRequest
|
|
378
378
|
# @private
|
|
379
379
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
380
|
+
collection :add_classification_labels, as: 'addClassificationLabels', class: Google::Apis::GmailV1::ClassificationLabelValue, decorator: Google::Apis::GmailV1::ClassificationLabelValue::Representation
|
|
381
|
+
|
|
380
382
|
collection :add_label_ids, as: 'addLabelIds'
|
|
381
383
|
collection :ids, as: 'ids'
|
|
384
|
+
collection :remove_classification_label_ids, as: 'removeClassificationLabelIds'
|
|
382
385
|
collection :remove_label_ids, as: 'removeLabelIds'
|
|
383
386
|
end
|
|
384
387
|
end
|
|
@@ -774,7 +777,10 @@ module Google
|
|
|
774
777
|
class ModifyMessageRequest
|
|
775
778
|
# @private
|
|
776
779
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
780
|
+
collection :add_classification_labels, as: 'addClassificationLabels', class: Google::Apis::GmailV1::ClassificationLabelValue, decorator: Google::Apis::GmailV1::ClassificationLabelValue::Representation
|
|
781
|
+
|
|
777
782
|
collection :add_label_ids, as: 'addLabelIds'
|
|
783
|
+
collection :remove_classification_label_ids, as: 'removeClassificationLabelIds'
|
|
778
784
|
collection :remove_label_ids, as: 'removeLabelIds'
|
|
779
785
|
end
|
|
780
786
|
end
|
|
@@ -83,7 +83,9 @@ module Google
|
|
|
83
83
|
execute_or_queue_command(command, &block)
|
|
84
84
|
end
|
|
85
85
|
|
|
86
|
-
#
|
|
86
|
+
# Turn off push notification delivery for the given user mailbox. For more
|
|
87
|
+
# information, see [Configure push notifications in Gmail API](https://
|
|
88
|
+
# developers.google.com/workspace/gmail/api/guides/push).
|
|
87
89
|
# @param [String] user_id
|
|
88
90
|
# The user's email address. The special value `me` can be used to indicate the
|
|
89
91
|
# authenticated user.
|
|
@@ -112,7 +114,9 @@ module Google
|
|
|
112
114
|
execute_or_queue_command(command, &block)
|
|
113
115
|
end
|
|
114
116
|
|
|
115
|
-
# Set up or update a push notification watch on the given user mailbox.
|
|
117
|
+
# Set up or update a push notification watch on the given user mailbox. For more
|
|
118
|
+
# information, see [Configure push notifications in Gmail API](https://
|
|
119
|
+
# developers.google.com/workspace/gmail/api/guides/push).
|
|
116
120
|
# @param [String] user_id
|
|
117
121
|
# The user's email address. The special value `me` can be used to indicate the
|
|
118
122
|
# authenticated user.
|
|
@@ -146,7 +150,9 @@ module Google
|
|
|
146
150
|
execute_or_queue_command(command, &block)
|
|
147
151
|
end
|
|
148
152
|
|
|
149
|
-
# Creates a
|
|
153
|
+
# Creates a draft with the `DRAFT` label. For more information, see [Create and
|
|
154
|
+
# send draft emails](https://developers.google.com/workspace/gmail/api/guides/
|
|
155
|
+
# drafts).
|
|
150
156
|
# @param [String] user_id
|
|
151
157
|
# The user's email address. The special value `me` can be used to indicate the
|
|
152
158
|
# authenticated user.
|
|
@@ -191,7 +197,8 @@ module Google
|
|
|
191
197
|
end
|
|
192
198
|
|
|
193
199
|
# Immediately and permanently deletes the specified draft. Does not simply trash
|
|
194
|
-
# it.
|
|
200
|
+
# it. For more information, see [Create and send draft emails](https://
|
|
201
|
+
# developers.google.com/workspace/gmail/api/guides/drafts).
|
|
195
202
|
# @param [String] user_id
|
|
196
203
|
# The user's email address. The special value `me` can be used to indicate the
|
|
197
204
|
# authenticated user.
|
|
@@ -223,7 +230,8 @@ module Google
|
|
|
223
230
|
execute_or_queue_command(command, &block)
|
|
224
231
|
end
|
|
225
232
|
|
|
226
|
-
# Gets the specified draft.
|
|
233
|
+
# Gets the specified draft. For more information, see [Create and send draft
|
|
234
|
+
# emails](https://developers.google.com/workspace/gmail/api/guides/drafts).
|
|
227
235
|
# @param [String] user_id
|
|
228
236
|
# The user's email address. The special value `me` can be used to indicate the
|
|
229
237
|
# authenticated user.
|
|
@@ -260,7 +268,9 @@ module Google
|
|
|
260
268
|
execute_or_queue_command(command, &block)
|
|
261
269
|
end
|
|
262
270
|
|
|
263
|
-
# Lists the drafts in the user's mailbox.
|
|
271
|
+
# Lists the drafts in the user's mailbox. For more information, see [Create and
|
|
272
|
+
# send draft emails](https://developers.google.com/workspace/gmail/api/guides/
|
|
273
|
+
# drafts).
|
|
264
274
|
# @param [String] user_id
|
|
265
275
|
# The user's email address. The special value `me` can be used to indicate the
|
|
266
276
|
# authenticated user.
|
|
@@ -307,7 +317,8 @@ module Google
|
|
|
307
317
|
end
|
|
308
318
|
|
|
309
319
|
# Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `
|
|
310
|
-
# Bcc` headers.
|
|
320
|
+
# Bcc` headers. For more information, see [Create and send draft emails](https://
|
|
321
|
+
# developers.google.com/workspace/gmail/api/guides/drafts).
|
|
311
322
|
# @param [String] user_id
|
|
312
323
|
# The user's email address. The special value `me` can be used to indicate the
|
|
313
324
|
# authenticated user.
|
|
@@ -351,7 +362,8 @@ module Google
|
|
|
351
362
|
execute_or_queue_command(command, &block)
|
|
352
363
|
end
|
|
353
364
|
|
|
354
|
-
# Replaces a draft's content.
|
|
365
|
+
# Replaces a draft's content. For more information, see [Create and send draft
|
|
366
|
+
# emails](https://developers.google.com/workspace/gmail/api/guides/drafts).
|
|
355
367
|
# @param [String] user_id
|
|
356
368
|
# The user's email address. The special value `me` can be used to indicate the
|
|
357
369
|
# authenticated user.
|
|
@@ -399,7 +411,9 @@ module Google
|
|
|
399
411
|
end
|
|
400
412
|
|
|
401
413
|
# Lists the history of all changes to the given mailbox. History results are
|
|
402
|
-
# returned in chronological order (increasing `historyId`).
|
|
414
|
+
# returned in chronological order (increasing `historyId`). For more information,
|
|
415
|
+
# see [Synchronize clients with Gmail](https://developers.google.com/workspace/
|
|
416
|
+
# gmail/api/guides/sync).
|
|
403
417
|
# @param [String] user_id
|
|
404
418
|
# The user's email address. The special value `me` can be used to indicate the
|
|
405
419
|
# authenticated user.
|
|
@@ -455,7 +469,8 @@ module Google
|
|
|
455
469
|
execute_or_queue_command(command, &block)
|
|
456
470
|
end
|
|
457
471
|
|
|
458
|
-
# Creates a
|
|
472
|
+
# Creates a label. For more information, see [Manage labels](https://developers.
|
|
473
|
+
# google.com/workspace/gmail/api/guides/labels).
|
|
459
474
|
# @param [String] user_id
|
|
460
475
|
# The user's email address. The special value `me` can be used to indicate the
|
|
461
476
|
# authenticated user.
|
|
@@ -490,7 +505,9 @@ module Google
|
|
|
490
505
|
end
|
|
491
506
|
|
|
492
507
|
# Immediately and permanently deletes the specified label and removes it from
|
|
493
|
-
# any messages and threads that it
|
|
508
|
+
# any messages and threads that it's applied to. For more information, see [
|
|
509
|
+
# Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels)
|
|
510
|
+
# .
|
|
494
511
|
# @param [String] user_id
|
|
495
512
|
# The user's email address. The special value `me` can be used to indicate the
|
|
496
513
|
# authenticated user.
|
|
@@ -522,7 +539,8 @@ module Google
|
|
|
522
539
|
execute_or_queue_command(command, &block)
|
|
523
540
|
end
|
|
524
541
|
|
|
525
|
-
# Gets the specified label.
|
|
542
|
+
# Gets the specified label. For more information, see [Manage labels](https://
|
|
543
|
+
# developers.google.com/workspace/gmail/api/guides/labels).
|
|
526
544
|
# @param [String] user_id
|
|
527
545
|
# The user's email address. The special value `me` can be used to indicate the
|
|
528
546
|
# authenticated user.
|
|
@@ -556,7 +574,8 @@ module Google
|
|
|
556
574
|
execute_or_queue_command(command, &block)
|
|
557
575
|
end
|
|
558
576
|
|
|
559
|
-
# Lists all labels in the user's mailbox.
|
|
577
|
+
# Lists all labels in the user's mailbox. For more information, see [Manage
|
|
578
|
+
# labels](https://developers.google.com/workspace/gmail/api/guides/labels).
|
|
560
579
|
# @param [String] user_id
|
|
561
580
|
# The user's email address. The special value `me` can be used to indicate the
|
|
562
581
|
# authenticated user.
|
|
@@ -587,7 +606,8 @@ module Google
|
|
|
587
606
|
execute_or_queue_command(command, &block)
|
|
588
607
|
end
|
|
589
608
|
|
|
590
|
-
# Patch the specified label.
|
|
609
|
+
# Patch the specified label. For more information, see [Manage labels](https://
|
|
610
|
+
# developers.google.com/workspace/gmail/api/guides/labels).
|
|
591
611
|
# @param [String] user_id
|
|
592
612
|
# The user's email address. The special value `me` can be used to indicate the
|
|
593
613
|
# authenticated user.
|
|
@@ -624,7 +644,8 @@ module Google
|
|
|
624
644
|
execute_or_queue_command(command, &block)
|
|
625
645
|
end
|
|
626
646
|
|
|
627
|
-
# Updates the specified label.
|
|
647
|
+
# Updates the specified label. For more information, see [Manage labels](https://
|
|
648
|
+
# developers.google.com/workspace/gmail/api/guides/labels).
|
|
628
649
|
# @param [String] user_id
|
|
629
650
|
# The user's email address. The special value `me` can be used to indicate the
|
|
630
651
|
# authenticated user.
|
|
@@ -694,7 +715,13 @@ module Google
|
|
|
694
715
|
execute_or_queue_command(command, &block)
|
|
695
716
|
end
|
|
696
717
|
|
|
697
|
-
# Modifies the labels on the specified
|
|
718
|
+
# Modifies the labels and the Classification Label values on the specified
|
|
719
|
+
# messages. For administrators modifying messages for users in their
|
|
720
|
+
# organization, requests require authorization with a [service account](https://
|
|
721
|
+
# developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [
|
|
722
|
+
# domain-wide delegation authority](https://developers.google.com/identity/
|
|
723
|
+
# protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with
|
|
724
|
+
# the `https://www.googleapis.com/auth/gmail.modify.restricted` scope.
|
|
698
725
|
# @param [String] user_id
|
|
699
726
|
# The user's email address. The special value `me` can be used to indicate the
|
|
700
727
|
# authenticated user.
|
|
@@ -805,6 +832,7 @@ module Google
|
|
|
805
832
|
# scanning and classification similar to receiving via SMTP. This method doesn't
|
|
806
833
|
# perform SPF checks, so it might not work for some spam messages, such as those
|
|
807
834
|
# attempting to perform domain spoofing. This method does not send a message.
|
|
835
|
+
# Note that the maximum size of the message is 150 MB.
|
|
808
836
|
# @param [String] user_id
|
|
809
837
|
# The user's email address. The special value `me` can be used to indicate the
|
|
810
838
|
# authenticated user.
|
|
@@ -865,6 +893,8 @@ module Google
|
|
|
865
893
|
|
|
866
894
|
# Directly inserts a message into only this user's mailbox similar to `IMAP
|
|
867
895
|
# APPEND`, bypassing most scanning and classification. Does not send a message.
|
|
896
|
+
# For more information, see [Create and send email messages](https://developers.
|
|
897
|
+
# google.com/workspace/gmail/api/guides/sending).
|
|
868
898
|
# @param [String] user_id
|
|
869
899
|
# The user's email address. The special value `me` can be used to indicate the
|
|
870
900
|
# authenticated user.
|
|
@@ -915,8 +945,8 @@ module Google
|
|
|
915
945
|
execute_or_queue_command(command, &block)
|
|
916
946
|
end
|
|
917
947
|
|
|
918
|
-
# Lists the messages in the user's mailbox. For
|
|
919
|
-
# messages](https://developers.google.com/workspace/gmail/api/guides/list-
|
|
948
|
+
# Lists the messages in the user's mailbox. For more information, see [List
|
|
949
|
+
# Gmail messages](https://developers.google.com/workspace/gmail/api/guides/list-
|
|
920
950
|
# messages).
|
|
921
951
|
# @param [String] user_id
|
|
922
952
|
# The user's email address. The special value `me` can be used to indicate the
|
|
@@ -971,7 +1001,13 @@ module Google
|
|
|
971
1001
|
execute_or_queue_command(command, &block)
|
|
972
1002
|
end
|
|
973
1003
|
|
|
974
|
-
# Modifies the labels on the specified
|
|
1004
|
+
# Modifies the labels and the Classification Label values on the specified
|
|
1005
|
+
# message. For administrators modifying message for users in their organization,
|
|
1006
|
+
# requests require authorization with a [service account](https://developers.
|
|
1007
|
+
# google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide
|
|
1008
|
+
# delegation authority](https://developers.google.com/identity/protocols/
|
|
1009
|
+
# OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https:
|
|
1010
|
+
# //www.googleapis.com/auth/gmail.modify.restricted` scope.
|
|
975
1011
|
# @param [String] user_id
|
|
976
1012
|
# The user's email address. The special value `me` can be used to indicate the
|
|
977
1013
|
# authenticated user.
|
|
@@ -1009,8 +1045,8 @@ module Google
|
|
|
1009
1045
|
end
|
|
1010
1046
|
|
|
1011
1047
|
# Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc`
|
|
1012
|
-
# headers. For
|
|
1013
|
-
# workspace/gmail/api/guides/sending).
|
|
1048
|
+
# headers. For more information, see [Create and send email messages](https://
|
|
1049
|
+
# developers.google.com/workspace/gmail/api/guides/sending).
|
|
1014
1050
|
# @param [String] user_id
|
|
1015
1051
|
# The user's email address. The special value `me` can be used to indicate the
|
|
1016
1052
|
# authenticated user.
|
|
@@ -1159,7 +1195,9 @@ module Google
|
|
|
1159
1195
|
execute_or_queue_command(command, &block)
|
|
1160
1196
|
end
|
|
1161
1197
|
|
|
1162
|
-
# Gets the auto-forwarding setting for the specified account.
|
|
1198
|
+
# Gets the auto-forwarding setting for the specified account. For more
|
|
1199
|
+
# information, see [Manage email forwarding](https://developers.google.com/
|
|
1200
|
+
# workspace/gmail/api/guides/forwarding_settings).
|
|
1163
1201
|
# @param [String] user_id
|
|
1164
1202
|
# User's email address. The special value "me" can be used to indicate the
|
|
1165
1203
|
# authenticated user.
|
|
@@ -1190,7 +1228,9 @@ module Google
|
|
|
1190
1228
|
execute_or_queue_command(command, &block)
|
|
1191
1229
|
end
|
|
1192
1230
|
|
|
1193
|
-
# Gets IMAP settings.
|
|
1231
|
+
# Gets IMAP settings. For more information, see [Configure POP and IMAP settings
|
|
1232
|
+
# with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/
|
|
1233
|
+
# pop_imap_settings).
|
|
1194
1234
|
# @param [String] user_id
|
|
1195
1235
|
# User's email address. The special value "me" can be used to indicate the
|
|
1196
1236
|
# authenticated user.
|
|
@@ -1221,7 +1261,8 @@ module Google
|
|
|
1221
1261
|
execute_or_queue_command(command, &block)
|
|
1222
1262
|
end
|
|
1223
1263
|
|
|
1224
|
-
# Gets language settings.
|
|
1264
|
+
# Gets language settings. For more information, see [Manage language settings](
|
|
1265
|
+
# https://developers.google.com/workspace/gmail/api/guides/language-settings).
|
|
1225
1266
|
# @param [String] user_id
|
|
1226
1267
|
# User's email address. The special value "me" can be used to indicate the
|
|
1227
1268
|
# authenticated user.
|
|
@@ -1252,7 +1293,9 @@ module Google
|
|
|
1252
1293
|
execute_or_queue_command(command, &block)
|
|
1253
1294
|
end
|
|
1254
1295
|
|
|
1255
|
-
# Gets POP settings.
|
|
1296
|
+
# Gets POP settings. For more information, see [Configure POP and IMAP settings
|
|
1297
|
+
# with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/
|
|
1298
|
+
# pop_imap_settings).
|
|
1256
1299
|
# @param [String] user_id
|
|
1257
1300
|
# User's email address. The special value "me" can be used to indicate the
|
|
1258
1301
|
# authenticated user.
|
|
@@ -1283,7 +1326,9 @@ module Google
|
|
|
1283
1326
|
execute_or_queue_command(command, &block)
|
|
1284
1327
|
end
|
|
1285
1328
|
|
|
1286
|
-
# Gets vacation responder settings.
|
|
1329
|
+
# Gets vacation responder settings. For more information, see [Manage vacation
|
|
1330
|
+
# settings with the Gmail API](https://developers.google.com/workspace/gmail/api/
|
|
1331
|
+
# guides/vacation_settings).
|
|
1287
1332
|
# @param [String] user_id
|
|
1288
1333
|
# User's email address. The special value "me" can be used to indicate the
|
|
1289
1334
|
# authenticated user.
|
|
@@ -1315,9 +1360,10 @@ module Google
|
|
|
1315
1360
|
end
|
|
1316
1361
|
|
|
1317
1362
|
# Updates the auto-forwarding setting for the specified account. A verified
|
|
1318
|
-
# forwarding address must be specified when auto-forwarding is enabled.
|
|
1319
|
-
#
|
|
1320
|
-
#
|
|
1363
|
+
# forwarding address must be specified when auto-forwarding is enabled. For more
|
|
1364
|
+
# information, see [Manage email forwarding](https://developers.google.com/
|
|
1365
|
+
# workspace/gmail/api/guides/forwarding_settings). This method is only available
|
|
1366
|
+
# to service account clients that have been delegated domain-wide authority.
|
|
1321
1367
|
# @param [String] user_id
|
|
1322
1368
|
# User's email address. The special value "me" can be used to indicate the
|
|
1323
1369
|
# authenticated user.
|
|
@@ -1351,7 +1397,9 @@ module Google
|
|
|
1351
1397
|
execute_or_queue_command(command, &block)
|
|
1352
1398
|
end
|
|
1353
1399
|
|
|
1354
|
-
# Updates IMAP settings.
|
|
1400
|
+
# Updates IMAP settings. For more information, see [Configure POP and IMAP
|
|
1401
|
+
# settings with the Gmail API](https://developers.google.com/workspace/gmail/api/
|
|
1402
|
+
# guides/pop_imap_settings).
|
|
1355
1403
|
# @param [String] user_id
|
|
1356
1404
|
# User's email address. The special value "me" can be used to indicate the
|
|
1357
1405
|
# authenticated user.
|
|
@@ -1385,11 +1433,13 @@ module Google
|
|
|
1385
1433
|
execute_or_queue_command(command, &block)
|
|
1386
1434
|
end
|
|
1387
1435
|
|
|
1388
|
-
# Updates language settings.
|
|
1389
|
-
#
|
|
1390
|
-
#
|
|
1391
|
-
#
|
|
1392
|
-
# the
|
|
1436
|
+
# Updates language settings. For more information, see [Manage language settings]
|
|
1437
|
+
# (https://developers.google.com/workspace/gmail/api/guides/language-settings).
|
|
1438
|
+
# If successful, the return object contains the `displayLanguage` that was saved
|
|
1439
|
+
# for the user, which may differ from the value passed into the request. This is
|
|
1440
|
+
# because the requested `displayLanguage` may not be directly supported by Gmail
|
|
1441
|
+
# but have a close variant that is, and so the variant may be chosen and saved
|
|
1442
|
+
# instead.
|
|
1393
1443
|
# @param [String] user_id
|
|
1394
1444
|
# User's email address. The special value "me" can be used to indicate the
|
|
1395
1445
|
# authenticated user.
|
|
@@ -1423,7 +1473,9 @@ module Google
|
|
|
1423
1473
|
execute_or_queue_command(command, &block)
|
|
1424
1474
|
end
|
|
1425
1475
|
|
|
1426
|
-
# Updates POP settings.
|
|
1476
|
+
# Updates POP settings. For more information, see [Configure POP and IMAP
|
|
1477
|
+
# settings with the Gmail API](https://developers.google.com/workspace/gmail/api/
|
|
1478
|
+
# guides/pop_imap_settings).
|
|
1427
1479
|
# @param [String] user_id
|
|
1428
1480
|
# User's email address. The special value "me" can be used to indicate the
|
|
1429
1481
|
# authenticated user.
|
|
@@ -1457,7 +1509,9 @@ module Google
|
|
|
1457
1509
|
execute_or_queue_command(command, &block)
|
|
1458
1510
|
end
|
|
1459
1511
|
|
|
1460
|
-
# Updates vacation responder settings.
|
|
1512
|
+
# Updates vacation responder settings. For more information, see [Manage
|
|
1513
|
+
# vacation settings with the Gmail API](https://developers.google.com/workspace/
|
|
1514
|
+
# gmail/api/guides/vacation_settings).
|
|
1461
1515
|
# @param [String] user_id
|
|
1462
1516
|
# User's email address. The special value "me" can be used to indicate the
|
|
1463
1517
|
# authenticated user.
|
|
@@ -1733,6 +1787,10 @@ module Google
|
|
|
1733
1787
|
# The requester's primary email address. To indicate the authenticated user, you
|
|
1734
1788
|
# can use the special value `me`.
|
|
1735
1789
|
# @param [Google::Apis::GmailV1::CseKeyPair] cse_key_pair_object
|
|
1790
|
+
# @param [String] chain_validation
|
|
1791
|
+
# The type of certificate chain validation to perform at creation. The request
|
|
1792
|
+
# will be rejected if the uploaded chain fails to satisfy the requested
|
|
1793
|
+
# validation checks. When unspecified, this parameter defaults to `all`.
|
|
1736
1794
|
# @param [String] fields
|
|
1737
1795
|
# Selector specifying which fields to include in a partial response.
|
|
1738
1796
|
# @param [String] quota_user
|
|
@@ -1750,13 +1808,14 @@ module Google
|
|
|
1750
1808
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1751
1809
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1752
1810
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1753
|
-
def create_user_setting_cse_keypair(user_id, cse_key_pair_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1811
|
+
def create_user_setting_cse_keypair(user_id, cse_key_pair_object = nil, chain_validation: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1754
1812
|
command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/cse/keypairs', options)
|
|
1755
1813
|
command.request_representation = Google::Apis::GmailV1::CseKeyPair::Representation
|
|
1756
1814
|
command.request_object = cse_key_pair_object
|
|
1757
1815
|
command.response_representation = Google::Apis::GmailV1::CseKeyPair::Representation
|
|
1758
1816
|
command.response_class = Google::Apis::GmailV1::CseKeyPair
|
|
1759
1817
|
command.params['userId'] = user_id unless user_id.nil?
|
|
1818
|
+
command.query['chainValidation'] = chain_validation unless chain_validation.nil?
|
|
1760
1819
|
command.query['fields'] = fields unless fields.nil?
|
|
1761
1820
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1762
1821
|
execute_or_queue_command(command, &block)
|
|
@@ -1998,15 +2057,16 @@ module Google
|
|
|
1998
2057
|
|
|
1999
2058
|
# Adds a delegate with its verification status set directly to `accepted`,
|
|
2000
2059
|
# without sending any verification email. The delegate user must be a member of
|
|
2001
|
-
# the same Google Workspace organization as the delegator user.
|
|
2002
|
-
#
|
|
2003
|
-
#
|
|
2004
|
-
#
|
|
2005
|
-
#
|
|
2006
|
-
#
|
|
2007
|
-
#
|
|
2008
|
-
#
|
|
2009
|
-
#
|
|
2060
|
+
# the same Google Workspace organization as the delegator user. For more
|
|
2061
|
+
# information, see [Manage delegates](https://developers.google.com/workspace/
|
|
2062
|
+
# gmail/api/guides/delegate_settings). Gmail imposes limitations on the number
|
|
2063
|
+
# of delegates and delegators each user in a Google Workspace organization can
|
|
2064
|
+
# have. These limits depend on your organization, but in general each user can
|
|
2065
|
+
# have up to 25 delegates and up to 10 delegators. A delegate user must be
|
|
2066
|
+
# referred to by their primary email address, and not an email alias. When a new
|
|
2067
|
+
# delegate is created, there may be up to a one minute delay before the new
|
|
2068
|
+
# delegate is available for use. This method is only available to service
|
|
2069
|
+
# account clients that have been delegated domain-wide authority.
|
|
2010
2070
|
# @param [String] user_id
|
|
2011
2071
|
# User's email address. The special value "me" can be used to indicate the
|
|
2012
2072
|
# authenticated user.
|
|
@@ -2041,10 +2101,12 @@ module Google
|
|
|
2041
2101
|
end
|
|
2042
2102
|
|
|
2043
2103
|
# Removes the specified delegate (which can be of any verification status), and
|
|
2044
|
-
# revokes any verification that may have been required for using it.
|
|
2045
|
-
#
|
|
2046
|
-
#
|
|
2047
|
-
#
|
|
2104
|
+
# revokes any verification that may have been required for using it. For more
|
|
2105
|
+
# information, see [Manage delegates](https://developers.google.com/workspace/
|
|
2106
|
+
# gmail/api/guides/delegate_settings). A delegate user must be referred to by
|
|
2107
|
+
# their primary email address, and not an email alias. This method is only
|
|
2108
|
+
# available to service account clients that have been delegated domain-wide
|
|
2109
|
+
# authority.
|
|
2048
2110
|
# @param [String] user_id
|
|
2049
2111
|
# User's email address. The special value "me" can be used to indicate the
|
|
2050
2112
|
# authenticated user.
|
|
@@ -2076,10 +2138,11 @@ module Google
|
|
|
2076
2138
|
execute_or_queue_command(command, &block)
|
|
2077
2139
|
end
|
|
2078
2140
|
|
|
2079
|
-
# Gets the specified delegate.
|
|
2080
|
-
#
|
|
2081
|
-
#
|
|
2082
|
-
#
|
|
2141
|
+
# Gets the specified delegate. For more information, see [Manage delegates](
|
|
2142
|
+
# https://developers.google.com/workspace/gmail/api/guides/delegate_settings). A
|
|
2143
|
+
# delegate user must be referred to by their primary email address, and not an
|
|
2144
|
+
# email alias. This method is only available to service account clients that
|
|
2145
|
+
# have been delegated domain-wide authority.
|
|
2083
2146
|
# @param [String] user_id
|
|
2084
2147
|
# User's email address. The special value "me" can be used to indicate the
|
|
2085
2148
|
# authenticated user.
|
|
@@ -2113,8 +2176,10 @@ module Google
|
|
|
2113
2176
|
execute_or_queue_command(command, &block)
|
|
2114
2177
|
end
|
|
2115
2178
|
|
|
2116
|
-
# Lists the delegates for the specified account.
|
|
2117
|
-
#
|
|
2179
|
+
# Lists the delegates for the specified account. For more information, see [
|
|
2180
|
+
# Manage delegates](https://developers.google.com/workspace/gmail/api/guides/
|
|
2181
|
+
# delegate_settings). This method is only available to service account clients
|
|
2182
|
+
# that have been delegated domain-wide authority.
|
|
2118
2183
|
# @param [String] user_id
|
|
2119
2184
|
# User's email address. The special value "me" can be used to indicate the
|
|
2120
2185
|
# authenticated user.
|
|
@@ -2145,7 +2210,9 @@ module Google
|
|
|
2145
2210
|
execute_or_queue_command(command, &block)
|
|
2146
2211
|
end
|
|
2147
2212
|
|
|
2148
|
-
# Creates a filter. Note: you can only create a maximum of 1,000 filters.
|
|
2213
|
+
# Creates a filter. Note: you can only create a maximum of 1,000 filters. For
|
|
2214
|
+
# more information, see [Manage Gmail filters](https://developers.google.com/
|
|
2215
|
+
# workspace/gmail/api/guides/filter_settings).
|
|
2149
2216
|
# @param [String] user_id
|
|
2150
2217
|
# User's email address. The special value "me" can be used to indicate the
|
|
2151
2218
|
# authenticated user.
|
|
@@ -2179,7 +2246,9 @@ module Google
|
|
|
2179
2246
|
execute_or_queue_command(command, &block)
|
|
2180
2247
|
end
|
|
2181
2248
|
|
|
2182
|
-
# Immediately and permanently deletes the specified filter.
|
|
2249
|
+
# Immediately and permanently deletes the specified filter. For more information,
|
|
2250
|
+
# see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/
|
|
2251
|
+
# guides/filter_settings).
|
|
2183
2252
|
# @param [String] user_id
|
|
2184
2253
|
# User's email address. The special value "me" can be used to indicate the
|
|
2185
2254
|
# authenticated user.
|
|
@@ -2211,7 +2280,8 @@ module Google
|
|
|
2211
2280
|
execute_or_queue_command(command, &block)
|
|
2212
2281
|
end
|
|
2213
2282
|
|
|
2214
|
-
# Gets a filter.
|
|
2283
|
+
# Gets a filter. For more information, see [Manage Gmail filters](https://
|
|
2284
|
+
# developers.google.com/workspace/gmail/api/guides/filter_settings).
|
|
2215
2285
|
# @param [String] user_id
|
|
2216
2286
|
# User's email address. The special value "me" can be used to indicate the
|
|
2217
2287
|
# authenticated user.
|
|
@@ -2245,7 +2315,9 @@ module Google
|
|
|
2245
2315
|
execute_or_queue_command(command, &block)
|
|
2246
2316
|
end
|
|
2247
2317
|
|
|
2248
|
-
# Lists the message filters of a Gmail user.
|
|
2318
|
+
# Lists the message filters of a Gmail user. For more information, see [Manage
|
|
2319
|
+
# Gmail filters](https://developers.google.com/workspace/gmail/api/guides/
|
|
2320
|
+
# filter_settings).
|
|
2249
2321
|
# @param [String] user_id
|
|
2250
2322
|
# User's email address. The special value "me" can be used to indicate the
|
|
2251
2323
|
# authenticated user.
|
|
@@ -2279,8 +2351,10 @@ module Google
|
|
|
2279
2351
|
# Creates a forwarding address. If ownership verification is required, a message
|
|
2280
2352
|
# will be sent to the recipient and the resource's verification status will be
|
|
2281
2353
|
# set to `pending`; otherwise, the resource will be created with verification
|
|
2282
|
-
# status set to `accepted`.
|
|
2283
|
-
#
|
|
2354
|
+
# status set to `accepted`. For more information, see [Manage email forwarding](
|
|
2355
|
+
# https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).
|
|
2356
|
+
# This method is only available to service account clients that have been
|
|
2357
|
+
# delegated domain-wide authority.
|
|
2284
2358
|
# @param [String] user_id
|
|
2285
2359
|
# User's email address. The special value "me" can be used to indicate the
|
|
2286
2360
|
# authenticated user.
|
|
@@ -2315,8 +2389,10 @@ module Google
|
|
|
2315
2389
|
end
|
|
2316
2390
|
|
|
2317
2391
|
# Deletes the specified forwarding address and revokes any verification that may
|
|
2318
|
-
# have been required.
|
|
2319
|
-
#
|
|
2392
|
+
# have been required. For more information, see [Manage email forwarding](https:/
|
|
2393
|
+
# /developers.google.com/workspace/gmail/api/guides/forwarding_settings). This
|
|
2394
|
+
# method is only available to service account clients that have been delegated
|
|
2395
|
+
# domain-wide authority.
|
|
2320
2396
|
# @param [String] user_id
|
|
2321
2397
|
# User's email address. The special value "me" can be used to indicate the
|
|
2322
2398
|
# authenticated user.
|
|
@@ -2348,7 +2424,9 @@ module Google
|
|
|
2348
2424
|
execute_or_queue_command(command, &block)
|
|
2349
2425
|
end
|
|
2350
2426
|
|
|
2351
|
-
# Gets the specified forwarding address.
|
|
2427
|
+
# Gets the specified forwarding address. For more information, see [Manage email
|
|
2428
|
+
# forwarding](https://developers.google.com/workspace/gmail/api/guides/
|
|
2429
|
+
# forwarding_settings).
|
|
2352
2430
|
# @param [String] user_id
|
|
2353
2431
|
# User's email address. The special value "me" can be used to indicate the
|
|
2354
2432
|
# authenticated user.
|
|
@@ -2382,7 +2460,9 @@ module Google
|
|
|
2382
2460
|
execute_or_queue_command(command, &block)
|
|
2383
2461
|
end
|
|
2384
2462
|
|
|
2385
|
-
# Lists the forwarding addresses for the specified account.
|
|
2463
|
+
# Lists the forwarding addresses for the specified account. For more information,
|
|
2464
|
+
# see [Manage email forwarding](https://developers.google.com/workspace/gmail/
|
|
2465
|
+
# api/guides/forwarding_settings).
|
|
2386
2466
|
# @param [String] user_id
|
|
2387
2467
|
# User's email address. The special value "me" can be used to indicate the
|
|
2388
2468
|
# authenticated user.
|
|
@@ -2419,8 +2499,10 @@ module Google
|
|
|
2419
2499
|
# message will be sent to the email address and the resource's verification
|
|
2420
2500
|
# status will be set to `pending`; otherwise, the resource will be created with
|
|
2421
2501
|
# verification status set to `accepted`. If a signature is provided, Gmail will
|
|
2422
|
-
# sanitize the HTML before saving it with the alias.
|
|
2423
|
-
#
|
|
2502
|
+
# sanitize the HTML before saving it with the alias. For more information, see [
|
|
2503
|
+
# Manage aliases and signatures with the Gmail API](https://developers.google.
|
|
2504
|
+
# com/workspace/gmail/api/guides/alias_and_signature_settings). This method is
|
|
2505
|
+
# only available to service account clients that have been delegated domain-wide
|
|
2424
2506
|
# authority.
|
|
2425
2507
|
# @param [String] user_id
|
|
2426
2508
|
# User's email address. The special value "me" can be used to indicate the
|
|
@@ -2456,8 +2538,10 @@ module Google
|
|
|
2456
2538
|
end
|
|
2457
2539
|
|
|
2458
2540
|
# Deletes the specified send-as alias. Revokes any verification that may have
|
|
2459
|
-
# been required for using it.
|
|
2460
|
-
#
|
|
2541
|
+
# been required for using it. For more information, see [Manage aliases and
|
|
2542
|
+
# signatures with the Gmail API](https://developers.google.com/workspace/gmail/
|
|
2543
|
+
# api/guides/alias_and_signature_settings). This method is only available to
|
|
2544
|
+
# service account clients that have been delegated domain-wide authority.
|
|
2461
2545
|
# @param [String] user_id
|
|
2462
2546
|
# User's email address. The special value "me" can be used to indicate the
|
|
2463
2547
|
# authenticated user.
|
|
@@ -2490,7 +2574,9 @@ module Google
|
|
|
2490
2574
|
end
|
|
2491
2575
|
|
|
2492
2576
|
# Gets the specified send-as alias. Fails with an HTTP 404 error if the
|
|
2493
|
-
# specified address is not a member of the collection.
|
|
2577
|
+
# specified address is not a member of the collection. For more information, see
|
|
2578
|
+
# [Manage aliases and signatures with the Gmail API](https://developers.google.
|
|
2579
|
+
# com/workspace/gmail/api/guides/alias_and_signature_settings).
|
|
2494
2580
|
# @param [String] user_id
|
|
2495
2581
|
# User's email address. The special value "me" can be used to indicate the
|
|
2496
2582
|
# authenticated user.
|
|
@@ -2526,7 +2612,9 @@ module Google
|
|
|
2526
2612
|
|
|
2527
2613
|
# Lists the send-as aliases for the specified account. The result includes the
|
|
2528
2614
|
# primary send-as address associated with the account as well as any custom "
|
|
2529
|
-
# from" aliases.
|
|
2615
|
+
# from" aliases. For more information, see [Manage aliases and signatures with
|
|
2616
|
+
# the Gmail API](https://developers.google.com/workspace/gmail/api/guides/
|
|
2617
|
+
# alias_and_signature_settings).
|
|
2530
2618
|
# @param [String] user_id
|
|
2531
2619
|
# User's email address. The special value "me" can be used to indicate the
|
|
2532
2620
|
# authenticated user.
|
|
@@ -2557,7 +2645,9 @@ module Google
|
|
|
2557
2645
|
execute_or_queue_command(command, &block)
|
|
2558
2646
|
end
|
|
2559
2647
|
|
|
2560
|
-
# Patch the specified send-as alias.
|
|
2648
|
+
# Patch the specified send-as alias. For more information, see [Manage aliases
|
|
2649
|
+
# and signatures with the Gmail API](https://developers.google.com/workspace/
|
|
2650
|
+
# gmail/api/guides/alias_and_signature_settings).
|
|
2561
2651
|
# @param [String] user_id
|
|
2562
2652
|
# User's email address. The special value "me" can be used to indicate the
|
|
2563
2653
|
# authenticated user.
|
|
@@ -2595,9 +2685,11 @@ module Google
|
|
|
2595
2685
|
end
|
|
2596
2686
|
|
|
2597
2687
|
# Updates a send-as alias. If a signature is provided, Gmail will sanitize the
|
|
2598
|
-
# HTML before saving it with the alias.
|
|
2599
|
-
#
|
|
2600
|
-
#
|
|
2688
|
+
# HTML before saving it with the alias. For more information, see [Manage
|
|
2689
|
+
# aliases and signatures with the Gmail API](https://developers.google.com/
|
|
2690
|
+
# workspace/gmail/api/guides/alias_and_signature_settings). Addresses other than
|
|
2691
|
+
# the primary address for the account can only be updated by service account
|
|
2692
|
+
# clients that have been delegated domain-wide authority.
|
|
2601
2693
|
# @param [String] user_id
|
|
2602
2694
|
# User's email address. The special value "me" can be used to indicate the
|
|
2603
2695
|
# authenticated user.
|
|
@@ -2635,8 +2727,11 @@ module Google
|
|
|
2635
2727
|
end
|
|
2636
2728
|
|
|
2637
2729
|
# Sends a verification email to the specified send-as alias address. The
|
|
2638
|
-
# verification status must be `pending`.
|
|
2639
|
-
#
|
|
2730
|
+
# verification status must be `pending`. For more information, see [Manage
|
|
2731
|
+
# aliases and signatures with the Gmail API](https://developers.google.com/
|
|
2732
|
+
# workspace/gmail/api/guides/alias_and_signature_settings). This method is only
|
|
2733
|
+
# available to service account clients that have been delegated domain-wide
|
|
2734
|
+
# authority.
|
|
2640
2735
|
# @param [String] user_id
|
|
2641
2736
|
# User's email address. The special value "me" can be used to indicate the
|
|
2642
2737
|
# authenticated user.
|
|
@@ -2668,7 +2763,9 @@ module Google
|
|
|
2668
2763
|
execute_or_queue_command(command, &block)
|
|
2669
2764
|
end
|
|
2670
2765
|
|
|
2671
|
-
# Deletes the specified S/MIME config for the specified send-as alias.
|
|
2766
|
+
# Deletes the specified S/MIME config for the specified send-as alias. For more
|
|
2767
|
+
# information, see [Manage S/MIME certificates with the Gmail API](https://
|
|
2768
|
+
# developers.google.com/workspace/gmail/api/guides/smime_certs).
|
|
2672
2769
|
# @param [String] user_id
|
|
2673
2770
|
# The user's email address. The special value `me` can be used to indicate the
|
|
2674
2771
|
# authenticated user.
|
|
@@ -2704,7 +2801,9 @@ module Google
|
|
|
2704
2801
|
execute_or_queue_command(command, &block)
|
|
2705
2802
|
end
|
|
2706
2803
|
|
|
2707
|
-
# Gets the specified S/MIME config for the specified send-as alias.
|
|
2804
|
+
# Gets the specified S/MIME config for the specified send-as alias. For more
|
|
2805
|
+
# information, see [Manage S/MIME certificates with the Gmail API](https://
|
|
2806
|
+
# developers.google.com/workspace/gmail/api/guides/smime_certs).
|
|
2708
2807
|
# @param [String] user_id
|
|
2709
2808
|
# The user's email address. The special value `me` can be used to indicate the
|
|
2710
2809
|
# authenticated user.
|
|
@@ -2743,7 +2842,9 @@ module Google
|
|
|
2743
2842
|
end
|
|
2744
2843
|
|
|
2745
2844
|
# Insert (upload) the given S/MIME config for the specified send-as alias. Note
|
|
2746
|
-
# that pkcs12 format is required for the key.
|
|
2845
|
+
# that `pkcs12` format is required for the key. For more information, see [
|
|
2846
|
+
# Manage S/MIME certificates with the Gmail API](https://developers.google.com/
|
|
2847
|
+
# workspace/gmail/api/guides/smime_certs).
|
|
2747
2848
|
# @param [String] user_id
|
|
2748
2849
|
# The user's email address. The special value `me` can be used to indicate the
|
|
2749
2850
|
# authenticated user.
|
|
@@ -2781,7 +2882,9 @@ module Google
|
|
|
2781
2882
|
execute_or_queue_command(command, &block)
|
|
2782
2883
|
end
|
|
2783
2884
|
|
|
2784
|
-
# Lists S/MIME configs for the specified send-as alias.
|
|
2885
|
+
# Lists S/MIME configs for the specified send-as alias. For more information,
|
|
2886
|
+
# see [Manage S/MIME certificates with the Gmail API](https://developers.google.
|
|
2887
|
+
# com/workspace/gmail/api/guides/smime_certs).
|
|
2785
2888
|
# @param [String] user_id
|
|
2786
2889
|
# The user's email address. The special value `me` can be used to indicate the
|
|
2787
2890
|
# authenticated user.
|
|
@@ -2816,7 +2919,9 @@ module Google
|
|
|
2816
2919
|
execute_or_queue_command(command, &block)
|
|
2817
2920
|
end
|
|
2818
2921
|
|
|
2819
|
-
# Sets the default S/MIME config for the specified send-as alias.
|
|
2922
|
+
# Sets the default S/MIME config for the specified send-as alias. For more
|
|
2923
|
+
# information, see [Manage S/MIME certificates with the Gmail API](https://
|
|
2924
|
+
# developers.google.com/workspace/gmail/api/guides/smime_certs).
|
|
2820
2925
|
# @param [String] user_id
|
|
2821
2926
|
# The user's email address. The special value `me` can be used to indicate the
|
|
2822
2927
|
# authenticated user.
|
|
@@ -2854,7 +2959,8 @@ module Google
|
|
|
2854
2959
|
|
|
2855
2960
|
# Immediately and permanently deletes the specified thread. Any messages that
|
|
2856
2961
|
# belong to the thread are also deleted. This operation cannot be undone. Prefer
|
|
2857
|
-
# `threads.trash` instead.
|
|
2962
|
+
# `threads.trash` instead. For more information, see [Manage threads](https://
|
|
2963
|
+
# developers.google.com/workspace/gmail/api/guides/threads).
|
|
2858
2964
|
# @param [String] user_id
|
|
2859
2965
|
# The user's email address. The special value `me` can be used to indicate the
|
|
2860
2966
|
# authenticated user.
|
|
@@ -2886,7 +2992,8 @@ module Google
|
|
|
2886
2992
|
execute_or_queue_command(command, &block)
|
|
2887
2993
|
end
|
|
2888
2994
|
|
|
2889
|
-
# Gets the specified thread.
|
|
2995
|
+
# Gets the specified thread. For more information, see [Manage threads](https://
|
|
2996
|
+
# developers.google.com/workspace/gmail/api/guides/threads).
|
|
2890
2997
|
# @param [String] user_id
|
|
2891
2998
|
# The user's email address. The special value `me` can be used to indicate the
|
|
2892
2999
|
# authenticated user.
|
|
@@ -2926,7 +3033,8 @@ module Google
|
|
|
2926
3033
|
execute_or_queue_command(command, &block)
|
|
2927
3034
|
end
|
|
2928
3035
|
|
|
2929
|
-
# Lists the threads in the user's mailbox.
|
|
3036
|
+
# Lists the threads in the user's mailbox. For more information, see [Manage
|
|
3037
|
+
# threads](https://developers.google.com/workspace/gmail/api/guides/threads).
|
|
2930
3038
|
# @param [String] user_id
|
|
2931
3039
|
# The user's email address. The special value `me` can be used to indicate the
|
|
2932
3040
|
# authenticated user.
|
|
@@ -2977,7 +3085,8 @@ module Google
|
|
|
2977
3085
|
end
|
|
2978
3086
|
|
|
2979
3087
|
# Modifies the labels applied to the thread. This applies to all messages in the
|
|
2980
|
-
# thread.
|
|
3088
|
+
# thread. For more information, see [Manage threads](https://developers.google.
|
|
3089
|
+
# com/workspace/gmail/api/guides/threads).
|
|
2981
3090
|
# @param [String] user_id
|
|
2982
3091
|
# The user's email address. The special value `me` can be used to indicate the
|
|
2983
3092
|
# authenticated user.
|
|
@@ -3015,7 +3124,8 @@ module Google
|
|
|
3015
3124
|
end
|
|
3016
3125
|
|
|
3017
3126
|
# Moves the specified thread to the trash. Any messages that belong to the
|
|
3018
|
-
# thread are also moved to the trash.
|
|
3127
|
+
# thread are also moved to the trash. For more information, see [Manage threads](
|
|
3128
|
+
# https://developers.google.com/workspace/gmail/api/guides/threads).
|
|
3019
3129
|
# @param [String] user_id
|
|
3020
3130
|
# The user's email address. The special value `me` can be used to indicate the
|
|
3021
3131
|
# authenticated user.
|
|
@@ -3050,7 +3160,8 @@ module Google
|
|
|
3050
3160
|
end
|
|
3051
3161
|
|
|
3052
3162
|
# Removes the specified thread from the trash. Any messages that belong to the
|
|
3053
|
-
# thread are also removed from the trash.
|
|
3163
|
+
# thread are also removed from the trash. For more information, see [Manage
|
|
3164
|
+
# threads](https://developers.google.com/workspace/gmail/api/guides/threads).
|
|
3054
3165
|
# @param [String] user_id
|
|
3055
3166
|
# The user's email address. The special value `me` can be used to indicate the
|
|
3056
3167
|
# authenticated user.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-apis-gmail_v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.53.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
@@ -57,7 +57,7 @@ licenses:
|
|
|
57
57
|
metadata:
|
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-gmail_v1/CHANGELOG.md
|
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-gmail_v1/v0.
|
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-gmail_v1/v0.53.0
|
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-gmail_v1
|
|
62
62
|
rdoc_options: []
|
|
63
63
|
require_paths:
|
|
@@ -66,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
66
66
|
requirements:
|
|
67
67
|
- - ">="
|
|
68
68
|
- !ruby/object:Gem::Version
|
|
69
|
-
version: '3.
|
|
69
|
+
version: '3.2'
|
|
70
70
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
71
71
|
requirements:
|
|
72
72
|
- - ">="
|