Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / gmail_v1.users.html
blob: 03f01734cf07804d19e8096a1a97be2ff8af1010 [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">
98 <code><a href="gmail_v1.users.threads.html">threads()</a></code>
99</p>
100<p class="firstline">Returns the threads Resource.</p>
101
Craig Citro0bf61f22014-10-15 23:36:54 -0700[diff] [blame]102<p class="toc_element">
103 <code><a href="#getProfile">getProfile(userId)</a></code></p>
104<p class="firstline">Gets the current user's Gmail profile.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]105<p class="toc_element">
106 <code><a href="#stop">stop(userId)</a></code></p>
107<p class="firstline">Stop receiving push notifications for the given user mailbox.</p>
108<p class="toc_element">
109 <code><a href="#watch">watch(userId, body)</a></code></p>
110<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]111<h3>Method Details</h3>
112<div class="method">
113 <code class="details" id="getProfile">getProfile(userId)</code>
114 <pre>Gets the current user's Gmail profile.
115
116Args:
117 userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
118
119Returns:
120 An object of the form:
121
122 { # Profile for a Gmail user.
123 "threadsTotal": 42, # The total number of threads in the mailbox.
124 "emailAddress": "A String", # The user's email address.
125 "historyId": "A String", # The ID of the mailbox's current history record.
126 "messagesTotal": 42, # The total number of messages in the mailbox.
127 }</pre>
128</div>
129
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]130<div class="method">
131 <code class="details" id="stop">stop(userId)</code>
132 <pre>Stop receiving push notifications for the given user mailbox.
133
134Args:
135 userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
136</pre>
137</div>
138
139<div class="method">
140 <code class="details" id="watch">watch(userId, body)</code>
141 <pre>Set up or update a push notification watch on the given user mailbox.
142
143Args:
144 userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
145 body: object, The request body. (required)
146 The object takes the form of:
147
148{ # Set up or update a new push notification watch on this user's mailbox.
149 "labelIds": [ # List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.
150 "A String",
151 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]152 "topicName": "A String", # A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]153 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]154 # Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]155 "labelFilterAction": "A String", # Filtering behavior of labelIds list specified.
156 }
157
158
159Returns:
160 An object of the form:
161
162 { # Push notification watch response.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]163 "expiration": "A String", # When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]164 "historyId": "A String", # The ID of the mailbox's current history record.
165 }</pre>
166</div>
167
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]168</body></html>