Debian Codegraph @

docs/dyn/gmail_v1.users.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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.settings.html">settings()</a></code>
99 </p>
100 <p class="firstline">Returns the settings Resource.</p>
101
102 <p class="toc_element">
103 <code><a href="gmail_v1.users.threads.html">threads()</a></code>
104 </p>
105 <p class="firstline">Returns the threads Resource.</p>
106
107 <p class="toc_element">
108 <code><a href="#close">close()</a></code></p>
109 <p class="firstline">Close httplib2 connections.</p>
110 <p class="toc_element">
111 <code><a href="#getProfile">getProfile(userId, x__xgafv=None)</a></code></p>
112 <p class="firstline">Gets the current user's Gmail profile.</p>
113 <p class="toc_element">
114 <code><a href="#stop">stop(userId, x__xgafv=None)</a></code></p>
115 <p class="firstline">Turn off push notification delivery for the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).</p>
116 <p class="toc_element">
117 <code><a href="#watch">watch(userId, body=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Set up or update a push notification watch on the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).</p>
119 <h3>Method Details</h3>
120 <div class="method">
121 <code class="details" id="close">close()</code>
122 <pre>Close httplib2 connections.</pre>
123 </div>
124
125 <div class="method">
126 <code class="details" id="getProfile">getProfile(userId, x__xgafv=None)</code>
127 <pre>Gets the current user&#x27;s Gmail profile.
128
129 Args:
130 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136 Returns:
137 An object of the form:
138
139 { # Profile for a Gmail user.
140 &quot;emailAddress&quot;: &quot;A String&quot;, # The user&#x27;s email address.
141 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the mailbox&#x27;s current history record.
142 &quot;messagesTotal&quot;: 42, # The total number of messages in the mailbox.
143 &quot;threadsTotal&quot;: 42, # The total number of threads in the mailbox.
144 }</pre>
145 </div>
146
147 <div class="method">
148 <code class="details" id="stop">stop(userId, x__xgafv=None)</code>
149 <pre>Turn off push notification delivery for the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).
150
151 Args:
152 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157 </pre>
158 </div>
159
160 <div class="method">
161 <code class="details" id="watch">watch(userId, body=None, x__xgafv=None)</code>
162 <pre>Set up or update a push notification watch on the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).
163
164 Args:
165 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
166 body: object, The request body.
167 The object takes the form of:
168
169 { # Set up or update a new push notification watch on this user&#x27;s mailbox.
170 &quot;labelFilterAction&quot;: &quot;A String&quot;, # Filtering behavior of `labelIds list` specified. This field is deprecated because it caused incorrect behavior in some cases; use `label_filter_behavior` instead.
171 &quot;labelFilterBehavior&quot;: &quot;A String&quot;, # Filtering behavior of `labelIds list` specified. This field replaces `label_filter_action`; if set, `label_filter_action` is ignored.
172 &quot;labelIds&quot;: [ # 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.
173 &quot;A String&quot;,
174 ],
175 &quot;topicName&quot;: &quot;A String&quot;, # 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 &quot;publish&quot; permission on it. For example, &quot;projects/my-project-identifier/topics/my-topic-name&quot; (using the Cloud Pub/Sub &quot;v1&quot; topic naming format). Note that the &quot;my-project-identifier&quot; portion must exactly match your Google developer project id (the one executing this watch request).
176 }
177
178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183 Returns:
184 An object of the form:
185
186 { # Push notification watch response.
187 &quot;expiration&quot;: &quot;A String&quot;, # When Gmail will stop sending notifications for mailbox updates (epoch millis). Call `watch` again before this time to renew the watch.
188 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the mailbox&#x27;s current history record.
189 }</pre>
190 </div>
191
192 </body></html>