google-api-client 0.39.2 → 0.39.3
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 +36 -0
- data/generated/google/apis/appengine_v1.rb +1 -1
- data/generated/google/apis/appengine_v1/classes.rb +7 -0
- data/generated/google/apis/appengine_v1/representations.rb +1 -0
- data/generated/google/apis/appengine_v1beta.rb +1 -1
- data/generated/google/apis/appengine_v1beta/classes.rb +7 -0
- data/generated/google/apis/appengine_v1beta/representations.rb +1 -0
- data/generated/google/apis/bigqueryreservation_v1.rb +1 -1
- data/generated/google/apis/bigqueryreservation_v1/classes.rb +19 -15
- data/generated/google/apis/bigqueryreservation_v1/service.rb +86 -73
- data/generated/google/apis/bigqueryreservation_v1alpha2.rb +1 -1
- data/generated/google/apis/bigqueryreservation_v1beta1.rb +1 -1
- data/generated/google/apis/bigqueryreservation_v1beta1/classes.rb +0 -47
- data/generated/google/apis/bigqueryreservation_v1beta1/representations.rb +0 -16
- data/generated/google/apis/cloudkms_v1.rb +1 -1
- data/generated/google/apis/cloudkms_v1/classes.rb +26 -14
- data/generated/google/apis/cloudkms_v1/service.rb +15 -6
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +26 -10
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +26 -10
- data/generated/google/apis/cloudresourcemanager_v2.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2/classes.rb +26 -10
- data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +26 -10
- data/generated/google/apis/cloudshell_v1.rb +1 -1
- data/generated/google/apis/cloudshell_v1alpha1.rb +1 -1
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +3 -2
- data/generated/google/apis/container_v1beta1.rb +1 -1
- data/generated/google/apis/container_v1beta1/classes.rb +3 -2
- data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1beta1/classes.rb +4 -4
- data/generated/google/apis/games_management_v1management.rb +6 -4
- data/generated/google/apis/games_management_v1management/classes.rb +50 -90
- data/generated/google/apis/games_management_v1management/representations.rb +0 -17
- data/generated/google/apis/games_management_v1management/service.rb +115 -291
- data/generated/google/apis/gameservices_v1beta.rb +1 -1
- data/generated/google/apis/gameservices_v1beta/classes.rb +73 -60
- data/generated/google/apis/gameservices_v1beta/service.rb +60 -57
- data/generated/google/apis/gmail_v1.rb +2 -3
- data/generated/google/apis/gmail_v1/classes.rb +199 -258
- data/generated/google/apis/gmail_v1/service.rb +744 -552
- data/generated/google/apis/healthcare_v1.rb +1 -1
- data/generated/google/apis/healthcare_v1/classes.rb +34 -22
- data/generated/google/apis/healthcare_v1/service.rb +46 -111
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/healthcare_v1beta1/classes.rb +34 -22
- data/generated/google/apis/healthcare_v1beta1/service.rb +63 -113
- data/generated/google/apis/iap_v1.rb +1 -1
- data/generated/google/apis/iap_v1/classes.rb +35 -12
- data/generated/google/apis/iap_v1/representations.rb +1 -0
- data/generated/google/apis/iap_v1/service.rb +1 -1
- data/generated/google/apis/iap_v1beta1.rb +1 -1
- data/generated/google/apis/iap_v1beta1/classes.rb +26 -10
- data/generated/google/apis/jobs_v3p1beta1.rb +1 -1
- data/generated/google/apis/osconfig_v1.rb +1 -1
- data/generated/google/apis/osconfig_v1/classes.rb +29 -27
- data/generated/google/apis/osconfig_v1beta.rb +1 -1
- data/generated/google/apis/osconfig_v1beta/classes.rb +17 -20
- data/generated/google/apis/run_v1.rb +1 -1
- data/generated/google/apis/run_v1/classes.rb +31 -49
- data/generated/google/apis/run_v1/representations.rb +1 -17
- data/generated/google/apis/run_v1/service.rb +3 -0
- data/generated/google/apis/run_v1alpha1.rb +1 -1
- data/generated/google/apis/run_v1alpha1/classes.rb +23 -10
- data/generated/google/apis/run_v1alpha1/service.rb +3 -0
- data/generated/google/apis/sheets_v4.rb +1 -1
- data/generated/google/apis/spanner_v1.rb +1 -1
- data/generated/google/apis/storage_v1.rb +1 -1
- data/generated/google/apis/storage_v1/classes.rb +18 -0
- data/generated/google/apis/storage_v1/representations.rb +3 -0
- data/generated/google/apis/testing_v1.rb +1 -1
- data/generated/google/apis/testing_v1/classes.rb +3 -2
- data/generated/google/apis/toolresults_v1beta3.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +141 -2
- data/generated/google/apis/toolresults_v1beta3/representations.rb +77 -0
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/lib/google/apis/version.rb +1 -1
- metadata +3 -3
@@ -22,8 +22,7 @@ module Google
|
|
22
22
|
module GmailV1
|
23
23
|
# Gmail API
|
24
24
|
#
|
25
|
-
#
|
26
|
-
# threads, messages, and labels.
|
25
|
+
# Access Gmail mailboxes including sending user email.
|
27
26
|
#
|
28
27
|
# @example
|
29
28
|
# require 'google/apis/gmail_v1'
|
@@ -39,24 +38,30 @@ module Google
|
|
39
38
|
attr_accessor :key
|
40
39
|
|
41
40
|
# @return [String]
|
42
|
-
#
|
43
|
-
#
|
41
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
42
|
+
# characters.
|
44
43
|
attr_accessor :quota_user
|
45
44
|
|
45
|
+
# @return [String]
|
46
|
+
# Deprecated. Please use quotaUser instead.
|
47
|
+
attr_accessor :user_ip
|
48
|
+
|
46
49
|
def initialize
|
47
|
-
super('https://www.googleapis.com/', '')
|
48
|
-
@batch_path = 'batch'
|
50
|
+
super('https://www.googleapis.com/', 'gmail/v1/users/')
|
51
|
+
@batch_path = 'batch/gmail/v1'
|
49
52
|
end
|
50
53
|
|
51
54
|
# Gets the current user's Gmail profile.
|
52
55
|
# @param [String] user_id
|
53
|
-
# The user's email address. The special value
|
54
|
-
#
|
56
|
+
# The user's email address. The special value me can be used to indicate the
|
57
|
+
# authenticated user.
|
55
58
|
# @param [String] fields
|
56
59
|
# Selector specifying which fields to include in a partial response.
|
57
60
|
# @param [String] quota_user
|
58
|
-
#
|
59
|
-
#
|
61
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
62
|
+
# characters.
|
63
|
+
# @param [String] user_ip
|
64
|
+
# Deprecated. Please use quotaUser instead.
|
60
65
|
# @param [Google::Apis::RequestOptions] options
|
61
66
|
# Request-specific options
|
62
67
|
#
|
@@ -69,25 +74,28 @@ module Google
|
|
69
74
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
70
75
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
71
76
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
72
|
-
def get_user_profile(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
73
|
-
command = make_simple_command(:get, '
|
77
|
+
def get_user_profile(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
78
|
+
command = make_simple_command(:get, '{userId}/profile', options)
|
74
79
|
command.response_representation = Google::Apis::GmailV1::Profile::Representation
|
75
80
|
command.response_class = Google::Apis::GmailV1::Profile
|
76
81
|
command.params['userId'] = user_id unless user_id.nil?
|
77
82
|
command.query['fields'] = fields unless fields.nil?
|
78
83
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
84
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
79
85
|
execute_or_queue_command(command, &block)
|
80
86
|
end
|
81
87
|
|
82
88
|
# Stop receiving push notifications for the given user mailbox.
|
83
89
|
# @param [String] user_id
|
84
|
-
# The user's email address. The special value
|
85
|
-
#
|
90
|
+
# The user's email address. The special value me can be used to indicate the
|
91
|
+
# authenticated user.
|
86
92
|
# @param [String] fields
|
87
93
|
# Selector specifying which fields to include in a partial response.
|
88
94
|
# @param [String] quota_user
|
89
|
-
#
|
90
|
-
#
|
95
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
96
|
+
# characters.
|
97
|
+
# @param [String] user_ip
|
98
|
+
# Deprecated. Please use quotaUser instead.
|
91
99
|
# @param [Google::Apis::RequestOptions] options
|
92
100
|
# Request-specific options
|
93
101
|
#
|
@@ -100,24 +108,27 @@ module Google
|
|
100
108
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
101
109
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
102
110
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
103
|
-
def stop_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
104
|
-
command = make_simple_command(:post, '
|
111
|
+
def stop_user(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
112
|
+
command = make_simple_command(:post, '{userId}/stop', options)
|
105
113
|
command.params['userId'] = user_id unless user_id.nil?
|
106
114
|
command.query['fields'] = fields unless fields.nil?
|
107
115
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
116
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
108
117
|
execute_or_queue_command(command, &block)
|
109
118
|
end
|
110
119
|
|
111
120
|
# Set up or update a push notification watch on the given user mailbox.
|
112
121
|
# @param [String] user_id
|
113
|
-
# The user's email address. The special value
|
114
|
-
#
|
122
|
+
# The user's email address. The special value me can be used to indicate the
|
123
|
+
# authenticated user.
|
115
124
|
# @param [Google::Apis::GmailV1::WatchRequest] watch_request_object
|
116
125
|
# @param [String] fields
|
117
126
|
# Selector specifying which fields to include in a partial response.
|
118
127
|
# @param [String] quota_user
|
119
|
-
#
|
120
|
-
#
|
128
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
129
|
+
# characters.
|
130
|
+
# @param [String] user_ip
|
131
|
+
# Deprecated. Please use quotaUser instead.
|
121
132
|
# @param [Google::Apis::RequestOptions] options
|
122
133
|
# Request-specific options
|
123
134
|
#
|
@@ -130,8 +141,8 @@ module Google
|
|
130
141
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
131
142
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
132
143
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
133
|
-
def watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
134
|
-
command = make_simple_command(:post, '
|
144
|
+
def watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
145
|
+
command = make_simple_command(:post, '{userId}/watch', options)
|
135
146
|
command.request_representation = Google::Apis::GmailV1::WatchRequest::Representation
|
136
147
|
command.request_object = watch_request_object
|
137
148
|
command.response_representation = Google::Apis::GmailV1::WatchResponse::Representation
|
@@ -139,19 +150,22 @@ module Google
|
|
139
150
|
command.params['userId'] = user_id unless user_id.nil?
|
140
151
|
command.query['fields'] = fields unless fields.nil?
|
141
152
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
153
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
142
154
|
execute_or_queue_command(command, &block)
|
143
155
|
end
|
144
156
|
|
145
|
-
# Creates a new draft with the
|
157
|
+
# Creates a new draft with the DRAFT label.
|
146
158
|
# @param [String] user_id
|
147
|
-
# The user's email address. The special value
|
148
|
-
#
|
159
|
+
# The user's email address. The special value me can be used to indicate the
|
160
|
+
# authenticated user.
|
149
161
|
# @param [Google::Apis::GmailV1::Draft] draft_object
|
150
162
|
# @param [String] fields
|
151
163
|
# Selector specifying which fields to include in a partial response.
|
152
164
|
# @param [String] quota_user
|
153
|
-
#
|
154
|
-
#
|
165
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
166
|
+
# characters.
|
167
|
+
# @param [String] user_ip
|
168
|
+
# Deprecated. Please use quotaUser instead.
|
155
169
|
# @param [IO, String] upload_source
|
156
170
|
# IO stream or filename containing content to upload
|
157
171
|
# @param [String] content_type
|
@@ -168,11 +182,11 @@ module Google
|
|
168
182
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
169
183
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
170
184
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
171
|
-
def create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
185
|
+
def create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
172
186
|
if upload_source.nil?
|
173
|
-
command = make_simple_command(:post, '
|
187
|
+
command = make_simple_command(:post, '{userId}/drafts', options)
|
174
188
|
else
|
175
|
-
command = make_upload_command(:post, '
|
189
|
+
command = make_upload_command(:post, '{userId}/drafts', options)
|
176
190
|
command.upload_source = upload_source
|
177
191
|
command.upload_content_type = content_type
|
178
192
|
end
|
@@ -183,21 +197,24 @@ module Google
|
|
183
197
|
command.params['userId'] = user_id unless user_id.nil?
|
184
198
|
command.query['fields'] = fields unless fields.nil?
|
185
199
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
200
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
186
201
|
execute_or_queue_command(command, &block)
|
187
202
|
end
|
188
203
|
|
189
|
-
# Immediately and permanently deletes the specified draft.
|
190
|
-
#
|
204
|
+
# Immediately and permanently deletes the specified draft. Does not simply trash
|
205
|
+
# it.
|
191
206
|
# @param [String] user_id
|
192
|
-
# The user's email address. The special value
|
193
|
-
#
|
207
|
+
# The user's email address. The special value me can be used to indicate the
|
208
|
+
# authenticated user.
|
194
209
|
# @param [String] id
|
195
210
|
# The ID of the draft to delete.
|
196
211
|
# @param [String] fields
|
197
212
|
# Selector specifying which fields to include in a partial response.
|
198
213
|
# @param [String] quota_user
|
199
|
-
#
|
200
|
-
#
|
214
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
215
|
+
# characters.
|
216
|
+
# @param [String] user_ip
|
217
|
+
# Deprecated. Please use quotaUser instead.
|
201
218
|
# @param [Google::Apis::RequestOptions] options
|
202
219
|
# Request-specific options
|
203
220
|
#
|
@@ -210,19 +227,20 @@ module Google
|
|
210
227
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
211
228
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
212
229
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
213
|
-
def delete_user_draft(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
214
|
-
command = make_simple_command(:delete, '
|
230
|
+
def delete_user_draft(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
231
|
+
command = make_simple_command(:delete, '{userId}/drafts/{id}', options)
|
215
232
|
command.params['userId'] = user_id unless user_id.nil?
|
216
233
|
command.params['id'] = id unless id.nil?
|
217
234
|
command.query['fields'] = fields unless fields.nil?
|
218
235
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
236
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
219
237
|
execute_or_queue_command(command, &block)
|
220
238
|
end
|
221
239
|
|
222
240
|
# Gets the specified draft.
|
223
241
|
# @param [String] user_id
|
224
|
-
# The user's email address. The special value
|
225
|
-
#
|
242
|
+
# The user's email address. The special value me can be used to indicate the
|
243
|
+
# authenticated user.
|
226
244
|
# @param [String] id
|
227
245
|
# The ID of the draft to retrieve.
|
228
246
|
# @param [String] format
|
@@ -230,8 +248,10 @@ module Google
|
|
230
248
|
# @param [String] fields
|
231
249
|
# Selector specifying which fields to include in a partial response.
|
232
250
|
# @param [String] quota_user
|
233
|
-
#
|
234
|
-
#
|
251
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
252
|
+
# characters.
|
253
|
+
# @param [String] user_ip
|
254
|
+
# Deprecated. Please use quotaUser instead.
|
235
255
|
# @param [Google::Apis::RequestOptions] options
|
236
256
|
# Request-specific options
|
237
257
|
#
|
@@ -244,8 +264,8 @@ module Google
|
|
244
264
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
245
265
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
246
266
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
247
|
-
def get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, options: nil, &block)
|
248
|
-
command = make_simple_command(:get, '
|
267
|
+
def get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
268
|
+
command = make_simple_command(:get, '{userId}/drafts/{id}', options)
|
249
269
|
command.response_representation = Google::Apis::GmailV1::Draft::Representation
|
250
270
|
command.response_class = Google::Apis::GmailV1::Draft
|
251
271
|
command.params['userId'] = user_id unless user_id.nil?
|
@@ -253,30 +273,31 @@ module Google
|
|
253
273
|
command.query['format'] = format unless format.nil?
|
254
274
|
command.query['fields'] = fields unless fields.nil?
|
255
275
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
276
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
256
277
|
execute_or_queue_command(command, &block)
|
257
278
|
end
|
258
279
|
|
259
280
|
# Lists the drafts in the user's mailbox.
|
260
281
|
# @param [String] user_id
|
261
|
-
# The user's email address. The special value
|
262
|
-
#
|
282
|
+
# The user's email address. The special value me can be used to indicate the
|
283
|
+
# authenticated user.
|
263
284
|
# @param [Boolean] include_spam_trash
|
264
|
-
# Include drafts from
|
265
|
-
# in the results.
|
285
|
+
# Include drafts from SPAM and TRASH in the results.
|
266
286
|
# @param [Fixnum] max_results
|
267
287
|
# Maximum number of drafts to return.
|
268
288
|
# @param [String] page_token
|
269
289
|
# Page token to retrieve a specific page of results in the list.
|
270
290
|
# @param [String] q
|
271
291
|
# Only return draft messages matching the specified query. Supports the same
|
272
|
-
# query format as the Gmail search box. For example,
|
273
|
-
#
|
274
|
-
# is:unread"</code>.
|
292
|
+
# query format as the Gmail search box. For example, "from:someuser@example.com
|
293
|
+
# rfc822msgid: is:unread".
|
275
294
|
# @param [String] fields
|
276
295
|
# Selector specifying which fields to include in a partial response.
|
277
296
|
# @param [String] quota_user
|
278
|
-
#
|
279
|
-
#
|
297
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
298
|
+
# characters.
|
299
|
+
# @param [String] user_ip
|
300
|
+
# Deprecated. Please use quotaUser instead.
|
280
301
|
# @param [Google::Apis::RequestOptions] options
|
281
302
|
# Request-specific options
|
282
303
|
#
|
@@ -289,8 +310,8 @@ module Google
|
|
289
310
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
290
311
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
291
312
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
292
|
-
def list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
|
293
|
-
command = make_simple_command(:get, '
|
313
|
+
def list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
314
|
+
command = make_simple_command(:get, '{userId}/drafts', options)
|
294
315
|
command.response_representation = Google::Apis::GmailV1::ListDraftsResponse::Representation
|
295
316
|
command.response_class = Google::Apis::GmailV1::ListDraftsResponse
|
296
317
|
command.params['userId'] = user_id unless user_id.nil?
|
@@ -300,20 +321,23 @@ module Google
|
|
300
321
|
command.query['q'] = q unless q.nil?
|
301
322
|
command.query['fields'] = fields unless fields.nil?
|
302
323
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
324
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
303
325
|
execute_or_queue_command(command, &block)
|
304
326
|
end
|
305
327
|
|
306
|
-
# Sends the specified, existing draft to the recipients in the
|
307
|
-
#
|
328
|
+
# Sends the specified, existing draft to the recipients in the To, Cc, and Bcc
|
329
|
+
# headers.
|
308
330
|
# @param [String] user_id
|
309
|
-
# The user's email address. The special value
|
310
|
-
#
|
331
|
+
# The user's email address. The special value me can be used to indicate the
|
332
|
+
# authenticated user.
|
311
333
|
# @param [Google::Apis::GmailV1::Draft] draft_object
|
312
334
|
# @param [String] fields
|
313
335
|
# Selector specifying which fields to include in a partial response.
|
314
336
|
# @param [String] quota_user
|
315
|
-
#
|
316
|
-
#
|
337
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
338
|
+
# characters.
|
339
|
+
# @param [String] user_ip
|
340
|
+
# Deprecated. Please use quotaUser instead.
|
317
341
|
# @param [IO, String] upload_source
|
318
342
|
# IO stream or filename containing content to upload
|
319
343
|
# @param [String] content_type
|
@@ -330,11 +354,11 @@ module Google
|
|
330
354
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
331
355
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
332
356
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
333
|
-
def send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
357
|
+
def send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
334
358
|
if upload_source.nil?
|
335
|
-
command = make_simple_command(:post, '
|
359
|
+
command = make_simple_command(:post, '{userId}/drafts/send', options)
|
336
360
|
else
|
337
|
-
command = make_upload_command(:post, '
|
361
|
+
command = make_upload_command(:post, '{userId}/drafts/send', options)
|
338
362
|
command.upload_source = upload_source
|
339
363
|
command.upload_content_type = content_type
|
340
364
|
end
|
@@ -345,21 +369,24 @@ module Google
|
|
345
369
|
command.params['userId'] = user_id unless user_id.nil?
|
346
370
|
command.query['fields'] = fields unless fields.nil?
|
347
371
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
372
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
348
373
|
execute_or_queue_command(command, &block)
|
349
374
|
end
|
350
375
|
|
351
376
|
# Replaces a draft's content.
|
352
377
|
# @param [String] user_id
|
353
|
-
# The user's email address. The special value
|
354
|
-
#
|
378
|
+
# The user's email address. The special value me can be used to indicate the
|
379
|
+
# authenticated user.
|
355
380
|
# @param [String] id
|
356
381
|
# The ID of the draft to update.
|
357
382
|
# @param [Google::Apis::GmailV1::Draft] draft_object
|
358
383
|
# @param [String] fields
|
359
384
|
# Selector specifying which fields to include in a partial response.
|
360
385
|
# @param [String] quota_user
|
361
|
-
#
|
362
|
-
#
|
386
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
387
|
+
# characters.
|
388
|
+
# @param [String] user_ip
|
389
|
+
# Deprecated. Please use quotaUser instead.
|
363
390
|
# @param [IO, String] upload_source
|
364
391
|
# IO stream or filename containing content to upload
|
365
392
|
# @param [String] content_type
|
@@ -376,11 +403,11 @@ module Google
|
|
376
403
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
377
404
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
378
405
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
379
|
-
def update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
406
|
+
def update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
380
407
|
if upload_source.nil?
|
381
|
-
command = make_simple_command(:put, '
|
408
|
+
command = make_simple_command(:put, '{userId}/drafts/{id}', options)
|
382
409
|
else
|
383
|
-
command = make_upload_command(:put, '
|
410
|
+
command = make_upload_command(:put, '{userId}/drafts/{id}', options)
|
384
411
|
command.upload_source = upload_source
|
385
412
|
command.upload_content_type = content_type
|
386
413
|
end
|
@@ -392,14 +419,15 @@ module Google
|
|
392
419
|
command.params['id'] = id unless id.nil?
|
393
420
|
command.query['fields'] = fields unless fields.nil?
|
394
421
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
422
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
395
423
|
execute_or_queue_command(command, &block)
|
396
424
|
end
|
397
425
|
|
398
426
|
# Lists the history of all changes to the given mailbox. History results are
|
399
|
-
# returned in chronological order (increasing
|
427
|
+
# returned in chronological order (increasing historyId).
|
400
428
|
# @param [String] user_id
|
401
|
-
# The user's email address. The special value
|
402
|
-
#
|
429
|
+
# The user's email address. The special value me can be used to indicate the
|
430
|
+
# authenticated user.
|
403
431
|
# @param [Array<String>, String] history_types
|
404
432
|
# History types to be returned by the function
|
405
433
|
# @param [String] label_id
|
@@ -409,24 +437,23 @@ module Google
|
|
409
437
|
# @param [String] page_token
|
410
438
|
# Page token to retrieve a specific page of results in the list.
|
411
439
|
# @param [Fixnum] start_history_id
|
412
|
-
# Required. Returns history records after the specified
|
413
|
-
#
|
414
|
-
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
422
|
-
# full sync. If you receive no <code>nextPageToken</code> in the response,
|
423
|
-
# there are no updates to retrieve and you can store the returned
|
424
|
-
# <code>historyId</code> for a future request.
|
440
|
+
# Required. Returns history records after the specified startHistoryId. The
|
441
|
+
# supplied startHistoryId should be obtained from the historyId of a message,
|
442
|
+
# thread, or previous list response. History IDs increase chronologically but
|
443
|
+
# are not contiguous with random gaps in between valid IDs. Supplying an invalid
|
444
|
+
# or out of date startHistoryId typically returns an HTTP 404 error code. A
|
445
|
+
# historyId is typically valid for at least a week, but in some rare
|
446
|
+
# circumstances may be valid for only a few hours. If you receive an HTTP 404
|
447
|
+
# error response, your application should perform a full sync. If you receive no
|
448
|
+
# nextPageToken in the response, there are no updates to retrieve and you can
|
449
|
+
# store the returned historyId for a future request.
|
425
450
|
# @param [String] fields
|
426
451
|
# Selector specifying which fields to include in a partial response.
|
427
452
|
# @param [String] quota_user
|
428
|
-
#
|
429
|
-
#
|
453
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
454
|
+
# characters.
|
455
|
+
# @param [String] user_ip
|
456
|
+
# Deprecated. Please use quotaUser instead.
|
430
457
|
# @param [Google::Apis::RequestOptions] options
|
431
458
|
# Request-specific options
|
432
459
|
#
|
@@ -439,8 +466,8 @@ module Google
|
|
439
466
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
440
467
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
441
468
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
442
|
-
def list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
443
|
-
command = make_simple_command(:get, '
|
469
|
+
def list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
470
|
+
command = make_simple_command(:get, '{userId}/history', options)
|
444
471
|
command.response_representation = Google::Apis::GmailV1::ListHistoryResponse::Representation
|
445
472
|
command.response_class = Google::Apis::GmailV1::ListHistoryResponse
|
446
473
|
command.params['userId'] = user_id unless user_id.nil?
|
@@ -451,19 +478,22 @@ module Google
|
|
451
478
|
command.query['startHistoryId'] = start_history_id unless start_history_id.nil?
|
452
479
|
command.query['fields'] = fields unless fields.nil?
|
453
480
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
481
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
454
482
|
execute_or_queue_command(command, &block)
|
455
483
|
end
|
456
484
|
|
457
485
|
# Creates a new label.
|
458
486
|
# @param [String] user_id
|
459
|
-
# The user's email address. The special value
|
460
|
-
#
|
487
|
+
# The user's email address. The special value me can be used to indicate the
|
488
|
+
# authenticated user.
|
461
489
|
# @param [Google::Apis::GmailV1::Label] label_object
|
462
490
|
# @param [String] fields
|
463
491
|
# Selector specifying which fields to include in a partial response.
|
464
492
|
# @param [String] quota_user
|
465
|
-
#
|
466
|
-
#
|
493
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
494
|
+
# characters.
|
495
|
+
# @param [String] user_ip
|
496
|
+
# Deprecated. Please use quotaUser instead.
|
467
497
|
# @param [Google::Apis::RequestOptions] options
|
468
498
|
# Request-specific options
|
469
499
|
#
|
@@ -476,8 +506,8 @@ module Google
|
|
476
506
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
477
507
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
478
508
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
479
|
-
def create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
480
|
-
command = make_simple_command(:post, '
|
509
|
+
def create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
510
|
+
command = make_simple_command(:post, '{userId}/labels', options)
|
481
511
|
command.request_representation = Google::Apis::GmailV1::Label::Representation
|
482
512
|
command.request_object = label_object
|
483
513
|
command.response_representation = Google::Apis::GmailV1::Label::Representation
|
@@ -485,21 +515,24 @@ module Google
|
|
485
515
|
command.params['userId'] = user_id unless user_id.nil?
|
486
516
|
command.query['fields'] = fields unless fields.nil?
|
487
517
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
518
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
488
519
|
execute_or_queue_command(command, &block)
|
489
520
|
end
|
490
521
|
|
491
522
|
# Immediately and permanently deletes the specified label and removes it from
|
492
523
|
# any messages and threads that it is applied to.
|
493
524
|
# @param [String] user_id
|
494
|
-
# The user's email address. The special value
|
495
|
-
#
|
525
|
+
# The user's email address. The special value me can be used to indicate the
|
526
|
+
# authenticated user.
|
496
527
|
# @param [String] id
|
497
528
|
# The ID of the label to delete.
|
498
529
|
# @param [String] fields
|
499
530
|
# Selector specifying which fields to include in a partial response.
|
500
531
|
# @param [String] quota_user
|
501
|
-
#
|
502
|
-
#
|
532
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
533
|
+
# characters.
|
534
|
+
# @param [String] user_ip
|
535
|
+
# Deprecated. Please use quotaUser instead.
|
503
536
|
# @param [Google::Apis::RequestOptions] options
|
504
537
|
# Request-specific options
|
505
538
|
#
|
@@ -512,26 +545,29 @@ module Google
|
|
512
545
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
513
546
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
514
547
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
515
|
-
def delete_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
516
|
-
command = make_simple_command(:delete, '
|
548
|
+
def delete_user_label(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
549
|
+
command = make_simple_command(:delete, '{userId}/labels/{id}', options)
|
517
550
|
command.params['userId'] = user_id unless user_id.nil?
|
518
551
|
command.params['id'] = id unless id.nil?
|
519
552
|
command.query['fields'] = fields unless fields.nil?
|
520
553
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
554
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
521
555
|
execute_or_queue_command(command, &block)
|
522
556
|
end
|
523
557
|
|
524
558
|
# Gets the specified label.
|
525
559
|
# @param [String] user_id
|
526
|
-
# The user's email address. The special value
|
527
|
-
#
|
560
|
+
# The user's email address. The special value me can be used to indicate the
|
561
|
+
# authenticated user.
|
528
562
|
# @param [String] id
|
529
563
|
# The ID of the label to retrieve.
|
530
564
|
# @param [String] fields
|
531
565
|
# Selector specifying which fields to include in a partial response.
|
532
566
|
# @param [String] quota_user
|
533
|
-
#
|
534
|
-
#
|
567
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
568
|
+
# characters.
|
569
|
+
# @param [String] user_ip
|
570
|
+
# Deprecated. Please use quotaUser instead.
|
535
571
|
# @param [Google::Apis::RequestOptions] options
|
536
572
|
# Request-specific options
|
537
573
|
#
|
@@ -544,26 +580,29 @@ module Google
|
|
544
580
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
545
581
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
546
582
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
547
|
-
def get_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
548
|
-
command = make_simple_command(:get, '
|
583
|
+
def get_user_label(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
584
|
+
command = make_simple_command(:get, '{userId}/labels/{id}', options)
|
549
585
|
command.response_representation = Google::Apis::GmailV1::Label::Representation
|
550
586
|
command.response_class = Google::Apis::GmailV1::Label
|
551
587
|
command.params['userId'] = user_id unless user_id.nil?
|
552
588
|
command.params['id'] = id unless id.nil?
|
553
589
|
command.query['fields'] = fields unless fields.nil?
|
554
590
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
591
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
555
592
|
execute_or_queue_command(command, &block)
|
556
593
|
end
|
557
594
|
|
558
595
|
# Lists all labels in the user's mailbox.
|
559
596
|
# @param [String] user_id
|
560
|
-
# The user's email address. The special value
|
561
|
-
#
|
597
|
+
# The user's email address. The special value me can be used to indicate the
|
598
|
+
# authenticated user.
|
562
599
|
# @param [String] fields
|
563
600
|
# Selector specifying which fields to include in a partial response.
|
564
601
|
# @param [String] quota_user
|
565
|
-
#
|
566
|
-
#
|
602
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
603
|
+
# characters.
|
604
|
+
# @param [String] user_ip
|
605
|
+
# Deprecated. Please use quotaUser instead.
|
567
606
|
# @param [Google::Apis::RequestOptions] options
|
568
607
|
# Request-specific options
|
569
608
|
#
|
@@ -576,28 +615,31 @@ module Google
|
|
576
615
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
577
616
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
578
617
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
579
|
-
def list_user_labels(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
580
|
-
command = make_simple_command(:get, '
|
618
|
+
def list_user_labels(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
619
|
+
command = make_simple_command(:get, '{userId}/labels', options)
|
581
620
|
command.response_representation = Google::Apis::GmailV1::ListLabelsResponse::Representation
|
582
621
|
command.response_class = Google::Apis::GmailV1::ListLabelsResponse
|
583
622
|
command.params['userId'] = user_id unless user_id.nil?
|
584
623
|
command.query['fields'] = fields unless fields.nil?
|
585
624
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
625
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
586
626
|
execute_or_queue_command(command, &block)
|
587
627
|
end
|
588
628
|
|
589
|
-
#
|
629
|
+
# Updates the specified label. This method supports patch semantics.
|
590
630
|
# @param [String] user_id
|
591
|
-
# The user's email address. The special value
|
592
|
-
#
|
631
|
+
# The user's email address. The special value me can be used to indicate the
|
632
|
+
# authenticated user.
|
593
633
|
# @param [String] id
|
594
634
|
# The ID of the label to update.
|
595
635
|
# @param [Google::Apis::GmailV1::Label] label_object
|
596
636
|
# @param [String] fields
|
597
637
|
# Selector specifying which fields to include in a partial response.
|
598
638
|
# @param [String] quota_user
|
599
|
-
#
|
600
|
-
#
|
639
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
640
|
+
# characters.
|
641
|
+
# @param [String] user_ip
|
642
|
+
# Deprecated. Please use quotaUser instead.
|
601
643
|
# @param [Google::Apis::RequestOptions] options
|
602
644
|
# Request-specific options
|
603
645
|
#
|
@@ -610,8 +652,8 @@ module Google
|
|
610
652
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
611
653
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
612
654
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
613
|
-
def patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
614
|
-
command = make_simple_command(:patch, '
|
655
|
+
def patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
656
|
+
command = make_simple_command(:patch, '{userId}/labels/{id}', options)
|
615
657
|
command.request_representation = Google::Apis::GmailV1::Label::Representation
|
616
658
|
command.request_object = label_object
|
617
659
|
command.response_representation = Google::Apis::GmailV1::Label::Representation
|
@@ -620,21 +662,24 @@ module Google
|
|
620
662
|
command.params['id'] = id unless id.nil?
|
621
663
|
command.query['fields'] = fields unless fields.nil?
|
622
664
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
665
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
623
666
|
execute_or_queue_command(command, &block)
|
624
667
|
end
|
625
668
|
|
626
669
|
# Updates the specified label.
|
627
670
|
# @param [String] user_id
|
628
|
-
# The user's email address. The special value
|
629
|
-
#
|
671
|
+
# The user's email address. The special value me can be used to indicate the
|
672
|
+
# authenticated user.
|
630
673
|
# @param [String] id
|
631
674
|
# The ID of the label to update.
|
632
675
|
# @param [Google::Apis::GmailV1::Label] label_object
|
633
676
|
# @param [String] fields
|
634
677
|
# Selector specifying which fields to include in a partial response.
|
635
678
|
# @param [String] quota_user
|
636
|
-
#
|
637
|
-
#
|
679
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
680
|
+
# characters.
|
681
|
+
# @param [String] user_ip
|
682
|
+
# Deprecated. Please use quotaUser instead.
|
638
683
|
# @param [Google::Apis::RequestOptions] options
|
639
684
|
# Request-specific options
|
640
685
|
#
|
@@ -647,8 +692,8 @@ module Google
|
|
647
692
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
648
693
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
649
694
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
650
|
-
def update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
651
|
-
command = make_simple_command(:put, '
|
695
|
+
def update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
696
|
+
command = make_simple_command(:put, '{userId}/labels/{id}', options)
|
652
697
|
command.request_representation = Google::Apis::GmailV1::Label::Representation
|
653
698
|
command.request_object = label_object
|
654
699
|
command.response_representation = Google::Apis::GmailV1::Label::Representation
|
@@ -657,20 +702,23 @@ module Google
|
|
657
702
|
command.params['id'] = id unless id.nil?
|
658
703
|
command.query['fields'] = fields unless fields.nil?
|
659
704
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
705
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
660
706
|
execute_or_queue_command(command, &block)
|
661
707
|
end
|
662
708
|
|
663
|
-
# Deletes many messages by message ID.
|
664
|
-
#
|
709
|
+
# Deletes many messages by message ID. Provides no guarantees that messages were
|
710
|
+
# not already deleted or even existed at all.
|
665
711
|
# @param [String] user_id
|
666
|
-
# The user's email address. The special value
|
667
|
-
#
|
712
|
+
# The user's email address. The special value me can be used to indicate the
|
713
|
+
# authenticated user.
|
668
714
|
# @param [Google::Apis::GmailV1::BatchDeleteMessagesRequest] batch_delete_messages_request_object
|
669
715
|
# @param [String] fields
|
670
716
|
# Selector specifying which fields to include in a partial response.
|
671
717
|
# @param [String] quota_user
|
672
|
-
#
|
673
|
-
#
|
718
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
719
|
+
# characters.
|
720
|
+
# @param [String] user_ip
|
721
|
+
# Deprecated. Please use quotaUser instead.
|
674
722
|
# @param [Google::Apis::RequestOptions] options
|
675
723
|
# Request-specific options
|
676
724
|
#
|
@@ -683,26 +731,29 @@ module Google
|
|
683
731
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
684
732
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
685
733
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
686
|
-
def batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
687
|
-
command = make_simple_command(:post, '
|
734
|
+
def batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
735
|
+
command = make_simple_command(:post, '{userId}/messages/batchDelete', options)
|
688
736
|
command.request_representation = Google::Apis::GmailV1::BatchDeleteMessagesRequest::Representation
|
689
737
|
command.request_object = batch_delete_messages_request_object
|
690
738
|
command.params['userId'] = user_id unless user_id.nil?
|
691
739
|
command.query['fields'] = fields unless fields.nil?
|
692
740
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
741
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
693
742
|
execute_or_queue_command(command, &block)
|
694
743
|
end
|
695
744
|
|
696
745
|
# Modifies the labels on the specified messages.
|
697
746
|
# @param [String] user_id
|
698
|
-
# The user's email address. The special value
|
699
|
-
#
|
747
|
+
# The user's email address. The special value me can be used to indicate the
|
748
|
+
# authenticated user.
|
700
749
|
# @param [Google::Apis::GmailV1::BatchModifyMessagesRequest] batch_modify_messages_request_object
|
701
750
|
# @param [String] fields
|
702
751
|
# Selector specifying which fields to include in a partial response.
|
703
752
|
# @param [String] quota_user
|
704
|
-
#
|
705
|
-
#
|
753
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
754
|
+
# characters.
|
755
|
+
# @param [String] user_ip
|
756
|
+
# Deprecated. Please use quotaUser instead.
|
706
757
|
# @param [Google::Apis::RequestOptions] options
|
707
758
|
# Request-specific options
|
708
759
|
#
|
@@ -715,28 +766,31 @@ module Google
|
|
715
766
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
716
767
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
717
768
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
718
|
-
def batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
719
|
-
command = make_simple_command(:post, '
|
769
|
+
def batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
770
|
+
command = make_simple_command(:post, '{userId}/messages/batchModify', options)
|
720
771
|
command.request_representation = Google::Apis::GmailV1::BatchModifyMessagesRequest::Representation
|
721
772
|
command.request_object = batch_modify_messages_request_object
|
722
773
|
command.params['userId'] = user_id unless user_id.nil?
|
723
774
|
command.query['fields'] = fields unless fields.nil?
|
724
775
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
776
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
725
777
|
execute_or_queue_command(command, &block)
|
726
778
|
end
|
727
779
|
|
728
780
|
# Immediately and permanently deletes the specified message. This operation
|
729
|
-
# cannot be undone.
|
781
|
+
# cannot be undone. Prefer messages.trash instead.
|
730
782
|
# @param [String] user_id
|
731
|
-
# The user's email address. The special value
|
732
|
-
#
|
783
|
+
# The user's email address. The special value me can be used to indicate the
|
784
|
+
# authenticated user.
|
733
785
|
# @param [String] id
|
734
786
|
# The ID of the message to delete.
|
735
787
|
# @param [String] fields
|
736
788
|
# Selector specifying which fields to include in a partial response.
|
737
789
|
# @param [String] quota_user
|
738
|
-
#
|
739
|
-
#
|
790
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
791
|
+
# characters.
|
792
|
+
# @param [String] user_ip
|
793
|
+
# Deprecated. Please use quotaUser instead.
|
740
794
|
# @param [Google::Apis::RequestOptions] options
|
741
795
|
# Request-specific options
|
742
796
|
#
|
@@ -749,19 +803,20 @@ module Google
|
|
749
803
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
750
804
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
751
805
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
752
|
-
def delete_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
753
|
-
command = make_simple_command(:delete, '
|
806
|
+
def delete_user_message(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
807
|
+
command = make_simple_command(:delete, '{userId}/messages/{id}', options)
|
754
808
|
command.params['userId'] = user_id unless user_id.nil?
|
755
809
|
command.params['id'] = id unless id.nil?
|
756
810
|
command.query['fields'] = fields unless fields.nil?
|
757
811
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
812
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
758
813
|
execute_or_queue_command(command, &block)
|
759
814
|
end
|
760
815
|
|
761
816
|
# Gets the specified message.
|
762
817
|
# @param [String] user_id
|
763
|
-
# The user's email address. The special value
|
764
|
-
#
|
818
|
+
# The user's email address. The special value me can be used to indicate the
|
819
|
+
# authenticated user.
|
765
820
|
# @param [String] id
|
766
821
|
# The ID of the message to retrieve.
|
767
822
|
# @param [String] format
|
@@ -771,8 +826,10 @@ module Google
|
|
771
826
|
# @param [String] fields
|
772
827
|
# Selector specifying which fields to include in a partial response.
|
773
828
|
# @param [String] quota_user
|
774
|
-
#
|
775
|
-
#
|
829
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
830
|
+
# characters.
|
831
|
+
# @param [String] user_ip
|
832
|
+
# Deprecated. Please use quotaUser instead.
|
776
833
|
# @param [Google::Apis::RequestOptions] options
|
777
834
|
# Request-specific options
|
778
835
|
#
|
@@ -785,8 +842,8 @@ module Google
|
|
785
842
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
786
843
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
787
844
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
788
|
-
def get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil, &block)
|
789
|
-
command = make_simple_command(:get, '
|
845
|
+
def get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
846
|
+
command = make_simple_command(:get, '{userId}/messages/{id}', options)
|
790
847
|
command.response_representation = Google::Apis::GmailV1::Message::Representation
|
791
848
|
command.response_class = Google::Apis::GmailV1::Message
|
792
849
|
command.params['userId'] = user_id unless user_id.nil?
|
@@ -795,34 +852,35 @@ module Google
|
|
795
852
|
command.query['metadataHeaders'] = metadata_headers unless metadata_headers.nil?
|
796
853
|
command.query['fields'] = fields unless fields.nil?
|
797
854
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
855
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
798
856
|
execute_or_queue_command(command, &block)
|
799
857
|
end
|
800
858
|
|
801
|
-
# Imports a message into only this user's mailbox, with standard
|
802
|
-
#
|
803
|
-
#
|
859
|
+
# Imports a message into only this user's mailbox, with standard email delivery
|
860
|
+
# scanning and classification similar to receiving via SMTP. Does not send a
|
861
|
+
# message.
|
804
862
|
# @param [String] user_id
|
805
|
-
# The user's email address. The special value
|
806
|
-
#
|
863
|
+
# The user's email address. The special value me can be used to indicate the
|
864
|
+
# authenticated user.
|
807
865
|
# @param [Google::Apis::GmailV1::Message] message_object
|
808
866
|
# @param [Boolean] deleted
|
809
|
-
# Mark the email as permanently deleted (not TRASH) and
|
810
|
-
#
|
811
|
-
# <a href="http://support.google.com/vault/">Google Vault</a> to
|
812
|
-
# a Vault administrator. Only used for G Suite accounts.
|
867
|
+
# Mark the email as permanently deleted (not TRASH) and only visible in Google
|
868
|
+
# Vault to a Vault administrator. Only used for G Suite accounts.
|
813
869
|
# @param [String] internal_date_source
|
814
870
|
# Source for Gmail's internal date of the message.
|
815
871
|
# @param [Boolean] never_mark_spam
|
816
|
-
# Ignore the Gmail spam classifier decision and never mark
|
817
|
-
#
|
872
|
+
# Ignore the Gmail spam classifier decision and never mark this email as SPAM in
|
873
|
+
# the mailbox.
|
818
874
|
# @param [Boolean] process_for_calendar
|
819
|
-
# Process calendar invites in the email and add any extracted
|
820
|
-
#
|
875
|
+
# Process calendar invites in the email and add any extracted meetings to the
|
876
|
+
# Google Calendar for this user.
|
821
877
|
# @param [String] fields
|
822
878
|
# Selector specifying which fields to include in a partial response.
|
823
879
|
# @param [String] quota_user
|
824
|
-
#
|
825
|
-
#
|
880
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
881
|
+
# characters.
|
882
|
+
# @param [String] user_ip
|
883
|
+
# Deprecated. Please use quotaUser instead.
|
826
884
|
# @param [IO, String] upload_source
|
827
885
|
# IO stream or filename containing content to upload
|
828
886
|
# @param [String] content_type
|
@@ -839,11 +897,11 @@ module Google
|
|
839
897
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
840
898
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
841
899
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
842
|
-
def import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
900
|
+
def import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
843
901
|
if upload_source.nil?
|
844
|
-
command = make_simple_command(:post, '
|
902
|
+
command = make_simple_command(:post, '{userId}/messages/import', options)
|
845
903
|
else
|
846
|
-
command = make_upload_command(:post, '
|
904
|
+
command = make_upload_command(:post, '{userId}/messages/import', options)
|
847
905
|
command.upload_source = upload_source
|
848
906
|
command.upload_content_type = content_type
|
849
907
|
end
|
@@ -858,28 +916,28 @@ module Google
|
|
858
916
|
command.query['processForCalendar'] = process_for_calendar unless process_for_calendar.nil?
|
859
917
|
command.query['fields'] = fields unless fields.nil?
|
860
918
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
919
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
861
920
|
execute_or_queue_command(command, &block)
|
862
921
|
end
|
863
922
|
|
864
|
-
# Directly inserts a message into only this user's mailbox similar to
|
865
|
-
#
|
866
|
-
# Does not send a message.
|
923
|
+
# Directly inserts a message into only this user's mailbox similar to IMAP
|
924
|
+
# APPEND, bypassing most scanning and classification. Does not send a message.
|
867
925
|
# @param [String] user_id
|
868
|
-
# The user's email address. The special value
|
869
|
-
#
|
926
|
+
# The user's email address. The special value me can be used to indicate the
|
927
|
+
# authenticated user.
|
870
928
|
# @param [Google::Apis::GmailV1::Message] message_object
|
871
929
|
# @param [Boolean] deleted
|
872
|
-
# Mark the email as permanently deleted (not TRASH) and
|
873
|
-
#
|
874
|
-
# <a href="http://support.google.com/vault/">Google Vault</a> to
|
875
|
-
# a Vault administrator. Only used for G Suite accounts.
|
930
|
+
# Mark the email as permanently deleted (not TRASH) and only visible in Google
|
931
|
+
# Vault to a Vault administrator. Only used for G Suite accounts.
|
876
932
|
# @param [String] internal_date_source
|
877
933
|
# Source for Gmail's internal date of the message.
|
878
934
|
# @param [String] fields
|
879
935
|
# Selector specifying which fields to include in a partial response.
|
880
936
|
# @param [String] quota_user
|
881
|
-
#
|
882
|
-
#
|
937
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
938
|
+
# characters.
|
939
|
+
# @param [String] user_ip
|
940
|
+
# Deprecated. Please use quotaUser instead.
|
883
941
|
# @param [IO, String] upload_source
|
884
942
|
# IO stream or filename containing content to upload
|
885
943
|
# @param [String] content_type
|
@@ -896,11 +954,11 @@ module Google
|
|
896
954
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
897
955
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
898
956
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
899
|
-
def insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
957
|
+
def insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
900
958
|
if upload_source.nil?
|
901
|
-
command = make_simple_command(:post, '
|
959
|
+
command = make_simple_command(:post, '{userId}/messages', options)
|
902
960
|
else
|
903
|
-
command = make_upload_command(:post, '
|
961
|
+
command = make_upload_command(:post, '{userId}/messages', options)
|
904
962
|
command.upload_source = upload_source
|
905
963
|
command.upload_content_type = content_type
|
906
964
|
end
|
@@ -913,16 +971,16 @@ module Google
|
|
913
971
|
command.query['internalDateSource'] = internal_date_source unless internal_date_source.nil?
|
914
972
|
command.query['fields'] = fields unless fields.nil?
|
915
973
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
974
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
916
975
|
execute_or_queue_command(command, &block)
|
917
976
|
end
|
918
977
|
|
919
978
|
# Lists the messages in the user's mailbox.
|
920
979
|
# @param [String] user_id
|
921
|
-
# The user's email address. The special value
|
922
|
-
#
|
980
|
+
# The user's email address. The special value me can be used to indicate the
|
981
|
+
# authenticated user.
|
923
982
|
# @param [Boolean] include_spam_trash
|
924
|
-
# Include messages from
|
925
|
-
# in the results.
|
983
|
+
# Include messages from SPAM and TRASH in the results.
|
926
984
|
# @param [Array<String>, String] label_ids
|
927
985
|
# Only return messages with labels that match all of the specified label IDs.
|
928
986
|
# @param [Fixnum] max_results
|
@@ -930,16 +988,17 @@ module Google
|
|
930
988
|
# @param [String] page_token
|
931
989
|
# Page token to retrieve a specific page of results in the list.
|
932
990
|
# @param [String] q
|
933
|
-
# Only return messages matching the specified query. Supports the same
|
934
|
-
#
|
935
|
-
#
|
936
|
-
#
|
937
|
-
# using the gmail.metadata scope.
|
991
|
+
# Only return messages matching the specified query. Supports the same query
|
992
|
+
# format as the Gmail search box. For example, "from:someuser@example.com
|
993
|
+
# rfc822msgid:<somemsgid@example.com> is:unread". Parameter cannot be used when
|
994
|
+
# accessing the api using the gmail.metadata scope.
|
938
995
|
# @param [String] fields
|
939
996
|
# Selector specifying which fields to include in a partial response.
|
940
997
|
# @param [String] quota_user
|
941
|
-
#
|
942
|
-
#
|
998
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
999
|
+
# characters.
|
1000
|
+
# @param [String] user_ip
|
1001
|
+
# Deprecated. Please use quotaUser instead.
|
943
1002
|
# @param [Google::Apis::RequestOptions] options
|
944
1003
|
# Request-specific options
|
945
1004
|
#
|
@@ -952,8 +1011,8 @@ module Google
|
|
952
1011
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
953
1012
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
954
1013
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
955
|
-
def list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
|
956
|
-
command = make_simple_command(:get, '
|
1014
|
+
def list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1015
|
+
command = make_simple_command(:get, '{userId}/messages', options)
|
957
1016
|
command.response_representation = Google::Apis::GmailV1::ListMessagesResponse::Representation
|
958
1017
|
command.response_class = Google::Apis::GmailV1::ListMessagesResponse
|
959
1018
|
command.params['userId'] = user_id unless user_id.nil?
|
@@ -964,21 +1023,24 @@ module Google
|
|
964
1023
|
command.query['q'] = q unless q.nil?
|
965
1024
|
command.query['fields'] = fields unless fields.nil?
|
966
1025
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1026
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
967
1027
|
execute_or_queue_command(command, &block)
|
968
1028
|
end
|
969
1029
|
|
970
1030
|
# Modifies the labels on the specified message.
|
971
1031
|
# @param [String] user_id
|
972
|
-
# The user's email address. The special value
|
973
|
-
#
|
1032
|
+
# The user's email address. The special value me can be used to indicate the
|
1033
|
+
# authenticated user.
|
974
1034
|
# @param [String] id
|
975
1035
|
# The ID of the message to modify.
|
976
1036
|
# @param [Google::Apis::GmailV1::ModifyMessageRequest] modify_message_request_object
|
977
1037
|
# @param [String] fields
|
978
1038
|
# Selector specifying which fields to include in a partial response.
|
979
1039
|
# @param [String] quota_user
|
980
|
-
#
|
981
|
-
#
|
1040
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1041
|
+
# characters.
|
1042
|
+
# @param [String] user_ip
|
1043
|
+
# Deprecated. Please use quotaUser instead.
|
982
1044
|
# @param [Google::Apis::RequestOptions] options
|
983
1045
|
# Request-specific options
|
984
1046
|
#
|
@@ -991,8 +1053,8 @@ module Google
|
|
991
1053
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
992
1054
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
993
1055
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
994
|
-
def modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
995
|
-
command = make_simple_command(:post, '
|
1056
|
+
def modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1057
|
+
command = make_simple_command(:post, '{userId}/messages/{id}/modify', options)
|
996
1058
|
command.request_representation = Google::Apis::GmailV1::ModifyMessageRequest::Representation
|
997
1059
|
command.request_object = modify_message_request_object
|
998
1060
|
command.response_representation = Google::Apis::GmailV1::Message::Representation
|
@@ -1001,20 +1063,22 @@ module Google
|
|
1001
1063
|
command.params['id'] = id unless id.nil?
|
1002
1064
|
command.query['fields'] = fields unless fields.nil?
|
1003
1065
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1066
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1004
1067
|
execute_or_queue_command(command, &block)
|
1005
1068
|
end
|
1006
1069
|
|
1007
|
-
# Sends the specified message to the recipients in the
|
1008
|
-
# <code>To</code>, <code>Cc</code>, and <code>Bcc</code> headers.
|
1070
|
+
# Sends the specified message to the recipients in the To, Cc, and Bcc headers.
|
1009
1071
|
# @param [String] user_id
|
1010
|
-
# The user's email address. The special value
|
1011
|
-
#
|
1072
|
+
# The user's email address. The special value me can be used to indicate the
|
1073
|
+
# authenticated user.
|
1012
1074
|
# @param [Google::Apis::GmailV1::Message] message_object
|
1013
1075
|
# @param [String] fields
|
1014
1076
|
# Selector specifying which fields to include in a partial response.
|
1015
1077
|
# @param [String] quota_user
|
1016
|
-
#
|
1017
|
-
#
|
1078
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1079
|
+
# characters.
|
1080
|
+
# @param [String] user_ip
|
1081
|
+
# Deprecated. Please use quotaUser instead.
|
1018
1082
|
# @param [IO, String] upload_source
|
1019
1083
|
# IO stream or filename containing content to upload
|
1020
1084
|
# @param [String] content_type
|
@@ -1031,11 +1095,11 @@ module Google
|
|
1031
1095
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1032
1096
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1033
1097
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1034
|
-
def send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
1098
|
+
def send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
1035
1099
|
if upload_source.nil?
|
1036
|
-
command = make_simple_command(:post, '
|
1100
|
+
command = make_simple_command(:post, '{userId}/messages/send', options)
|
1037
1101
|
else
|
1038
|
-
command = make_upload_command(:post, '
|
1102
|
+
command = make_upload_command(:post, '{userId}/messages/send', options)
|
1039
1103
|
command.upload_source = upload_source
|
1040
1104
|
command.upload_content_type = content_type
|
1041
1105
|
end
|
@@ -1046,20 +1110,23 @@ module Google
|
|
1046
1110
|
command.params['userId'] = user_id unless user_id.nil?
|
1047
1111
|
command.query['fields'] = fields unless fields.nil?
|
1048
1112
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1113
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1049
1114
|
execute_or_queue_command(command, &block)
|
1050
1115
|
end
|
1051
1116
|
|
1052
1117
|
# Moves the specified message to the trash.
|
1053
1118
|
# @param [String] user_id
|
1054
|
-
# The user's email address. The special value
|
1055
|
-
#
|
1119
|
+
# The user's email address. The special value me can be used to indicate the
|
1120
|
+
# authenticated user.
|
1056
1121
|
# @param [String] id
|
1057
1122
|
# The ID of the message to Trash.
|
1058
1123
|
# @param [String] fields
|
1059
1124
|
# Selector specifying which fields to include in a partial response.
|
1060
1125
|
# @param [String] quota_user
|
1061
|
-
#
|
1062
|
-
#
|
1126
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1127
|
+
# characters.
|
1128
|
+
# @param [String] user_ip
|
1129
|
+
# Deprecated. Please use quotaUser instead.
|
1063
1130
|
# @param [Google::Apis::RequestOptions] options
|
1064
1131
|
# Request-specific options
|
1065
1132
|
#
|
@@ -1072,28 +1139,31 @@ module Google
|
|
1072
1139
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1073
1140
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1074
1141
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1075
|
-
def trash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
1076
|
-
command = make_simple_command(:post, '
|
1142
|
+
def trash_user_message(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1143
|
+
command = make_simple_command(:post, '{userId}/messages/{id}/trash', options)
|
1077
1144
|
command.response_representation = Google::Apis::GmailV1::Message::Representation
|
1078
1145
|
command.response_class = Google::Apis::GmailV1::Message
|
1079
1146
|
command.params['userId'] = user_id unless user_id.nil?
|
1080
1147
|
command.params['id'] = id unless id.nil?
|
1081
1148
|
command.query['fields'] = fields unless fields.nil?
|
1082
1149
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1150
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1083
1151
|
execute_or_queue_command(command, &block)
|
1084
1152
|
end
|
1085
1153
|
|
1086
1154
|
# Removes the specified message from the trash.
|
1087
1155
|
# @param [String] user_id
|
1088
|
-
# The user's email address. The special value
|
1089
|
-
#
|
1156
|
+
# The user's email address. The special value me can be used to indicate the
|
1157
|
+
# authenticated user.
|
1090
1158
|
# @param [String] id
|
1091
1159
|
# The ID of the message to remove from Trash.
|
1092
1160
|
# @param [String] fields
|
1093
1161
|
# Selector specifying which fields to include in a partial response.
|
1094
1162
|
# @param [String] quota_user
|
1095
|
-
#
|
1096
|
-
#
|
1163
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1164
|
+
# characters.
|
1165
|
+
# @param [String] user_ip
|
1166
|
+
# Deprecated. Please use quotaUser instead.
|
1097
1167
|
# @param [Google::Apis::RequestOptions] options
|
1098
1168
|
# Request-specific options
|
1099
1169
|
#
|
@@ -1106,21 +1176,22 @@ module Google
|
|
1106
1176
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1107
1177
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1108
1178
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1109
|
-
def untrash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
1110
|
-
command = make_simple_command(:post, '
|
1179
|
+
def untrash_user_message(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1180
|
+
command = make_simple_command(:post, '{userId}/messages/{id}/untrash', options)
|
1111
1181
|
command.response_representation = Google::Apis::GmailV1::Message::Representation
|
1112
1182
|
command.response_class = Google::Apis::GmailV1::Message
|
1113
1183
|
command.params['userId'] = user_id unless user_id.nil?
|
1114
1184
|
command.params['id'] = id unless id.nil?
|
1115
1185
|
command.query['fields'] = fields unless fields.nil?
|
1116
1186
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1187
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1117
1188
|
execute_or_queue_command(command, &block)
|
1118
1189
|
end
|
1119
1190
|
|
1120
1191
|
# Gets the specified message attachment.
|
1121
1192
|
# @param [String] user_id
|
1122
|
-
# The user's email address. The special value
|
1123
|
-
#
|
1193
|
+
# The user's email address. The special value me can be used to indicate the
|
1194
|
+
# authenticated user.
|
1124
1195
|
# @param [String] message_id
|
1125
1196
|
# The ID of the message containing the attachment.
|
1126
1197
|
# @param [String] id
|
@@ -1128,8 +1199,10 @@ module Google
|
|
1128
1199
|
# @param [String] fields
|
1129
1200
|
# Selector specifying which fields to include in a partial response.
|
1130
1201
|
# @param [String] quota_user
|
1131
|
-
#
|
1132
|
-
#
|
1202
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1203
|
+
# characters.
|
1204
|
+
# @param [String] user_ip
|
1205
|
+
# Deprecated. Please use quotaUser instead.
|
1133
1206
|
# @param [Google::Apis::RequestOptions] options
|
1134
1207
|
# Request-specific options
|
1135
1208
|
#
|
@@ -1142,8 +1215,8 @@ module Google
|
|
1142
1215
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1143
1216
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1144
1217
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1145
|
-
def get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
1146
|
-
command = make_simple_command(:get, '
|
1218
|
+
def get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1219
|
+
command = make_simple_command(:get, '{userId}/messages/{messageId}/attachments/{id}', options)
|
1147
1220
|
command.response_representation = Google::Apis::GmailV1::MessagePartBody::Representation
|
1148
1221
|
command.response_class = Google::Apis::GmailV1::MessagePartBody
|
1149
1222
|
command.params['userId'] = user_id unless user_id.nil?
|
@@ -1151,18 +1224,21 @@ module Google
|
|
1151
1224
|
command.params['id'] = id unless id.nil?
|
1152
1225
|
command.query['fields'] = fields unless fields.nil?
|
1153
1226
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1227
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1154
1228
|
execute_or_queue_command(command, &block)
|
1155
1229
|
end
|
1156
1230
|
|
1157
1231
|
# Gets the auto-forwarding setting for the specified account.
|
1158
1232
|
# @param [String] user_id
|
1159
|
-
# User's email address.
|
1160
|
-
#
|
1233
|
+
# User's email address. The special value "me" can be used to indicate the
|
1234
|
+
# authenticated user.
|
1161
1235
|
# @param [String] fields
|
1162
1236
|
# Selector specifying which fields to include in a partial response.
|
1163
1237
|
# @param [String] quota_user
|
1164
|
-
#
|
1165
|
-
#
|
1238
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1239
|
+
# characters.
|
1240
|
+
# @param [String] user_ip
|
1241
|
+
# Deprecated. Please use quotaUser instead.
|
1166
1242
|
# @param [Google::Apis::RequestOptions] options
|
1167
1243
|
# Request-specific options
|
1168
1244
|
#
|
@@ -1175,25 +1251,28 @@ module Google
|
|
1175
1251
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1176
1252
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1177
1253
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1178
|
-
def get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
1179
|
-
command = make_simple_command(:get, '
|
1254
|
+
def get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1255
|
+
command = make_simple_command(:get, '{userId}/settings/autoForwarding', options)
|
1180
1256
|
command.response_representation = Google::Apis::GmailV1::AutoForwarding::Representation
|
1181
1257
|
command.response_class = Google::Apis::GmailV1::AutoForwarding
|
1182
1258
|
command.params['userId'] = user_id unless user_id.nil?
|
1183
1259
|
command.query['fields'] = fields unless fields.nil?
|
1184
1260
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1261
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1185
1262
|
execute_or_queue_command(command, &block)
|
1186
1263
|
end
|
1187
1264
|
|
1188
1265
|
# Gets IMAP settings.
|
1189
1266
|
# @param [String] user_id
|
1190
|
-
# User's email address.
|
1191
|
-
#
|
1267
|
+
# User's email address. The special value "me" can be used to indicate the
|
1268
|
+
# authenticated user.
|
1192
1269
|
# @param [String] fields
|
1193
1270
|
# Selector specifying which fields to include in a partial response.
|
1194
1271
|
# @param [String] quota_user
|
1195
|
-
#
|
1196
|
-
#
|
1272
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1273
|
+
# characters.
|
1274
|
+
# @param [String] user_ip
|
1275
|
+
# Deprecated. Please use quotaUser instead.
|
1197
1276
|
# @param [Google::Apis::RequestOptions] options
|
1198
1277
|
# Request-specific options
|
1199
1278
|
#
|
@@ -1206,25 +1285,28 @@ module Google
|
|
1206
1285
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1207
1286
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1208
1287
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1209
|
-
def get_user_setting_imap(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
1210
|
-
command = make_simple_command(:get, '
|
1288
|
+
def get_user_setting_imap(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1289
|
+
command = make_simple_command(:get, '{userId}/settings/imap', options)
|
1211
1290
|
command.response_representation = Google::Apis::GmailV1::ImapSettings::Representation
|
1212
1291
|
command.response_class = Google::Apis::GmailV1::ImapSettings
|
1213
1292
|
command.params['userId'] = user_id unless user_id.nil?
|
1214
1293
|
command.query['fields'] = fields unless fields.nil?
|
1215
1294
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1295
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1216
1296
|
execute_or_queue_command(command, &block)
|
1217
1297
|
end
|
1218
1298
|
|
1219
1299
|
# Gets language settings.
|
1220
1300
|
# @param [String] user_id
|
1221
|
-
# User's email address.
|
1222
|
-
#
|
1301
|
+
# User's email address. The special value "me" can be used to indicate the
|
1302
|
+
# authenticated user.
|
1223
1303
|
# @param [String] fields
|
1224
1304
|
# Selector specifying which fields to include in a partial response.
|
1225
1305
|
# @param [String] quota_user
|
1226
|
-
#
|
1227
|
-
#
|
1306
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1307
|
+
# characters.
|
1308
|
+
# @param [String] user_ip
|
1309
|
+
# Deprecated. Please use quotaUser instead.
|
1228
1310
|
# @param [Google::Apis::RequestOptions] options
|
1229
1311
|
# Request-specific options
|
1230
1312
|
#
|
@@ -1237,25 +1319,28 @@ module Google
|
|
1237
1319
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1238
1320
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1239
1321
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1240
|
-
def get_user_setting_language(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
1241
|
-
command = make_simple_command(:get, '
|
1322
|
+
def get_user_setting_language(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1323
|
+
command = make_simple_command(:get, '{userId}/settings/language', options)
|
1242
1324
|
command.response_representation = Google::Apis::GmailV1::LanguageSettings::Representation
|
1243
1325
|
command.response_class = Google::Apis::GmailV1::LanguageSettings
|
1244
1326
|
command.params['userId'] = user_id unless user_id.nil?
|
1245
1327
|
command.query['fields'] = fields unless fields.nil?
|
1246
1328
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1329
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1247
1330
|
execute_or_queue_command(command, &block)
|
1248
1331
|
end
|
1249
1332
|
|
1250
1333
|
# Gets POP settings.
|
1251
1334
|
# @param [String] user_id
|
1252
|
-
# User's email address.
|
1253
|
-
#
|
1335
|
+
# User's email address. The special value "me" can be used to indicate the
|
1336
|
+
# authenticated user.
|
1254
1337
|
# @param [String] fields
|
1255
1338
|
# Selector specifying which fields to include in a partial response.
|
1256
1339
|
# @param [String] quota_user
|
1257
|
-
#
|
1258
|
-
#
|
1340
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1341
|
+
# characters.
|
1342
|
+
# @param [String] user_ip
|
1343
|
+
# Deprecated. Please use quotaUser instead.
|
1259
1344
|
# @param [Google::Apis::RequestOptions] options
|
1260
1345
|
# Request-specific options
|
1261
1346
|
#
|
@@ -1268,25 +1353,28 @@ module Google
|
|
1268
1353
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1269
1354
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1270
1355
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1271
|
-
def get_user_setting_pop(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
1272
|
-
command = make_simple_command(:get, '
|
1356
|
+
def get_user_setting_pop(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1357
|
+
command = make_simple_command(:get, '{userId}/settings/pop', options)
|
1273
1358
|
command.response_representation = Google::Apis::GmailV1::PopSettings::Representation
|
1274
1359
|
command.response_class = Google::Apis::GmailV1::PopSettings
|
1275
1360
|
command.params['userId'] = user_id unless user_id.nil?
|
1276
1361
|
command.query['fields'] = fields unless fields.nil?
|
1277
1362
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1363
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1278
1364
|
execute_or_queue_command(command, &block)
|
1279
1365
|
end
|
1280
1366
|
|
1281
1367
|
# Gets vacation responder settings.
|
1282
1368
|
# @param [String] user_id
|
1283
|
-
# User's email address.
|
1284
|
-
#
|
1369
|
+
# User's email address. The special value "me" can be used to indicate the
|
1370
|
+
# authenticated user.
|
1285
1371
|
# @param [String] fields
|
1286
1372
|
# Selector specifying which fields to include in a partial response.
|
1287
1373
|
# @param [String] quota_user
|
1288
|
-
#
|
1289
|
-
#
|
1374
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1375
|
+
# characters.
|
1376
|
+
# @param [String] user_ip
|
1377
|
+
# Deprecated. Please use quotaUser instead.
|
1290
1378
|
# @param [Google::Apis::RequestOptions] options
|
1291
1379
|
# Request-specific options
|
1292
1380
|
#
|
@@ -1299,29 +1387,32 @@ module Google
|
|
1299
1387
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1300
1388
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1301
1389
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1302
|
-
def get_user_setting_vacation(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
1303
|
-
command = make_simple_command(:get, '
|
1390
|
+
def get_user_setting_vacation(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1391
|
+
command = make_simple_command(:get, '{userId}/settings/vacation', options)
|
1304
1392
|
command.response_representation = Google::Apis::GmailV1::VacationSettings::Representation
|
1305
1393
|
command.response_class = Google::Apis::GmailV1::VacationSettings
|
1306
1394
|
command.params['userId'] = user_id unless user_id.nil?
|
1307
1395
|
command.query['fields'] = fields unless fields.nil?
|
1308
1396
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1397
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1309
1398
|
execute_or_queue_command(command, &block)
|
1310
1399
|
end
|
1311
1400
|
|
1312
|
-
# Updates the auto-forwarding setting for the specified account.
|
1401
|
+
# Updates the auto-forwarding setting for the specified account. A verified
|
1313
1402
|
# forwarding address must be specified when auto-forwarding is enabled.
|
1314
1403
|
# This method is only available to service account clients that have been
|
1315
1404
|
# delegated domain-wide authority.
|
1316
1405
|
# @param [String] user_id
|
1317
|
-
# User's email address.
|
1318
|
-
#
|
1406
|
+
# User's email address. The special value "me" can be used to indicate the
|
1407
|
+
# authenticated user.
|
1319
1408
|
# @param [Google::Apis::GmailV1::AutoForwarding] auto_forwarding_object
|
1320
1409
|
# @param [String] fields
|
1321
1410
|
# Selector specifying which fields to include in a partial response.
|
1322
1411
|
# @param [String] quota_user
|
1323
|
-
#
|
1324
|
-
#
|
1412
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1413
|
+
# characters.
|
1414
|
+
# @param [String] user_ip
|
1415
|
+
# Deprecated. Please use quotaUser instead.
|
1325
1416
|
# @param [Google::Apis::RequestOptions] options
|
1326
1417
|
# Request-specific options
|
1327
1418
|
#
|
@@ -1334,8 +1425,8 @@ module Google
|
|
1334
1425
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1335
1426
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1336
1427
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1337
|
-
def update_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1338
|
-
command = make_simple_command(:put, '
|
1428
|
+
def update_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1429
|
+
command = make_simple_command(:put, '{userId}/settings/autoForwarding', options)
|
1339
1430
|
command.request_representation = Google::Apis::GmailV1::AutoForwarding::Representation
|
1340
1431
|
command.request_object = auto_forwarding_object
|
1341
1432
|
command.response_representation = Google::Apis::GmailV1::AutoForwarding::Representation
|
@@ -1343,19 +1434,22 @@ module Google
|
|
1343
1434
|
command.params['userId'] = user_id unless user_id.nil?
|
1344
1435
|
command.query['fields'] = fields unless fields.nil?
|
1345
1436
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1437
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1346
1438
|
execute_or_queue_command(command, &block)
|
1347
1439
|
end
|
1348
1440
|
|
1349
1441
|
# Updates IMAP settings.
|
1350
1442
|
# @param [String] user_id
|
1351
|
-
# User's email address.
|
1352
|
-
#
|
1443
|
+
# User's email address. The special value "me" can be used to indicate the
|
1444
|
+
# authenticated user.
|
1353
1445
|
# @param [Google::Apis::GmailV1::ImapSettings] imap_settings_object
|
1354
1446
|
# @param [String] fields
|
1355
1447
|
# Selector specifying which fields to include in a partial response.
|
1356
1448
|
# @param [String] quota_user
|
1357
|
-
#
|
1358
|
-
#
|
1449
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1450
|
+
# characters.
|
1451
|
+
# @param [String] user_ip
|
1452
|
+
# Deprecated. Please use quotaUser instead.
|
1359
1453
|
# @param [Google::Apis::RequestOptions] options
|
1360
1454
|
# Request-specific options
|
1361
1455
|
#
|
@@ -1368,8 +1462,8 @@ module Google
|
|
1368
1462
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1369
1463
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1370
1464
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1371
|
-
def update_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1372
|
-
command = make_simple_command(:put, '
|
1465
|
+
def update_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1466
|
+
command = make_simple_command(:put, '{userId}/settings/imap', options)
|
1373
1467
|
command.request_representation = Google::Apis::GmailV1::ImapSettings::Representation
|
1374
1468
|
command.request_object = imap_settings_object
|
1375
1469
|
command.response_representation = Google::Apis::GmailV1::ImapSettings::Representation
|
@@ -1377,24 +1471,27 @@ module Google
|
|
1377
1471
|
command.params['userId'] = user_id unless user_id.nil?
|
1378
1472
|
command.query['fields'] = fields unless fields.nil?
|
1379
1473
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1474
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1380
1475
|
execute_or_queue_command(command, &block)
|
1381
1476
|
end
|
1382
1477
|
|
1383
1478
|
# Updates language settings.
|
1384
|
-
# If successful, the return object contains the
|
1385
|
-
#
|
1386
|
-
# the
|
1387
|
-
#
|
1388
|
-
#
|
1389
|
-
# @param [String] user_id
|
1390
|
-
# User's email address.
|
1391
|
-
#
|
1479
|
+
# If successful, the return object contains the displayLanguage that was saved
|
1480
|
+
# for the user, which may differ from the value passed into the request. This is
|
1481
|
+
# because the requested displayLanguage may not be directly supported by Gmail
|
1482
|
+
# but have a close variant that is, and so the variant may be chosen and saved
|
1483
|
+
# instead.
|
1484
|
+
# @param [String] user_id
|
1485
|
+
# User's email address. The special value "me" can be used to indicate the
|
1486
|
+
# authenticated user.
|
1392
1487
|
# @param [Google::Apis::GmailV1::LanguageSettings] language_settings_object
|
1393
1488
|
# @param [String] fields
|
1394
1489
|
# Selector specifying which fields to include in a partial response.
|
1395
1490
|
# @param [String] quota_user
|
1396
|
-
#
|
1397
|
-
#
|
1491
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1492
|
+
# characters.
|
1493
|
+
# @param [String] user_ip
|
1494
|
+
# Deprecated. Please use quotaUser instead.
|
1398
1495
|
# @param [Google::Apis::RequestOptions] options
|
1399
1496
|
# Request-specific options
|
1400
1497
|
#
|
@@ -1407,8 +1504,8 @@ module Google
|
|
1407
1504
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1408
1505
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1409
1506
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1410
|
-
def update_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1411
|
-
command = make_simple_command(:put, '
|
1507
|
+
def update_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1508
|
+
command = make_simple_command(:put, '{userId}/settings/language', options)
|
1412
1509
|
command.request_representation = Google::Apis::GmailV1::LanguageSettings::Representation
|
1413
1510
|
command.request_object = language_settings_object
|
1414
1511
|
command.response_representation = Google::Apis::GmailV1::LanguageSettings::Representation
|
@@ -1416,19 +1513,22 @@ module Google
|
|
1416
1513
|
command.params['userId'] = user_id unless user_id.nil?
|
1417
1514
|
command.query['fields'] = fields unless fields.nil?
|
1418
1515
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1516
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1419
1517
|
execute_or_queue_command(command, &block)
|
1420
1518
|
end
|
1421
1519
|
|
1422
1520
|
# Updates POP settings.
|
1423
1521
|
# @param [String] user_id
|
1424
|
-
# User's email address.
|
1425
|
-
#
|
1522
|
+
# User's email address. The special value "me" can be used to indicate the
|
1523
|
+
# authenticated user.
|
1426
1524
|
# @param [Google::Apis::GmailV1::PopSettings] pop_settings_object
|
1427
1525
|
# @param [String] fields
|
1428
1526
|
# Selector specifying which fields to include in a partial response.
|
1429
1527
|
# @param [String] quota_user
|
1430
|
-
#
|
1431
|
-
#
|
1528
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1529
|
+
# characters.
|
1530
|
+
# @param [String] user_ip
|
1531
|
+
# Deprecated. Please use quotaUser instead.
|
1432
1532
|
# @param [Google::Apis::RequestOptions] options
|
1433
1533
|
# Request-specific options
|
1434
1534
|
#
|
@@ -1441,8 +1541,8 @@ module Google
|
|
1441
1541
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1442
1542
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1443
1543
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1444
|
-
def update_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1445
|
-
command = make_simple_command(:put, '
|
1544
|
+
def update_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1545
|
+
command = make_simple_command(:put, '{userId}/settings/pop', options)
|
1446
1546
|
command.request_representation = Google::Apis::GmailV1::PopSettings::Representation
|
1447
1547
|
command.request_object = pop_settings_object
|
1448
1548
|
command.response_representation = Google::Apis::GmailV1::PopSettings::Representation
|
@@ -1450,19 +1550,22 @@ module Google
|
|
1450
1550
|
command.params['userId'] = user_id unless user_id.nil?
|
1451
1551
|
command.query['fields'] = fields unless fields.nil?
|
1452
1552
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1553
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1453
1554
|
execute_or_queue_command(command, &block)
|
1454
1555
|
end
|
1455
1556
|
|
1456
1557
|
# Updates vacation responder settings.
|
1457
1558
|
# @param [String] user_id
|
1458
|
-
# User's email address.
|
1459
|
-
#
|
1559
|
+
# User's email address. The special value "me" can be used to indicate the
|
1560
|
+
# authenticated user.
|
1460
1561
|
# @param [Google::Apis::GmailV1::VacationSettings] vacation_settings_object
|
1461
1562
|
# @param [String] fields
|
1462
1563
|
# Selector specifying which fields to include in a partial response.
|
1463
1564
|
# @param [String] quota_user
|
1464
|
-
#
|
1465
|
-
#
|
1565
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1566
|
+
# characters.
|
1567
|
+
# @param [String] user_ip
|
1568
|
+
# Deprecated. Please use quotaUser instead.
|
1466
1569
|
# @param [Google::Apis::RequestOptions] options
|
1467
1570
|
# Request-specific options
|
1468
1571
|
#
|
@@ -1475,8 +1578,8 @@ module Google
|
|
1475
1578
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1476
1579
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1477
1580
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1478
|
-
def update_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1479
|
-
command = make_simple_command(:put, '
|
1581
|
+
def update_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1582
|
+
command = make_simple_command(:put, '{userId}/settings/vacation', options)
|
1480
1583
|
command.request_representation = Google::Apis::GmailV1::VacationSettings::Representation
|
1481
1584
|
command.request_object = vacation_settings_object
|
1482
1585
|
command.response_representation = Google::Apis::GmailV1::VacationSettings::Representation
|
@@ -1484,32 +1587,33 @@ module Google
|
|
1484
1587
|
command.params['userId'] = user_id unless user_id.nil?
|
1485
1588
|
command.query['fields'] = fields unless fields.nil?
|
1486
1589
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1590
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1487
1591
|
execute_or_queue_command(command, &block)
|
1488
1592
|
end
|
1489
1593
|
|
1490
|
-
# Adds a delegate with its verification status set directly to
|
1491
|
-
#
|
1492
|
-
#
|
1493
|
-
#
|
1494
|
-
#
|
1495
|
-
#
|
1496
|
-
#
|
1497
|
-
#
|
1498
|
-
#
|
1499
|
-
#
|
1500
|
-
# Also note that when a new delegate is created, there may be up to a one
|
1501
|
-
# minute delay before the new delegate is available for use.
|
1594
|
+
# Adds a delegate with its verification status set directly to accepted, without
|
1595
|
+
# sending any verification email. The delegate user must be a member of the same
|
1596
|
+
# G Suite organization as the delegator user.
|
1597
|
+
# Gmail imposes limitations on the number of delegates and delegators each user
|
1598
|
+
# in a G Suite organization can have. These limits depend on your organization,
|
1599
|
+
# but in general each user can have up to 25 delegates and up to 10 delegators.
|
1600
|
+
# Note that a delegate user must be referred to by their primary email address,
|
1601
|
+
# and not an email alias.
|
1602
|
+
# Also note that when a new delegate is created, there may be up to a one minute
|
1603
|
+
# delay before the new delegate is available for use.
|
1502
1604
|
# This method is only available to service account clients that have been
|
1503
1605
|
# delegated domain-wide authority.
|
1504
1606
|
# @param [String] user_id
|
1505
|
-
# User's email address.
|
1506
|
-
#
|
1607
|
+
# User's email address. The special value "me" can be used to indicate the
|
1608
|
+
# authenticated user.
|
1507
1609
|
# @param [Google::Apis::GmailV1::Delegate] delegate_object
|
1508
1610
|
# @param [String] fields
|
1509
1611
|
# Selector specifying which fields to include in a partial response.
|
1510
1612
|
# @param [String] quota_user
|
1511
|
-
#
|
1512
|
-
#
|
1613
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1614
|
+
# characters.
|
1615
|
+
# @param [String] user_ip
|
1616
|
+
# Deprecated. Please use quotaUser instead.
|
1513
1617
|
# @param [Google::Apis::RequestOptions] options
|
1514
1618
|
# Request-specific options
|
1515
1619
|
#
|
@@ -1522,8 +1626,8 @@ module Google
|
|
1522
1626
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1523
1627
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1524
1628
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1525
|
-
def create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1526
|
-
command = make_simple_command(:post, '
|
1629
|
+
def create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1630
|
+
command = make_simple_command(:post, '{userId}/settings/delegates', options)
|
1527
1631
|
command.request_representation = Google::Apis::GmailV1::Delegate::Representation
|
1528
1632
|
command.request_object = delegate_object
|
1529
1633
|
command.response_representation = Google::Apis::GmailV1::Delegate::Representation
|
@@ -1531,25 +1635,28 @@ module Google
|
|
1531
1635
|
command.params['userId'] = user_id unless user_id.nil?
|
1532
1636
|
command.query['fields'] = fields unless fields.nil?
|
1533
1637
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1638
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1534
1639
|
execute_or_queue_command(command, &block)
|
1535
1640
|
end
|
1536
1641
|
|
1537
|
-
# Removes the specified delegate (which can be of any verification status),
|
1538
|
-
#
|
1539
|
-
# Note that a delegate user must be referred to by their primary email
|
1540
|
-
#
|
1642
|
+
# Removes the specified delegate (which can be of any verification status), and
|
1643
|
+
# revokes any verification that may have been required for using it.
|
1644
|
+
# Note that a delegate user must be referred to by their primary email address,
|
1645
|
+
# and not an email alias.
|
1541
1646
|
# This method is only available to service account clients that have been
|
1542
1647
|
# delegated domain-wide authority.
|
1543
1648
|
# @param [String] user_id
|
1544
|
-
# User's email address.
|
1545
|
-
#
|
1649
|
+
# User's email address. The special value "me" can be used to indicate the
|
1650
|
+
# authenticated user.
|
1546
1651
|
# @param [String] delegate_email
|
1547
1652
|
# The email address of the user to be removed as a delegate.
|
1548
1653
|
# @param [String] fields
|
1549
1654
|
# Selector specifying which fields to include in a partial response.
|
1550
1655
|
# @param [String] quota_user
|
1551
|
-
#
|
1552
|
-
#
|
1656
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1657
|
+
# characters.
|
1658
|
+
# @param [String] user_ip
|
1659
|
+
# Deprecated. Please use quotaUser instead.
|
1553
1660
|
# @param [Google::Apis::RequestOptions] options
|
1554
1661
|
# Request-specific options
|
1555
1662
|
#
|
@@ -1562,31 +1669,33 @@ module Google
|
|
1562
1669
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1563
1670
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1564
1671
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1565
|
-
def delete_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil, &block)
|
1566
|
-
command = make_simple_command(:delete, '
|
1672
|
+
def delete_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1673
|
+
command = make_simple_command(:delete, '{userId}/settings/delegates/{delegateEmail}', options)
|
1567
1674
|
command.params['userId'] = user_id unless user_id.nil?
|
1568
1675
|
command.params['delegateEmail'] = delegate_email unless delegate_email.nil?
|
1569
1676
|
command.query['fields'] = fields unless fields.nil?
|
1570
1677
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1678
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1571
1679
|
execute_or_queue_command(command, &block)
|
1572
1680
|
end
|
1573
1681
|
|
1574
1682
|
# Gets the specified delegate.
|
1575
|
-
# Note that a delegate user must be referred to by their primary email
|
1576
|
-
#
|
1683
|
+
# Note that a delegate user must be referred to by their primary email address,
|
1684
|
+
# and not an email alias.
|
1577
1685
|
# This method is only available to service account clients that have been
|
1578
1686
|
# delegated domain-wide authority.
|
1579
1687
|
# @param [String] user_id
|
1580
|
-
# User's email address.
|
1581
|
-
#
|
1688
|
+
# User's email address. The special value "me" can be used to indicate the
|
1689
|
+
# authenticated user.
|
1582
1690
|
# @param [String] delegate_email
|
1583
|
-
# The email address of the user whose delegate relationship is to be
|
1584
|
-
# retrieved.
|
1691
|
+
# The email address of the user whose delegate relationship is to be retrieved.
|
1585
1692
|
# @param [String] fields
|
1586
1693
|
# Selector specifying which fields to include in a partial response.
|
1587
1694
|
# @param [String] quota_user
|
1588
|
-
#
|
1589
|
-
#
|
1695
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1696
|
+
# characters.
|
1697
|
+
# @param [String] user_ip
|
1698
|
+
# Deprecated. Please use quotaUser instead.
|
1590
1699
|
# @param [Google::Apis::RequestOptions] options
|
1591
1700
|
# Request-specific options
|
1592
1701
|
#
|
@@ -1599,14 +1708,15 @@ module Google
|
|
1599
1708
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1600
1709
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1601
1710
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1602
|
-
def get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil, &block)
|
1603
|
-
command = make_simple_command(:get, '
|
1711
|
+
def get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1712
|
+
command = make_simple_command(:get, '{userId}/settings/delegates/{delegateEmail}', options)
|
1604
1713
|
command.response_representation = Google::Apis::GmailV1::Delegate::Representation
|
1605
1714
|
command.response_class = Google::Apis::GmailV1::Delegate
|
1606
1715
|
command.params['userId'] = user_id unless user_id.nil?
|
1607
1716
|
command.params['delegateEmail'] = delegate_email unless delegate_email.nil?
|
1608
1717
|
command.query['fields'] = fields unless fields.nil?
|
1609
1718
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1719
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1610
1720
|
execute_or_queue_command(command, &block)
|
1611
1721
|
end
|
1612
1722
|
|
@@ -1614,13 +1724,15 @@ module Google
|
|
1614
1724
|
# This method is only available to service account clients that have been
|
1615
1725
|
# delegated domain-wide authority.
|
1616
1726
|
# @param [String] user_id
|
1617
|
-
# User's email address.
|
1618
|
-
#
|
1727
|
+
# User's email address. The special value "me" can be used to indicate the
|
1728
|
+
# authenticated user.
|
1619
1729
|
# @param [String] fields
|
1620
1730
|
# Selector specifying which fields to include in a partial response.
|
1621
1731
|
# @param [String] quota_user
|
1622
|
-
#
|
1623
|
-
#
|
1732
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1733
|
+
# characters.
|
1734
|
+
# @param [String] user_ip
|
1735
|
+
# Deprecated. Please use quotaUser instead.
|
1624
1736
|
# @param [Google::Apis::RequestOptions] options
|
1625
1737
|
# Request-specific options
|
1626
1738
|
#
|
@@ -1633,26 +1745,29 @@ module Google
|
|
1633
1745
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1634
1746
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1635
1747
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1636
|
-
def list_user_setting_delegates(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
1637
|
-
command = make_simple_command(:get, '
|
1748
|
+
def list_user_setting_delegates(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1749
|
+
command = make_simple_command(:get, '{userId}/settings/delegates', options)
|
1638
1750
|
command.response_representation = Google::Apis::GmailV1::ListDelegatesResponse::Representation
|
1639
1751
|
command.response_class = Google::Apis::GmailV1::ListDelegatesResponse
|
1640
1752
|
command.params['userId'] = user_id unless user_id.nil?
|
1641
1753
|
command.query['fields'] = fields unless fields.nil?
|
1642
1754
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1755
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1643
1756
|
execute_or_queue_command(command, &block)
|
1644
1757
|
end
|
1645
1758
|
|
1646
1759
|
# Creates a filter.
|
1647
1760
|
# @param [String] user_id
|
1648
|
-
# User's email address. The special value "me"
|
1649
|
-
#
|
1761
|
+
# User's email address. The special value "me" can be used to indicate the
|
1762
|
+
# authenticated user.
|
1650
1763
|
# @param [Google::Apis::GmailV1::Filter] filter_object
|
1651
1764
|
# @param [String] fields
|
1652
1765
|
# Selector specifying which fields to include in a partial response.
|
1653
1766
|
# @param [String] quota_user
|
1654
|
-
#
|
1655
|
-
#
|
1767
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1768
|
+
# characters.
|
1769
|
+
# @param [String] user_ip
|
1770
|
+
# Deprecated. Please use quotaUser instead.
|
1656
1771
|
# @param [Google::Apis::RequestOptions] options
|
1657
1772
|
# Request-specific options
|
1658
1773
|
#
|
@@ -1665,8 +1780,8 @@ module Google
|
|
1665
1780
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1666
1781
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1667
1782
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1668
|
-
def create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1669
|
-
command = make_simple_command(:post, '
|
1783
|
+
def create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1784
|
+
command = make_simple_command(:post, '{userId}/settings/filters', options)
|
1670
1785
|
command.request_representation = Google::Apis::GmailV1::Filter::Representation
|
1671
1786
|
command.request_object = filter_object
|
1672
1787
|
command.response_representation = Google::Apis::GmailV1::Filter::Representation
|
@@ -1674,20 +1789,23 @@ module Google
|
|
1674
1789
|
command.params['userId'] = user_id unless user_id.nil?
|
1675
1790
|
command.query['fields'] = fields unless fields.nil?
|
1676
1791
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1792
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1677
1793
|
execute_or_queue_command(command, &block)
|
1678
1794
|
end
|
1679
1795
|
|
1680
1796
|
# Deletes a filter.
|
1681
1797
|
# @param [String] user_id
|
1682
|
-
# User's email address. The special value "me"
|
1683
|
-
#
|
1798
|
+
# User's email address. The special value "me" can be used to indicate the
|
1799
|
+
# authenticated user.
|
1684
1800
|
# @param [String] id
|
1685
1801
|
# The ID of the filter to be deleted.
|
1686
1802
|
# @param [String] fields
|
1687
1803
|
# Selector specifying which fields to include in a partial response.
|
1688
1804
|
# @param [String] quota_user
|
1689
|
-
#
|
1690
|
-
#
|
1805
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1806
|
+
# characters.
|
1807
|
+
# @param [String] user_ip
|
1808
|
+
# Deprecated. Please use quotaUser instead.
|
1691
1809
|
# @param [Google::Apis::RequestOptions] options
|
1692
1810
|
# Request-specific options
|
1693
1811
|
#
|
@@ -1700,26 +1818,29 @@ module Google
|
|
1700
1818
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1701
1819
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1702
1820
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1703
|
-
def delete_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
1704
|
-
command = make_simple_command(:delete, '
|
1821
|
+
def delete_user_setting_filter(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1822
|
+
command = make_simple_command(:delete, '{userId}/settings/filters/{id}', options)
|
1705
1823
|
command.params['userId'] = user_id unless user_id.nil?
|
1706
1824
|
command.params['id'] = id unless id.nil?
|
1707
1825
|
command.query['fields'] = fields unless fields.nil?
|
1708
1826
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1827
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1709
1828
|
execute_or_queue_command(command, &block)
|
1710
1829
|
end
|
1711
1830
|
|
1712
1831
|
# Gets a filter.
|
1713
1832
|
# @param [String] user_id
|
1714
|
-
# User's email address. The special value "me"
|
1715
|
-
#
|
1833
|
+
# User's email address. The special value "me" can be used to indicate the
|
1834
|
+
# authenticated user.
|
1716
1835
|
# @param [String] id
|
1717
1836
|
# The ID of the filter to be fetched.
|
1718
1837
|
# @param [String] fields
|
1719
1838
|
# Selector specifying which fields to include in a partial response.
|
1720
1839
|
# @param [String] quota_user
|
1721
|
-
#
|
1722
|
-
#
|
1840
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1841
|
+
# characters.
|
1842
|
+
# @param [String] user_ip
|
1843
|
+
# Deprecated. Please use quotaUser instead.
|
1723
1844
|
# @param [Google::Apis::RequestOptions] options
|
1724
1845
|
# Request-specific options
|
1725
1846
|
#
|
@@ -1732,26 +1853,29 @@ module Google
|
|
1732
1853
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1733
1854
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1734
1855
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1735
|
-
def get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
1736
|
-
command = make_simple_command(:get, '
|
1856
|
+
def get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1857
|
+
command = make_simple_command(:get, '{userId}/settings/filters/{id}', options)
|
1737
1858
|
command.response_representation = Google::Apis::GmailV1::Filter::Representation
|
1738
1859
|
command.response_class = Google::Apis::GmailV1::Filter
|
1739
1860
|
command.params['userId'] = user_id unless user_id.nil?
|
1740
1861
|
command.params['id'] = id unless id.nil?
|
1741
1862
|
command.query['fields'] = fields unless fields.nil?
|
1742
1863
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1864
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1743
1865
|
execute_or_queue_command(command, &block)
|
1744
1866
|
end
|
1745
1867
|
|
1746
1868
|
# Lists the message filters of a Gmail user.
|
1747
1869
|
# @param [String] user_id
|
1748
|
-
# User's email address. The special value "me"
|
1749
|
-
#
|
1870
|
+
# User's email address. The special value "me" can be used to indicate the
|
1871
|
+
# authenticated user.
|
1750
1872
|
# @param [String] fields
|
1751
1873
|
# Selector specifying which fields to include in a partial response.
|
1752
1874
|
# @param [String] quota_user
|
1753
|
-
#
|
1754
|
-
#
|
1875
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1876
|
+
# characters.
|
1877
|
+
# @param [String] user_ip
|
1878
|
+
# Deprecated. Please use quotaUser instead.
|
1755
1879
|
# @param [Google::Apis::RequestOptions] options
|
1756
1880
|
# Request-specific options
|
1757
1881
|
#
|
@@ -1764,31 +1888,34 @@ module Google
|
|
1764
1888
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1765
1889
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1766
1890
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1767
|
-
def list_user_setting_filters(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
1768
|
-
command = make_simple_command(:get, '
|
1891
|
+
def list_user_setting_filters(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1892
|
+
command = make_simple_command(:get, '{userId}/settings/filters', options)
|
1769
1893
|
command.response_representation = Google::Apis::GmailV1::ListFiltersResponse::Representation
|
1770
1894
|
command.response_class = Google::Apis::GmailV1::ListFiltersResponse
|
1771
1895
|
command.params['userId'] = user_id unless user_id.nil?
|
1772
1896
|
command.query['fields'] = fields unless fields.nil?
|
1773
1897
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1898
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1774
1899
|
execute_or_queue_command(command, &block)
|
1775
1900
|
end
|
1776
1901
|
|
1777
|
-
# Creates a forwarding address.
|
1778
|
-
#
|
1779
|
-
#
|
1780
|
-
#
|
1902
|
+
# Creates a forwarding address. If ownership verification is required, a message
|
1903
|
+
# will be sent to the recipient and the resource's verification status will be
|
1904
|
+
# set to pending; otherwise, the resource will be created with verification
|
1905
|
+
# status set to accepted.
|
1781
1906
|
# This method is only available to service account clients that have been
|
1782
1907
|
# delegated domain-wide authority.
|
1783
1908
|
# @param [String] user_id
|
1784
|
-
# User's email address.
|
1785
|
-
#
|
1909
|
+
# User's email address. The special value "me" can be used to indicate the
|
1910
|
+
# authenticated user.
|
1786
1911
|
# @param [Google::Apis::GmailV1::ForwardingAddress] forwarding_address_object
|
1787
1912
|
# @param [String] fields
|
1788
1913
|
# Selector specifying which fields to include in a partial response.
|
1789
1914
|
# @param [String] quota_user
|
1790
|
-
#
|
1791
|
-
#
|
1915
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1916
|
+
# characters.
|
1917
|
+
# @param [String] user_ip
|
1918
|
+
# Deprecated. Please use quotaUser instead.
|
1792
1919
|
# @param [Google::Apis::RequestOptions] options
|
1793
1920
|
# Request-specific options
|
1794
1921
|
#
|
@@ -1801,8 +1928,8 @@ module Google
|
|
1801
1928
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1802
1929
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1803
1930
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1804
|
-
def create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1805
|
-
command = make_simple_command(:post, '
|
1931
|
+
def create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1932
|
+
command = make_simple_command(:post, '{userId}/settings/forwardingAddresses', options)
|
1806
1933
|
command.request_representation = Google::Apis::GmailV1::ForwardingAddress::Representation
|
1807
1934
|
command.request_object = forwarding_address_object
|
1808
1935
|
command.response_representation = Google::Apis::GmailV1::ForwardingAddress::Representation
|
@@ -1810,23 +1937,26 @@ module Google
|
|
1810
1937
|
command.params['userId'] = user_id unless user_id.nil?
|
1811
1938
|
command.query['fields'] = fields unless fields.nil?
|
1812
1939
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1940
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1813
1941
|
execute_or_queue_command(command, &block)
|
1814
1942
|
end
|
1815
1943
|
|
1816
|
-
# Deletes the specified forwarding address and revokes any verification that
|
1817
|
-
#
|
1944
|
+
# Deletes the specified forwarding address and revokes any verification that may
|
1945
|
+
# have been required.
|
1818
1946
|
# This method is only available to service account clients that have been
|
1819
1947
|
# delegated domain-wide authority.
|
1820
1948
|
# @param [String] user_id
|
1821
|
-
# User's email address.
|
1822
|
-
#
|
1949
|
+
# User's email address. The special value "me" can be used to indicate the
|
1950
|
+
# authenticated user.
|
1823
1951
|
# @param [String] forwarding_email
|
1824
1952
|
# The forwarding address to be deleted.
|
1825
1953
|
# @param [String] fields
|
1826
1954
|
# Selector specifying which fields to include in a partial response.
|
1827
1955
|
# @param [String] quota_user
|
1828
|
-
#
|
1829
|
-
#
|
1956
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1957
|
+
# characters.
|
1958
|
+
# @param [String] user_ip
|
1959
|
+
# Deprecated. Please use quotaUser instead.
|
1830
1960
|
# @param [Google::Apis::RequestOptions] options
|
1831
1961
|
# Request-specific options
|
1832
1962
|
#
|
@@ -1839,26 +1969,29 @@ module Google
|
|
1839
1969
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1840
1970
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1841
1971
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1842
|
-
def delete_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil, &block)
|
1843
|
-
command = make_simple_command(:delete, '
|
1972
|
+
def delete_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1973
|
+
command = make_simple_command(:delete, '{userId}/settings/forwardingAddresses/{forwardingEmail}', options)
|
1844
1974
|
command.params['userId'] = user_id unless user_id.nil?
|
1845
1975
|
command.params['forwardingEmail'] = forwarding_email unless forwarding_email.nil?
|
1846
1976
|
command.query['fields'] = fields unless fields.nil?
|
1847
1977
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1978
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1848
1979
|
execute_or_queue_command(command, &block)
|
1849
1980
|
end
|
1850
1981
|
|
1851
1982
|
# Gets the specified forwarding address.
|
1852
1983
|
# @param [String] user_id
|
1853
|
-
# User's email address.
|
1854
|
-
#
|
1984
|
+
# User's email address. The special value "me" can be used to indicate the
|
1985
|
+
# authenticated user.
|
1855
1986
|
# @param [String] forwarding_email
|
1856
1987
|
# The forwarding address to be retrieved.
|
1857
1988
|
# @param [String] fields
|
1858
1989
|
# Selector specifying which fields to include in a partial response.
|
1859
1990
|
# @param [String] quota_user
|
1860
|
-
#
|
1861
|
-
#
|
1991
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
1992
|
+
# characters.
|
1993
|
+
# @param [String] user_ip
|
1994
|
+
# Deprecated. Please use quotaUser instead.
|
1862
1995
|
# @param [Google::Apis::RequestOptions] options
|
1863
1996
|
# Request-specific options
|
1864
1997
|
#
|
@@ -1871,26 +2004,29 @@ module Google
|
|
1871
2004
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1872
2005
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1873
2006
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1874
|
-
def get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil, &block)
|
1875
|
-
command = make_simple_command(:get, '
|
2007
|
+
def get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2008
|
+
command = make_simple_command(:get, '{userId}/settings/forwardingAddresses/{forwardingEmail}', options)
|
1876
2009
|
command.response_representation = Google::Apis::GmailV1::ForwardingAddress::Representation
|
1877
2010
|
command.response_class = Google::Apis::GmailV1::ForwardingAddress
|
1878
2011
|
command.params['userId'] = user_id unless user_id.nil?
|
1879
2012
|
command.params['forwardingEmail'] = forwarding_email unless forwarding_email.nil?
|
1880
2013
|
command.query['fields'] = fields unless fields.nil?
|
1881
2014
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2015
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1882
2016
|
execute_or_queue_command(command, &block)
|
1883
2017
|
end
|
1884
2018
|
|
1885
2019
|
# Lists the forwarding addresses for the specified account.
|
1886
2020
|
# @param [String] user_id
|
1887
|
-
# User's email address.
|
1888
|
-
#
|
2021
|
+
# User's email address. The special value "me" can be used to indicate the
|
2022
|
+
# authenticated user.
|
1889
2023
|
# @param [String] fields
|
1890
2024
|
# Selector specifying which fields to include in a partial response.
|
1891
2025
|
# @param [String] quota_user
|
1892
|
-
#
|
1893
|
-
#
|
2026
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2027
|
+
# characters.
|
2028
|
+
# @param [String] user_ip
|
2029
|
+
# Deprecated. Please use quotaUser instead.
|
1894
2030
|
# @param [Google::Apis::RequestOptions] options
|
1895
2031
|
# Request-specific options
|
1896
2032
|
#
|
@@ -1903,35 +2039,37 @@ module Google
|
|
1903
2039
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1904
2040
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1905
2041
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1906
|
-
def list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
1907
|
-
command = make_simple_command(:get, '
|
2042
|
+
def list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2043
|
+
command = make_simple_command(:get, '{userId}/settings/forwardingAddresses', options)
|
1908
2044
|
command.response_representation = Google::Apis::GmailV1::ListForwardingAddressesResponse::Representation
|
1909
2045
|
command.response_class = Google::Apis::GmailV1::ListForwardingAddressesResponse
|
1910
2046
|
command.params['userId'] = user_id unless user_id.nil?
|
1911
2047
|
command.query['fields'] = fields unless fields.nil?
|
1912
2048
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2049
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1913
2050
|
execute_or_queue_command(command, &block)
|
1914
2051
|
end
|
1915
2052
|
|
1916
|
-
# Creates a custom "from" send-as alias.
|
1917
|
-
#
|
1918
|
-
#
|
1919
|
-
#
|
1920
|
-
#
|
1921
|
-
#
|
1922
|
-
#
|
1923
|
-
# HTML before saving it with the alias.
|
2053
|
+
# Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will
|
2054
|
+
# attempt to connect to the SMTP service to validate the configuration before
|
2055
|
+
# creating the alias. If ownership verification is required for the alias, a
|
2056
|
+
# message will be sent to the email address and the resource's verification
|
2057
|
+
# status will be set to pending; otherwise, the resource will be created with
|
2058
|
+
# verification status set to accepted. If a signature is provided, Gmail will
|
2059
|
+
# sanitize the HTML before saving it with the alias.
|
1924
2060
|
# This method is only available to service account clients that have been
|
1925
2061
|
# delegated domain-wide authority.
|
1926
2062
|
# @param [String] user_id
|
1927
|
-
# User's email address.
|
1928
|
-
#
|
2063
|
+
# User's email address. The special value "me" can be used to indicate the
|
2064
|
+
# authenticated user.
|
1929
2065
|
# @param [Google::Apis::GmailV1::SendAs] send_as_object
|
1930
2066
|
# @param [String] fields
|
1931
2067
|
# Selector specifying which fields to include in a partial response.
|
1932
2068
|
# @param [String] quota_user
|
1933
|
-
#
|
1934
|
-
#
|
2069
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2070
|
+
# characters.
|
2071
|
+
# @param [String] user_ip
|
2072
|
+
# Deprecated. Please use quotaUser instead.
|
1935
2073
|
# @param [Google::Apis::RequestOptions] options
|
1936
2074
|
# Request-specific options
|
1937
2075
|
#
|
@@ -1944,8 +2082,8 @@ module Google
|
|
1944
2082
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1945
2083
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1946
2084
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1947
|
-
def create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1948
|
-
command = make_simple_command(:post, '
|
2085
|
+
def create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2086
|
+
command = make_simple_command(:post, '{userId}/settings/sendAs', options)
|
1949
2087
|
command.request_representation = Google::Apis::GmailV1::SendAs::Representation
|
1950
2088
|
command.request_object = send_as_object
|
1951
2089
|
command.response_representation = Google::Apis::GmailV1::SendAs::Representation
|
@@ -1953,23 +2091,26 @@ module Google
|
|
1953
2091
|
command.params['userId'] = user_id unless user_id.nil?
|
1954
2092
|
command.query['fields'] = fields unless fields.nil?
|
1955
2093
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2094
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1956
2095
|
execute_or_queue_command(command, &block)
|
1957
2096
|
end
|
1958
2097
|
|
1959
|
-
# Deletes the specified send-as alias.
|
1960
|
-
#
|
2098
|
+
# Deletes the specified send-as alias. Revokes any verification that may have
|
2099
|
+
# been required for using it.
|
1961
2100
|
# This method is only available to service account clients that have been
|
1962
2101
|
# delegated domain-wide authority.
|
1963
2102
|
# @param [String] user_id
|
1964
|
-
# User's email address.
|
1965
|
-
#
|
2103
|
+
# User's email address. The special value "me" can be used to indicate the
|
2104
|
+
# authenticated user.
|
1966
2105
|
# @param [String] send_as_email
|
1967
2106
|
# The send-as alias to be deleted.
|
1968
2107
|
# @param [String] fields
|
1969
2108
|
# Selector specifying which fields to include in a partial response.
|
1970
2109
|
# @param [String] quota_user
|
1971
|
-
#
|
1972
|
-
#
|
2110
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2111
|
+
# characters.
|
2112
|
+
# @param [String] user_ip
|
2113
|
+
# Deprecated. Please use quotaUser instead.
|
1973
2114
|
# @param [Google::Apis::RequestOptions] options
|
1974
2115
|
# Request-specific options
|
1975
2116
|
#
|
@@ -1982,27 +2123,30 @@ module Google
|
|
1982
2123
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1983
2124
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1984
2125
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1985
|
-
def delete_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block)
|
1986
|
-
command = make_simple_command(:delete, '
|
2126
|
+
def delete_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2127
|
+
command = make_simple_command(:delete, '{userId}/settings/sendAs/{sendAsEmail}', options)
|
1987
2128
|
command.params['userId'] = user_id unless user_id.nil?
|
1988
2129
|
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
|
1989
2130
|
command.query['fields'] = fields unless fields.nil?
|
1990
2131
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2132
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
1991
2133
|
execute_or_queue_command(command, &block)
|
1992
2134
|
end
|
1993
2135
|
|
1994
|
-
# Gets the specified send-as alias.
|
2136
|
+
# Gets the specified send-as alias. Fails with an HTTP 404 error if the
|
1995
2137
|
# specified address is not a member of the collection.
|
1996
2138
|
# @param [String] user_id
|
1997
|
-
# User's email address.
|
1998
|
-
#
|
2139
|
+
# User's email address. The special value "me" can be used to indicate the
|
2140
|
+
# authenticated user.
|
1999
2141
|
# @param [String] send_as_email
|
2000
2142
|
# The send-as alias to be retrieved.
|
2001
2143
|
# @param [String] fields
|
2002
2144
|
# Selector specifying which fields to include in a partial response.
|
2003
2145
|
# @param [String] quota_user
|
2004
|
-
#
|
2005
|
-
#
|
2146
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2147
|
+
# characters.
|
2148
|
+
# @param [String] user_ip
|
2149
|
+
# Deprecated. Please use quotaUser instead.
|
2006
2150
|
# @param [Google::Apis::RequestOptions] options
|
2007
2151
|
# Request-specific options
|
2008
2152
|
#
|
@@ -2015,28 +2159,31 @@ module Google
|
|
2015
2159
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2016
2160
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2017
2161
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2018
|
-
def get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block)
|
2019
|
-
command = make_simple_command(:get, '
|
2162
|
+
def get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2163
|
+
command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}', options)
|
2020
2164
|
command.response_representation = Google::Apis::GmailV1::SendAs::Representation
|
2021
2165
|
command.response_class = Google::Apis::GmailV1::SendAs
|
2022
2166
|
command.params['userId'] = user_id unless user_id.nil?
|
2023
2167
|
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
|
2024
2168
|
command.query['fields'] = fields unless fields.nil?
|
2025
2169
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2170
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2026
2171
|
execute_or_queue_command(command, &block)
|
2027
2172
|
end
|
2028
2173
|
|
2029
|
-
# Lists the send-as aliases for the specified account.
|
2030
|
-
#
|
2031
|
-
#
|
2174
|
+
# Lists the send-as aliases for the specified account. The result includes the
|
2175
|
+
# primary send-as address associated with the account as well as any custom "
|
2176
|
+
# from" aliases.
|
2032
2177
|
# @param [String] user_id
|
2033
|
-
# User's email address.
|
2034
|
-
#
|
2178
|
+
# User's email address. The special value "me" can be used to indicate the
|
2179
|
+
# authenticated user.
|
2035
2180
|
# @param [String] fields
|
2036
2181
|
# Selector specifying which fields to include in a partial response.
|
2037
2182
|
# @param [String] quota_user
|
2038
|
-
#
|
2039
|
-
#
|
2183
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2184
|
+
# characters.
|
2185
|
+
# @param [String] user_ip
|
2186
|
+
# Deprecated. Please use quotaUser instead.
|
2040
2187
|
# @param [Google::Apis::RequestOptions] options
|
2041
2188
|
# Request-specific options
|
2042
2189
|
#
|
@@ -2049,28 +2196,35 @@ module Google
|
|
2049
2196
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2050
2197
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2051
2198
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2052
|
-
def list_user_setting_send_as(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
2053
|
-
command = make_simple_command(:get, '
|
2199
|
+
def list_user_setting_send_as(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2200
|
+
command = make_simple_command(:get, '{userId}/settings/sendAs', options)
|
2054
2201
|
command.response_representation = Google::Apis::GmailV1::ListSendAsResponse::Representation
|
2055
2202
|
command.response_class = Google::Apis::GmailV1::ListSendAsResponse
|
2056
2203
|
command.params['userId'] = user_id unless user_id.nil?
|
2057
2204
|
command.query['fields'] = fields unless fields.nil?
|
2058
2205
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2206
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2059
2207
|
execute_or_queue_command(command, &block)
|
2060
2208
|
end
|
2061
2209
|
|
2062
|
-
#
|
2210
|
+
# Updates a send-as alias. If a signature is provided, Gmail will sanitize the
|
2211
|
+
# HTML before saving it with the alias.
|
2212
|
+
# Addresses other than the primary address for the account can only be updated
|
2213
|
+
# by service account clients that have been delegated domain-wide authority.
|
2214
|
+
# This method supports patch semantics.
|
2063
2215
|
# @param [String] user_id
|
2064
|
-
# User's email address.
|
2065
|
-
#
|
2216
|
+
# User's email address. The special value "me" can be used to indicate the
|
2217
|
+
# authenticated user.
|
2066
2218
|
# @param [String] send_as_email
|
2067
2219
|
# The send-as alias to be updated.
|
2068
2220
|
# @param [Google::Apis::GmailV1::SendAs] send_as_object
|
2069
2221
|
# @param [String] fields
|
2070
2222
|
# Selector specifying which fields to include in a partial response.
|
2071
2223
|
# @param [String] quota_user
|
2072
|
-
#
|
2073
|
-
#
|
2224
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2225
|
+
# characters.
|
2226
|
+
# @param [String] user_ip
|
2227
|
+
# Deprecated. Please use quotaUser instead.
|
2074
2228
|
# @param [Google::Apis::RequestOptions] options
|
2075
2229
|
# Request-specific options
|
2076
2230
|
#
|
@@ -2083,8 +2237,8 @@ module Google
|
|
2083
2237
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2084
2238
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2085
2239
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2086
|
-
def patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2087
|
-
command = make_simple_command(:patch, '
|
2240
|
+
def patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2241
|
+
command = make_simple_command(:patch, '{userId}/settings/sendAs/{sendAsEmail}', options)
|
2088
2242
|
command.request_representation = Google::Apis::GmailV1::SendAs::Representation
|
2089
2243
|
command.request_object = send_as_object
|
2090
2244
|
command.response_representation = Google::Apis::GmailV1::SendAs::Representation
|
@@ -2093,25 +2247,27 @@ module Google
|
|
2093
2247
|
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
|
2094
2248
|
command.query['fields'] = fields unless fields.nil?
|
2095
2249
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2250
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2096
2251
|
execute_or_queue_command(command, &block)
|
2097
2252
|
end
|
2098
2253
|
|
2099
|
-
# Updates a send-as alias.
|
2100
|
-
#
|
2101
|
-
# Addresses other than the primary address for the account can only be
|
2102
|
-
#
|
2103
|
-
# authority.
|
2254
|
+
# Updates a send-as alias. If a signature is provided, Gmail will sanitize the
|
2255
|
+
# HTML before saving it with the alias.
|
2256
|
+
# Addresses other than the primary address for the account can only be updated
|
2257
|
+
# by service account clients that have been delegated domain-wide authority.
|
2104
2258
|
# @param [String] user_id
|
2105
|
-
# User's email address.
|
2106
|
-
#
|
2259
|
+
# User's email address. The special value "me" can be used to indicate the
|
2260
|
+
# authenticated user.
|
2107
2261
|
# @param [String] send_as_email
|
2108
2262
|
# The send-as alias to be updated.
|
2109
2263
|
# @param [Google::Apis::GmailV1::SendAs] send_as_object
|
2110
2264
|
# @param [String] fields
|
2111
2265
|
# Selector specifying which fields to include in a partial response.
|
2112
2266
|
# @param [String] quota_user
|
2113
|
-
#
|
2114
|
-
#
|
2267
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2268
|
+
# characters.
|
2269
|
+
# @param [String] user_ip
|
2270
|
+
# Deprecated. Please use quotaUser instead.
|
2115
2271
|
# @param [Google::Apis::RequestOptions] options
|
2116
2272
|
# Request-specific options
|
2117
2273
|
#
|
@@ -2124,8 +2280,8 @@ module Google
|
|
2124
2280
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2125
2281
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2126
2282
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2127
|
-
def update_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2128
|
-
command = make_simple_command(:put, '
|
2283
|
+
def update_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2284
|
+
command = make_simple_command(:put, '{userId}/settings/sendAs/{sendAsEmail}', options)
|
2129
2285
|
command.request_representation = Google::Apis::GmailV1::SendAs::Representation
|
2130
2286
|
command.request_object = send_as_object
|
2131
2287
|
command.response_representation = Google::Apis::GmailV1::SendAs::Representation
|
@@ -2134,23 +2290,26 @@ module Google
|
|
2134
2290
|
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
|
2135
2291
|
command.query['fields'] = fields unless fields.nil?
|
2136
2292
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2293
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2137
2294
|
execute_or_queue_command(command, &block)
|
2138
2295
|
end
|
2139
2296
|
|
2140
|
-
# Sends a verification email to the specified send-as alias address.
|
2141
|
-
#
|
2297
|
+
# Sends a verification email to the specified send-as alias address. The
|
2298
|
+
# verification status must be pending.
|
2142
2299
|
# This method is only available to service account clients that have been
|
2143
2300
|
# delegated domain-wide authority.
|
2144
2301
|
# @param [String] user_id
|
2145
|
-
# User's email address.
|
2146
|
-
#
|
2302
|
+
# User's email address. The special value "me" can be used to indicate the
|
2303
|
+
# authenticated user.
|
2147
2304
|
# @param [String] send_as_email
|
2148
2305
|
# The send-as alias to be verified.
|
2149
2306
|
# @param [String] fields
|
2150
2307
|
# Selector specifying which fields to include in a partial response.
|
2151
2308
|
# @param [String] quota_user
|
2152
|
-
#
|
2153
|
-
#
|
2309
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2310
|
+
# characters.
|
2311
|
+
# @param [String] user_ip
|
2312
|
+
# Deprecated. Please use quotaUser instead.
|
2154
2313
|
# @param [Google::Apis::RequestOptions] options
|
2155
2314
|
# Request-specific options
|
2156
2315
|
#
|
@@ -2163,29 +2322,32 @@ module Google
|
|
2163
2322
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2164
2323
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2165
2324
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2166
|
-
def verify_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block)
|
2167
|
-
command = make_simple_command(:post, '
|
2325
|
+
def verify_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2326
|
+
command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/verify', options)
|
2168
2327
|
command.params['userId'] = user_id unless user_id.nil?
|
2169
2328
|
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
|
2170
2329
|
command.query['fields'] = fields unless fields.nil?
|
2171
2330
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2331
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2172
2332
|
execute_or_queue_command(command, &block)
|
2173
2333
|
end
|
2174
2334
|
|
2175
2335
|
# Deletes the specified S/MIME config for the specified send-as alias.
|
2176
2336
|
# @param [String] user_id
|
2177
|
-
# The user's email address. The special value
|
2178
|
-
#
|
2337
|
+
# The user's email address. The special value me can be used to indicate the
|
2338
|
+
# authenticated user.
|
2179
2339
|
# @param [String] send_as_email
|
2180
|
-
# The email address that appears in the "From:" header for mail sent using
|
2181
|
-
#
|
2340
|
+
# The email address that appears in the "From:" header for mail sent using this
|
2341
|
+
# alias.
|
2182
2342
|
# @param [String] id
|
2183
2343
|
# The immutable ID for the SmimeInfo.
|
2184
2344
|
# @param [String] fields
|
2185
2345
|
# Selector specifying which fields to include in a partial response.
|
2186
2346
|
# @param [String] quota_user
|
2187
|
-
#
|
2188
|
-
#
|
2347
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2348
|
+
# characters.
|
2349
|
+
# @param [String] user_ip
|
2350
|
+
# Deprecated. Please use quotaUser instead.
|
2189
2351
|
# @param [Google::Apis::RequestOptions] options
|
2190
2352
|
# Request-specific options
|
2191
2353
|
#
|
@@ -2198,30 +2360,33 @@ module Google
|
|
2198
2360
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2199
2361
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2200
2362
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2201
|
-
def delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block)
|
2202
|
-
command = make_simple_command(:delete, '
|
2363
|
+
def delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2364
|
+
command = make_simple_command(:delete, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options)
|
2203
2365
|
command.params['userId'] = user_id unless user_id.nil?
|
2204
2366
|
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
|
2205
2367
|
command.params['id'] = id unless id.nil?
|
2206
2368
|
command.query['fields'] = fields unless fields.nil?
|
2207
2369
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2370
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2208
2371
|
execute_or_queue_command(command, &block)
|
2209
2372
|
end
|
2210
2373
|
|
2211
2374
|
# Gets the specified S/MIME config for the specified send-as alias.
|
2212
2375
|
# @param [String] user_id
|
2213
|
-
# The user's email address. The special value
|
2214
|
-
#
|
2376
|
+
# The user's email address. The special value me can be used to indicate the
|
2377
|
+
# authenticated user.
|
2215
2378
|
# @param [String] send_as_email
|
2216
|
-
# The email address that appears in the "From:" header for mail sent using
|
2217
|
-
#
|
2379
|
+
# The email address that appears in the "From:" header for mail sent using this
|
2380
|
+
# alias.
|
2218
2381
|
# @param [String] id
|
2219
2382
|
# The immutable ID for the SmimeInfo.
|
2220
2383
|
# @param [String] fields
|
2221
2384
|
# Selector specifying which fields to include in a partial response.
|
2222
2385
|
# @param [String] quota_user
|
2223
|
-
#
|
2224
|
-
#
|
2386
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2387
|
+
# characters.
|
2388
|
+
# @param [String] user_ip
|
2389
|
+
# Deprecated. Please use quotaUser instead.
|
2225
2390
|
# @param [Google::Apis::RequestOptions] options
|
2226
2391
|
# Request-specific options
|
2227
2392
|
#
|
@@ -2234,8 +2399,8 @@ module Google
|
|
2234
2399
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2235
2400
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2236
2401
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2237
|
-
def get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block)
|
2238
|
-
command = make_simple_command(:get, '
|
2402
|
+
def get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2403
|
+
command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options)
|
2239
2404
|
command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation
|
2240
2405
|
command.response_class = Google::Apis::GmailV1::SmimeInfo
|
2241
2406
|
command.params['userId'] = user_id unless user_id.nil?
|
@@ -2243,23 +2408,26 @@ module Google
|
|
2243
2408
|
command.params['id'] = id unless id.nil?
|
2244
2409
|
command.query['fields'] = fields unless fields.nil?
|
2245
2410
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2411
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2246
2412
|
execute_or_queue_command(command, &block)
|
2247
2413
|
end
|
2248
2414
|
|
2249
|
-
# Insert (upload) the given S/MIME config for the specified send-as alias.
|
2250
|
-
#
|
2415
|
+
# Insert (upload) the given S/MIME config for the specified send-as alias. Note
|
2416
|
+
# that pkcs12 format is required for the key.
|
2251
2417
|
# @param [String] user_id
|
2252
|
-
# The user's email address. The special value
|
2253
|
-
#
|
2418
|
+
# The user's email address. The special value me can be used to indicate the
|
2419
|
+
# authenticated user.
|
2254
2420
|
# @param [String] send_as_email
|
2255
|
-
# The email address that appears in the "From:" header for mail sent using
|
2256
|
-
#
|
2421
|
+
# The email address that appears in the "From:" header for mail sent using this
|
2422
|
+
# alias.
|
2257
2423
|
# @param [Google::Apis::GmailV1::SmimeInfo] smime_info_object
|
2258
2424
|
# @param [String] fields
|
2259
2425
|
# Selector specifying which fields to include in a partial response.
|
2260
2426
|
# @param [String] quota_user
|
2261
|
-
#
|
2262
|
-
#
|
2427
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2428
|
+
# characters.
|
2429
|
+
# @param [String] user_ip
|
2430
|
+
# Deprecated. Please use quotaUser instead.
|
2263
2431
|
# @param [Google::Apis::RequestOptions] options
|
2264
2432
|
# Request-specific options
|
2265
2433
|
#
|
@@ -2272,8 +2440,8 @@ module Google
|
|
2272
2440
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2273
2441
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2274
2442
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2275
|
-
def insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2276
|
-
command = make_simple_command(:post, '
|
2443
|
+
def insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2444
|
+
command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options)
|
2277
2445
|
command.request_representation = Google::Apis::GmailV1::SmimeInfo::Representation
|
2278
2446
|
command.request_object = smime_info_object
|
2279
2447
|
command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation
|
@@ -2282,21 +2450,24 @@ module Google
|
|
2282
2450
|
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
|
2283
2451
|
command.query['fields'] = fields unless fields.nil?
|
2284
2452
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2453
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2285
2454
|
execute_or_queue_command(command, &block)
|
2286
2455
|
end
|
2287
2456
|
|
2288
2457
|
# Lists S/MIME configs for the specified send-as alias.
|
2289
2458
|
# @param [String] user_id
|
2290
|
-
# The user's email address. The special value
|
2291
|
-
#
|
2459
|
+
# The user's email address. The special value me can be used to indicate the
|
2460
|
+
# authenticated user.
|
2292
2461
|
# @param [String] send_as_email
|
2293
|
-
# The email address that appears in the "From:" header for mail sent using
|
2294
|
-
#
|
2462
|
+
# The email address that appears in the "From:" header for mail sent using this
|
2463
|
+
# alias.
|
2295
2464
|
# @param [String] fields
|
2296
2465
|
# Selector specifying which fields to include in a partial response.
|
2297
2466
|
# @param [String] quota_user
|
2298
|
-
#
|
2299
|
-
#
|
2467
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2468
|
+
# characters.
|
2469
|
+
# @param [String] user_ip
|
2470
|
+
# Deprecated. Please use quotaUser instead.
|
2300
2471
|
# @param [Google::Apis::RequestOptions] options
|
2301
2472
|
# Request-specific options
|
2302
2473
|
#
|
@@ -2309,31 +2480,34 @@ module Google
|
|
2309
2480
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2310
2481
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2311
2482
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2312
|
-
def list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block)
|
2313
|
-
command = make_simple_command(:get, '
|
2483
|
+
def list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2484
|
+
command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options)
|
2314
2485
|
command.response_representation = Google::Apis::GmailV1::ListSmimeInfoResponse::Representation
|
2315
2486
|
command.response_class = Google::Apis::GmailV1::ListSmimeInfoResponse
|
2316
2487
|
command.params['userId'] = user_id unless user_id.nil?
|
2317
2488
|
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
|
2318
2489
|
command.query['fields'] = fields unless fields.nil?
|
2319
2490
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2491
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2320
2492
|
execute_or_queue_command(command, &block)
|
2321
2493
|
end
|
2322
2494
|
|
2323
2495
|
# Sets the default S/MIME config for the specified send-as alias.
|
2324
2496
|
# @param [String] user_id
|
2325
|
-
# The user's email address. The special value
|
2326
|
-
#
|
2497
|
+
# The user's email address. The special value me can be used to indicate the
|
2498
|
+
# authenticated user.
|
2327
2499
|
# @param [String] send_as_email
|
2328
|
-
# The email address that appears in the "From:" header for mail sent using
|
2329
|
-
#
|
2500
|
+
# The email address that appears in the "From:" header for mail sent using this
|
2501
|
+
# alias.
|
2330
2502
|
# @param [String] id
|
2331
2503
|
# The immutable ID for the SmimeInfo.
|
2332
2504
|
# @param [String] fields
|
2333
2505
|
# Selector specifying which fields to include in a partial response.
|
2334
2506
|
# @param [String] quota_user
|
2335
|
-
#
|
2336
|
-
#
|
2507
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2508
|
+
# characters.
|
2509
|
+
# @param [String] user_ip
|
2510
|
+
# Deprecated. Please use quotaUser instead.
|
2337
2511
|
# @param [Google::Apis::RequestOptions] options
|
2338
2512
|
# Request-specific options
|
2339
2513
|
#
|
@@ -2346,28 +2520,31 @@ module Google
|
|
2346
2520
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2347
2521
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2348
2522
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2349
|
-
def set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block)
|
2350
|
-
command = make_simple_command(:post, '
|
2523
|
+
def set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2524
|
+
command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault', options)
|
2351
2525
|
command.params['userId'] = user_id unless user_id.nil?
|
2352
2526
|
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
|
2353
2527
|
command.params['id'] = id unless id.nil?
|
2354
2528
|
command.query['fields'] = fields unless fields.nil?
|
2355
2529
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2530
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2356
2531
|
execute_or_queue_command(command, &block)
|
2357
2532
|
end
|
2358
2533
|
|
2359
2534
|
# Immediately and permanently deletes the specified thread. This operation
|
2360
|
-
# cannot be undone. Prefer
|
2535
|
+
# cannot be undone. Prefer threads.trash instead.
|
2361
2536
|
# @param [String] user_id
|
2362
|
-
# The user's email address. The special value
|
2363
|
-
#
|
2537
|
+
# The user's email address. The special value me can be used to indicate the
|
2538
|
+
# authenticated user.
|
2364
2539
|
# @param [String] id
|
2365
2540
|
# ID of the Thread to delete.
|
2366
2541
|
# @param [String] fields
|
2367
2542
|
# Selector specifying which fields to include in a partial response.
|
2368
2543
|
# @param [String] quota_user
|
2369
|
-
#
|
2370
|
-
#
|
2544
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2545
|
+
# characters.
|
2546
|
+
# @param [String] user_ip
|
2547
|
+
# Deprecated. Please use quotaUser instead.
|
2371
2548
|
# @param [Google::Apis::RequestOptions] options
|
2372
2549
|
# Request-specific options
|
2373
2550
|
#
|
@@ -2380,19 +2557,20 @@ module Google
|
|
2380
2557
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2381
2558
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2382
2559
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2383
|
-
def delete_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
2384
|
-
command = make_simple_command(:delete, '
|
2560
|
+
def delete_user_thread(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2561
|
+
command = make_simple_command(:delete, '{userId}/threads/{id}', options)
|
2385
2562
|
command.params['userId'] = user_id unless user_id.nil?
|
2386
2563
|
command.params['id'] = id unless id.nil?
|
2387
2564
|
command.query['fields'] = fields unless fields.nil?
|
2388
2565
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2566
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2389
2567
|
execute_or_queue_command(command, &block)
|
2390
2568
|
end
|
2391
2569
|
|
2392
2570
|
# Gets the specified thread.
|
2393
2571
|
# @param [String] user_id
|
2394
|
-
# The user's email address. The special value
|
2395
|
-
#
|
2572
|
+
# The user's email address. The special value me can be used to indicate the
|
2573
|
+
# authenticated user.
|
2396
2574
|
# @param [String] id
|
2397
2575
|
# The ID of the thread to retrieve.
|
2398
2576
|
# @param [String] format
|
@@ -2402,8 +2580,10 @@ module Google
|
|
2402
2580
|
# @param [String] fields
|
2403
2581
|
# Selector specifying which fields to include in a partial response.
|
2404
2582
|
# @param [String] quota_user
|
2405
|
-
#
|
2406
|
-
#
|
2583
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2584
|
+
# characters.
|
2585
|
+
# @param [String] user_ip
|
2586
|
+
# Deprecated. Please use quotaUser instead.
|
2407
2587
|
# @param [Google::Apis::RequestOptions] options
|
2408
2588
|
# Request-specific options
|
2409
2589
|
#
|
@@ -2416,8 +2596,8 @@ module Google
|
|
2416
2596
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2417
2597
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2418
2598
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2419
|
-
def get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2420
|
-
command = make_simple_command(:get, '
|
2599
|
+
def get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2600
|
+
command = make_simple_command(:get, '{userId}/threads/{id}', options)
|
2421
2601
|
command.response_representation = Google::Apis::GmailV1::Thread::Representation
|
2422
2602
|
command.response_class = Google::Apis::GmailV1::Thread
|
2423
2603
|
command.params['userId'] = user_id unless user_id.nil?
|
@@ -2426,16 +2606,16 @@ module Google
|
|
2426
2606
|
command.query['metadataHeaders'] = metadata_headers unless metadata_headers.nil?
|
2427
2607
|
command.query['fields'] = fields unless fields.nil?
|
2428
2608
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2609
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2429
2610
|
execute_or_queue_command(command, &block)
|
2430
2611
|
end
|
2431
2612
|
|
2432
2613
|
# Lists the threads in the user's mailbox.
|
2433
2614
|
# @param [String] user_id
|
2434
|
-
# The user's email address. The special value
|
2435
|
-
#
|
2615
|
+
# The user's email address. The special value me can be used to indicate the
|
2616
|
+
# authenticated user.
|
2436
2617
|
# @param [Boolean] include_spam_trash
|
2437
|
-
# Include threads from
|
2438
|
-
# in the results.
|
2618
|
+
# Include threads from SPAM and TRASH in the results.
|
2439
2619
|
# @param [Array<String>, String] label_ids
|
2440
2620
|
# Only return threads with labels that match all of the specified label IDs.
|
2441
2621
|
# @param [Fixnum] max_results
|
@@ -2443,16 +2623,17 @@ module Google
|
|
2443
2623
|
# @param [String] page_token
|
2444
2624
|
# Page token to retrieve a specific page of results in the list.
|
2445
2625
|
# @param [String] q
|
2446
|
-
# Only return threads matching the specified query. Supports the same
|
2447
|
-
#
|
2448
|
-
#
|
2449
|
-
#
|
2450
|
-
# using the gmail.metadata scope.
|
2626
|
+
# Only return threads matching the specified query. Supports the same query
|
2627
|
+
# format as the Gmail search box. For example, "from:someuser@example.com
|
2628
|
+
# rfc822msgid: is:unread". Parameter cannot be used when accessing the api using
|
2629
|
+
# the gmail.metadata scope.
|
2451
2630
|
# @param [String] fields
|
2452
2631
|
# Selector specifying which fields to include in a partial response.
|
2453
2632
|
# @param [String] quota_user
|
2454
|
-
#
|
2455
|
-
#
|
2633
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2634
|
+
# characters.
|
2635
|
+
# @param [String] user_ip
|
2636
|
+
# Deprecated. Please use quotaUser instead.
|
2456
2637
|
# @param [Google::Apis::RequestOptions] options
|
2457
2638
|
# Request-specific options
|
2458
2639
|
#
|
@@ -2465,8 +2646,8 @@ module Google
|
|
2465
2646
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2466
2647
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2467
2648
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2468
|
-
def list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2469
|
-
command = make_simple_command(:get, '
|
2649
|
+
def list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2650
|
+
command = make_simple_command(:get, '{userId}/threads', options)
|
2470
2651
|
command.response_representation = Google::Apis::GmailV1::ListThreadsResponse::Representation
|
2471
2652
|
command.response_class = Google::Apis::GmailV1::ListThreadsResponse
|
2472
2653
|
command.params['userId'] = user_id unless user_id.nil?
|
@@ -2477,22 +2658,25 @@ module Google
|
|
2477
2658
|
command.query['q'] = q unless q.nil?
|
2478
2659
|
command.query['fields'] = fields unless fields.nil?
|
2479
2660
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2661
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2480
2662
|
execute_or_queue_command(command, &block)
|
2481
2663
|
end
|
2482
2664
|
|
2483
|
-
# Modifies the labels applied to the thread. This applies to all messages
|
2484
|
-
#
|
2665
|
+
# Modifies the labels applied to the thread. This applies to all messages in the
|
2666
|
+
# thread.
|
2485
2667
|
# @param [String] user_id
|
2486
|
-
# The user's email address. The special value
|
2487
|
-
#
|
2668
|
+
# The user's email address. The special value me can be used to indicate the
|
2669
|
+
# authenticated user.
|
2488
2670
|
# @param [String] id
|
2489
2671
|
# The ID of the thread to modify.
|
2490
2672
|
# @param [Google::Apis::GmailV1::ModifyThreadRequest] modify_thread_request_object
|
2491
2673
|
# @param [String] fields
|
2492
2674
|
# Selector specifying which fields to include in a partial response.
|
2493
2675
|
# @param [String] quota_user
|
2494
|
-
#
|
2495
|
-
#
|
2676
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2677
|
+
# characters.
|
2678
|
+
# @param [String] user_ip
|
2679
|
+
# Deprecated. Please use quotaUser instead.
|
2496
2680
|
# @param [Google::Apis::RequestOptions] options
|
2497
2681
|
# Request-specific options
|
2498
2682
|
#
|
@@ -2505,8 +2689,8 @@ module Google
|
|
2505
2689
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2506
2690
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2507
2691
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2508
|
-
def modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2509
|
-
command = make_simple_command(:post, '
|
2692
|
+
def modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2693
|
+
command = make_simple_command(:post, '{userId}/threads/{id}/modify', options)
|
2510
2694
|
command.request_representation = Google::Apis::GmailV1::ModifyThreadRequest::Representation
|
2511
2695
|
command.request_object = modify_thread_request_object
|
2512
2696
|
command.response_representation = Google::Apis::GmailV1::Thread::Representation
|
@@ -2515,20 +2699,23 @@ module Google
|
|
2515
2699
|
command.params['id'] = id unless id.nil?
|
2516
2700
|
command.query['fields'] = fields unless fields.nil?
|
2517
2701
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2702
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2518
2703
|
execute_or_queue_command(command, &block)
|
2519
2704
|
end
|
2520
2705
|
|
2521
2706
|
# Moves the specified thread to the trash.
|
2522
2707
|
# @param [String] user_id
|
2523
|
-
# The user's email address. The special value
|
2524
|
-
#
|
2708
|
+
# The user's email address. The special value me can be used to indicate the
|
2709
|
+
# authenticated user.
|
2525
2710
|
# @param [String] id
|
2526
2711
|
# The ID of the thread to Trash.
|
2527
2712
|
# @param [String] fields
|
2528
2713
|
# Selector specifying which fields to include in a partial response.
|
2529
2714
|
# @param [String] quota_user
|
2530
|
-
#
|
2531
|
-
#
|
2715
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2716
|
+
# characters.
|
2717
|
+
# @param [String] user_ip
|
2718
|
+
# Deprecated. Please use quotaUser instead.
|
2532
2719
|
# @param [Google::Apis::RequestOptions] options
|
2533
2720
|
# Request-specific options
|
2534
2721
|
#
|
@@ -2541,28 +2728,31 @@ module Google
|
|
2541
2728
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2542
2729
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2543
2730
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2544
|
-
def trash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
2545
|
-
command = make_simple_command(:post, '
|
2731
|
+
def trash_user_thread(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2732
|
+
command = make_simple_command(:post, '{userId}/threads/{id}/trash', options)
|
2546
2733
|
command.response_representation = Google::Apis::GmailV1::Thread::Representation
|
2547
2734
|
command.response_class = Google::Apis::GmailV1::Thread
|
2548
2735
|
command.params['userId'] = user_id unless user_id.nil?
|
2549
2736
|
command.params['id'] = id unless id.nil?
|
2550
2737
|
command.query['fields'] = fields unless fields.nil?
|
2551
2738
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2739
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2552
2740
|
execute_or_queue_command(command, &block)
|
2553
2741
|
end
|
2554
2742
|
|
2555
2743
|
# Removes the specified thread from the trash.
|
2556
2744
|
# @param [String] user_id
|
2557
|
-
# The user's email address. The special value
|
2558
|
-
#
|
2745
|
+
# The user's email address. The special value me can be used to indicate the
|
2746
|
+
# authenticated user.
|
2559
2747
|
# @param [String] id
|
2560
2748
|
# The ID of the thread to remove from Trash.
|
2561
2749
|
# @param [String] fields
|
2562
2750
|
# Selector specifying which fields to include in a partial response.
|
2563
2751
|
# @param [String] quota_user
|
2564
|
-
#
|
2565
|
-
#
|
2752
|
+
# An opaque string that represents a user for quota purposes. Must not exceed 40
|
2753
|
+
# characters.
|
2754
|
+
# @param [String] user_ip
|
2755
|
+
# Deprecated. Please use quotaUser instead.
|
2566
2756
|
# @param [Google::Apis::RequestOptions] options
|
2567
2757
|
# Request-specific options
|
2568
2758
|
#
|
@@ -2575,14 +2765,15 @@ module Google
|
|
2575
2765
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2576
2766
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2577
2767
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2578
|
-
def untrash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
2579
|
-
command = make_simple_command(:post, '
|
2768
|
+
def untrash_user_thread(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2769
|
+
command = make_simple_command(:post, '{userId}/threads/{id}/untrash', options)
|
2580
2770
|
command.response_representation = Google::Apis::GmailV1::Thread::Representation
|
2581
2771
|
command.response_class = Google::Apis::GmailV1::Thread
|
2582
2772
|
command.params['userId'] = user_id unless user_id.nil?
|
2583
2773
|
command.params['id'] = id unless id.nil?
|
2584
2774
|
command.query['fields'] = fields unless fields.nil?
|
2585
2775
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2776
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2586
2777
|
execute_or_queue_command(command, &block)
|
2587
2778
|
end
|
2588
2779
|
|
@@ -2591,6 +2782,7 @@ module Google
|
|
2591
2782
|
def apply_command_defaults(command)
|
2592
2783
|
command.query['key'] = key unless key.nil?
|
2593
2784
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2785
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
2594
2786
|
end
|
2595
2787
|
end
|
2596
2788
|
end
|