-
Notifications
You must be signed in to change notification settings - Fork 868
/
service.rb
2598 lines (2524 loc) · 152 KB
/
service.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module GmailV1
# Gmail API
#
# The Gmail API lets you view and manage Gmail mailbox data like
# threads, messages, and labels.
#
# @example
# require 'google/apis/gmail_v1'
#
# Gmail = Google::Apis::GmailV1 # Alias the module
# service = Gmail::GmailService.new
#
# @see https://developers.google.com/gmail/api/
class GmailService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://www.googleapis.com/', '')
@batch_path = 'batch/gmail/v1'
end
# Gets the current user's Gmail profile.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Profile] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Profile]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_user_profile(user_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'gmail/v1/users/{userId}/profile', options)
command.response_representation = Google::Apis::GmailV1::Profile::Representation
command.response_class = Google::Apis::GmailV1::Profile
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Stop receiving push notifications for the given user mailbox.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def stop_user(user_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'gmail/v1/users/{userId}/stop', options)
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Set up or update a push notification watch on the given user mailbox.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Google::Apis::GmailV1::WatchRequest] watch_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::WatchResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::WatchResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'gmail/v1/users/{userId}/watch', options)
command.request_representation = Google::Apis::GmailV1::WatchRequest::Representation
command.request_object = watch_request_object
command.response_representation = Google::Apis::GmailV1::WatchResponse::Representation
command.response_class = Google::Apis::GmailV1::WatchResponse
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new draft with the `DRAFT` label.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Google::Apis::GmailV1::Draft] draft_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [IO, String] upload_source
# IO stream or filename containing content to upload
# @param [String] content_type
# Content type of the uploaded content.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Draft] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Draft]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:post, 'gmail/v1/users/{userId}/drafts', options)
else
command = make_upload_command(:post, 'gmail/v1/users/{userId}/drafts', options)
command.upload_source = upload_source
command.upload_content_type = content_type
end
command.request_representation = Google::Apis::GmailV1::Draft::Representation
command.request_object = draft_object
command.response_representation = Google::Apis::GmailV1::Draft::Representation
command.response_class = Google::Apis::GmailV1::Draft
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Immediately and permanently deletes the specified draft.
# Does not simply trash it.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the draft to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_user_draft(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'gmail/v1/users/{userId}/drafts/{id}', options)
command.params['userId'] = user_id unless user_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the specified draft.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the draft to retrieve.
# @param [String] format
# The format to return the draft in.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Draft] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Draft]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'gmail/v1/users/{userId}/drafts/{id}', options)
command.response_representation = Google::Apis::GmailV1::Draft::Representation
command.response_class = Google::Apis::GmailV1::Draft
command.params['userId'] = user_id unless user_id.nil?
command.params['id'] = id unless id.nil?
command.query['format'] = format unless format.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the drafts in the user's mailbox.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Boolean] include_spam_trash
# Include drafts from `SPAM` and `TRASH`
# in the results.
# @param [Fixnum] max_results
# Maximum number of drafts to return.
# @param [String] page_token
# Page token to retrieve a specific page of results in the list.
# @param [String] q
# Only return draft messages matching the specified query. Supports the same
# query format as the Gmail search box. For example,
# `"from:someuser@example.com rfc822msgid:<somemsgid@example.com>
# is:unread"`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::ListDraftsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::ListDraftsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'gmail/v1/users/{userId}/drafts', options)
command.response_representation = Google::Apis::GmailV1::ListDraftsResponse::Representation
command.response_class = Google::Apis::GmailV1::ListDraftsResponse
command.params['userId'] = user_id unless user_id.nil?
command.query['includeSpamTrash'] = include_spam_trash unless include_spam_trash.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['q'] = q unless q.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sends the specified, existing draft to the recipients in the
# `To`, `Cc`, and `Bcc` headers.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Google::Apis::GmailV1::Draft] draft_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [IO, String] upload_source
# IO stream or filename containing content to upload
# @param [String] content_type
# Content type of the uploaded content.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Message] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Message]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:post, 'gmail/v1/users/{userId}/drafts/send', options)
else
command = make_upload_command(:post, 'gmail/v1/users/{userId}/drafts/send', options)
command.upload_source = upload_source
command.upload_content_type = content_type
end
command.request_representation = Google::Apis::GmailV1::Draft::Representation
command.request_object = draft_object
command.response_representation = Google::Apis::GmailV1::Message::Representation
command.response_class = Google::Apis::GmailV1::Message
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Replaces a draft's content.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the draft to update.
# @param [Google::Apis::GmailV1::Draft] draft_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [IO, String] upload_source
# IO stream or filename containing content to upload
# @param [String] content_type
# Content type of the uploaded content.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Draft] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Draft]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:put, 'gmail/v1/users/{userId}/drafts/{id}', options)
else
command = make_upload_command(:put, 'gmail/v1/users/{userId}/drafts/{id}', options)
command.upload_source = upload_source
command.upload_content_type = content_type
end
command.request_representation = Google::Apis::GmailV1::Draft::Representation
command.request_object = draft_object
command.response_representation = Google::Apis::GmailV1::Draft::Representation
command.response_class = Google::Apis::GmailV1::Draft
command.params['userId'] = user_id unless user_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the history of all changes to the given mailbox. History results are
# returned in chronological order (increasing `historyId`).
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Array<String>, String] history_types
# History types to be returned by the function
# @param [String] label_id
# Only return messages with a label matching the ID.
# @param [Fixnum] max_results
# The maximum number of history records to return.
# @param [String] page_token
# Page token to retrieve a specific page of results in the list.
# @param [Fixnum] start_history_id
# Required. Returns history records after the specified
# `startHistoryId`. The supplied `startHistoryId`
# should be obtained from the `historyId` of a message, thread, or
# previous `list` response. History IDs increase
# chronologically but are not contiguous with random gaps in between valid
# IDs. Supplying an invalid or out of date `startHistoryId`
# typically returns an `HTTP 404` error code. A
# `historyId` is typically valid for at least a week, but in some
# rare circumstances may be valid for only a few hours. If you receive an
# `HTTP 404` error response, your application should perform a
# full sync. If you receive no `nextPageToken` in the response,
# there are no updates to retrieve and you can store the returned
# `historyId` for a future request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::ListHistoryResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::ListHistoryResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'gmail/v1/users/{userId}/history', options)
command.response_representation = Google::Apis::GmailV1::ListHistoryResponse::Representation
command.response_class = Google::Apis::GmailV1::ListHistoryResponse
command.params['userId'] = user_id unless user_id.nil?
command.query['historyTypes'] = history_types unless history_types.nil?
command.query['labelId'] = label_id unless label_id.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['startHistoryId'] = start_history_id unless start_history_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new label.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Google::Apis::GmailV1::Label] label_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Label] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Label]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'gmail/v1/users/{userId}/labels', options)
command.request_representation = Google::Apis::GmailV1::Label::Representation
command.request_object = label_object
command.response_representation = Google::Apis::GmailV1::Label::Representation
command.response_class = Google::Apis::GmailV1::Label
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Immediately and permanently deletes the specified label and removes it from
# any messages and threads that it is applied to.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the label to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'gmail/v1/users/{userId}/labels/{id}', options)
command.params['userId'] = user_id unless user_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the specified label.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the label to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Label] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Label]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'gmail/v1/users/{userId}/labels/{id}', options)
command.response_representation = Google::Apis::GmailV1::Label::Representation
command.response_class = Google::Apis::GmailV1::Label
command.params['userId'] = user_id unless user_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all labels in the user's mailbox.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::ListLabelsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::ListLabelsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_user_labels(user_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'gmail/v1/users/{userId}/labels', options)
command.response_representation = Google::Apis::GmailV1::ListLabelsResponse::Representation
command.response_class = Google::Apis::GmailV1::ListLabelsResponse
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Patch the specified label.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the label to update.
# @param [Google::Apis::GmailV1::Label] label_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Label] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Label]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'gmail/v1/users/{userId}/labels/{id}', options)
command.request_representation = Google::Apis::GmailV1::Label::Representation
command.request_object = label_object
command.response_representation = Google::Apis::GmailV1::Label::Representation
command.response_class = Google::Apis::GmailV1::Label
command.params['userId'] = user_id unless user_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the specified label.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the label to update.
# @param [Google::Apis::GmailV1::Label] label_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Label] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Label]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'gmail/v1/users/{userId}/labels/{id}', options)
command.request_representation = Google::Apis::GmailV1::Label::Representation
command.request_object = label_object
command.response_representation = Google::Apis::GmailV1::Label::Representation
command.response_class = Google::Apis::GmailV1::Label
command.params['userId'] = user_id unless user_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes many messages by message ID. Provides no guarantees that messages
# were not already deleted or even existed at all.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Google::Apis::GmailV1::BatchDeleteMessagesRequest] batch_delete_messages_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/batchDelete', options)
command.request_representation = Google::Apis::GmailV1::BatchDeleteMessagesRequest::Representation
command.request_object = batch_delete_messages_request_object
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Modifies the labels on the specified messages.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Google::Apis::GmailV1::BatchModifyMessagesRequest] batch_modify_messages_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/batchModify', options)
command.request_representation = Google::Apis::GmailV1::BatchModifyMessagesRequest::Representation
command.request_object = batch_modify_messages_request_object
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Immediately and permanently deletes the specified message. This operation
# cannot be undone. Prefer `messages.trash` instead.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the message to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'gmail/v1/users/{userId}/messages/{id}', options)
command.params['userId'] = user_id unless user_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the specified message.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the message to retrieve.
# @param [String] format
# The format to return the message in.
# @param [Array<String>, String] metadata_headers
# When given and format is METADATA, only include headers specified.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Message] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Message]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages/{id}', options)
command.response_representation = Google::Apis::GmailV1::Message::Representation
command.response_class = Google::Apis::GmailV1::Message
command.params['userId'] = user_id unless user_id.nil?
command.params['id'] = id unless id.nil?
command.query['format'] = format unless format.nil?
command.query['metadataHeaders'] = metadata_headers unless metadata_headers.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Imports a message into only this user's mailbox, with standard
# email delivery scanning and classification similar to receiving via SMTP.
# Does not send a message.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Google::Apis::GmailV1::Message] message_object
# @param [Boolean] deleted
# Mark the email as permanently deleted (not TRASH) and
# only visible in
# <a href="http://support.google.com/vault/">Google Vault</a> to
# a Vault administrator. Only used for G Suite accounts.
# @param [String] internal_date_source
# Source for Gmail's internal date of the message.
# @param [Boolean] never_mark_spam
# Ignore the Gmail spam classifier decision and never mark
# this email as SPAM in the mailbox.
# @param [Boolean] process_for_calendar
# Process calendar invites in the email and add any extracted
# meetings to the Google Calendar for this user.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [IO, String] upload_source
# IO stream or filename containing content to upload
# @param [String] content_type
# Content type of the uploaded content.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Message] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Message]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/import', options)
else
command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages/import', options)
command.upload_source = upload_source
command.upload_content_type = content_type
end
command.request_representation = Google::Apis::GmailV1::Message::Representation
command.request_object = message_object
command.response_representation = Google::Apis::GmailV1::Message::Representation
command.response_class = Google::Apis::GmailV1::Message
command.params['userId'] = user_id unless user_id.nil?
command.query['deleted'] = deleted unless deleted.nil?
command.query['internalDateSource'] = internal_date_source unless internal_date_source.nil?
command.query['neverMarkSpam'] = never_mark_spam unless never_mark_spam.nil?
command.query['processForCalendar'] = process_for_calendar unless process_for_calendar.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Directly inserts a message into only this user's mailbox similar to
# `IMAP APPEND`, bypassing most scanning and classification.
# Does not send a message.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Google::Apis::GmailV1::Message] message_object
# @param [Boolean] deleted
# Mark the email as permanently deleted (not TRASH) and
# only visible in
# <a href="http://support.google.com/vault/">Google Vault</a> to
# a Vault administrator. Only used for G Suite accounts.
# @param [String] internal_date_source
# Source for Gmail's internal date of the message.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [IO, String] upload_source
# IO stream or filename containing content to upload
# @param [String] content_type
# Content type of the uploaded content.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Message] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Message]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages', options)
else
command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages', options)
command.upload_source = upload_source
command.upload_content_type = content_type
end
command.request_representation = Google::Apis::GmailV1::Message::Representation
command.request_object = message_object
command.response_representation = Google::Apis::GmailV1::Message::Representation
command.response_class = Google::Apis::GmailV1::Message
command.params['userId'] = user_id unless user_id.nil?
command.query['deleted'] = deleted unless deleted.nil?
command.query['internalDateSource'] = internal_date_source unless internal_date_source.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the messages in the user's mailbox.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [Boolean] include_spam_trash
# Include messages from `SPAM` and `TRASH`
# in the results.
# @param [Array<String>, String] label_ids
# Only return messages with labels that match all of the specified label IDs.
# @param [Fixnum] max_results
# Maximum number of messages to return.
# @param [String] page_token
# Page token to retrieve a specific page of results in the list.
# @param [String] q
# Only return messages matching the specified query. Supports the same
# query format as the Gmail search box. For example,
# `"from:someuser@example.com rfc822msgid:<somemsgid@example.com>
# is:unread"`. Parameter cannot be used when accessing the api
# using the gmail.metadata scope.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::ListMessagesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::ListMessagesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages', options)
command.response_representation = Google::Apis::GmailV1::ListMessagesResponse::Representation
command.response_class = Google::Apis::GmailV1::ListMessagesResponse
command.params['userId'] = user_id unless user_id.nil?
command.query['includeSpamTrash'] = include_spam_trash unless include_spam_trash.nil?
command.query['labelIds'] = label_ids unless label_ids.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['q'] = q unless q.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Modifies the labels on the specified message.
# @param [String] user_id
# The user's email address. The special value `me`
# can be used to indicate the authenticated user.
# @param [String] id
# The ID of the message to modify.
# @param [Google::Apis::GmailV1::ModifyMessageRequest] modify_message_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::Message] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::Message]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/modify', options)
command.request_representation = Google::Apis::GmailV1::ModifyMessageRequest::Representation
command.request_object = modify_message_request_object
command.response_representation = Google::Apis::GmailV1::Message::Representation
command.response_class = Google::Apis::GmailV1::Message
command.params['userId'] = user_id unless user_id.nil?