Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / gmail_v1.users.html
blob: 882446bb61f4139741660803e2e73d91e15a95d1 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="gmail_v1.users.drafts.html">drafts()</a></code>
79</p>
80<p class="firstline">Returns the drafts Resource.</p>
81
82<p class="toc_element">
83 <code><a href="gmail_v1.users.history.html">history()</a></code>
84</p>
85<p class="firstline">Returns the history Resource.</p>
86
87<p class="toc_element">
88 <code><a href="gmail_v1.users.labels.html">labels()</a></code>
89</p>
90<p class="firstline">Returns the labels Resource.</p>
91
92<p class="toc_element">
93 <code><a href="gmail_v1.users.messages.html">messages()</a></code>
94</p>
95<p class="firstline">Returns the messages Resource.</p>
96
97<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]98 <code><a href="gmail_v1.users.settings.html">settings()</a></code>
99</p>
100<p class="firstline">Returns the settings Resource.</p>
101
102<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]103 <code><a href="gmail_v1.users.threads.html">threads()</a></code>
104</p>
105<p class="firstline">Returns the threads Resource.</p>
106
Craig Citro0bf61f22014-10-15 23:36:54 -0700[diff] [blame]107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code><a href="#getProfile">getProfile(userId, x__xgafv=None)</a></code></p>
Craig Citro0bf61f22014-10-15 23:36:54 -0700[diff] [blame]109<p class="firstline">Gets the current user's Gmail profile.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 <code><a href="#stop">stop(userId, x__xgafv=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]112<p class="firstline">Stop receiving push notifications for the given user mailbox.</p>
113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]114 <code><a href="#watch">watch(userId, body=None, x__xgafv=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]115<p class="firstline">Set up or update a push notification watch on the given user mailbox.</p>
Craig Citro0bf61f22014-10-15 23:36:54 -0700[diff] [blame]116<h3>Method Details</h3>
117<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 <code class="details" id="getProfile">getProfile(userId, x__xgafv=None)</code>
Craig Citro0bf61f22014-10-15 23:36:54 -0700[diff] [blame]119 <pre>Gets the current user's Gmail profile.
120
121Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 userId: string, The user's email address. The special value &lt;code&gt;me&lt;/code&gt;
123can be used to indicate the authenticated user. (required)
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
Craig Citro0bf61f22014-10-15 23:36:54 -0700[diff] [blame]128
129Returns:
130 An object of the form:
131
132 { # Profile for a Gmail user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 "messagesTotal": 42, # The total number of messages in the mailbox.
Craig Citro0bf61f22014-10-15 23:36:54 -0700[diff] [blame]134 "emailAddress": "A String", # The user's email address.
135 "historyId": "A String", # The ID of the mailbox's current history record.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 "threadsTotal": 42, # The total number of threads in the mailbox.
Craig Citro0bf61f22014-10-15 23:36:54 -0700[diff] [blame]137 }</pre>
138</div>
139
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]140<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141 <code class="details" id="stop">stop(userId, x__xgafv=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]142 <pre>Stop receiving push notifications for the given user mailbox.
143
144Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]145 userId: string, The user's email address. The special value &lt;code&gt;me&lt;/code&gt;
146can be used to indicate the authenticated user. (required)
147 x__xgafv: string, V1 error format.
148 Allowed values
149 1 - v1 error format
150 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]151</pre>
152</div>
153
154<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]155 <code class="details" id="watch">watch(userId, body=None, x__xgafv=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]156 <pre>Set up or update a push notification watch on the given user mailbox.
157
158Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]159 userId: string, The user's email address. The special value &lt;code&gt;me&lt;/code&gt;
160can be used to indicate the authenticated user. (required)
161 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]162 The object takes the form of:
163
164{ # Set up or update a new push notification watch on this user's mailbox.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]165 "labelIds": [ # List of label_ids to restrict notifications about. By default,
166 # if unspecified, all changes are pushed out. If specified then
167 # dictates which labels are required for a push notification to
168 # be generated.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]169 "A String",
170 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]171 "topicName": "A String", # A fully qualified Google Cloud Pub/Sub API topic name to publish the
172 # events to. This topic name **must** already exist in Cloud Pub/Sub and
173 # you **must** have already granted gmail "publish" permission on it.
174 # For example, "projects/my-project-identifier/topics/my-topic-name"
175 # (using the Cloud Pub/Sub "v1" topic naming format).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]176 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 # Note that the "my-project-identifier" portion must exactly match your
178 # Google developer project id (the one executing this watch request).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]179 "labelFilterAction": "A String", # Filtering behavior of labelIds list specified.
180 }
181
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]182 x__xgafv: string, V1 error format.
183 Allowed values
184 1 - v1 error format
185 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]186
187Returns:
188 An object of the form:
189
190 { # Push notification watch response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]191 "expiration": "A String", # When Gmail will stop sending notifications for mailbox updates
192 # (epoch millis). Call &lt;code&gt;watch&lt;/code&gt; again before this time to renew
193 # the watch.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]194 "historyId": "A String", # The ID of the mailbox's current history record.
195 }</pre>
196</div>
197
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]198</body></html>