• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.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="#getProfile">getProfile(userId)</a></code></p>
109<p class="firstline">Gets the current user's Gmail profile.</p>
110<p class="toc_element">
111  <code><a href="#stop">stop(userId)</a></code></p>
112<p class="firstline">Stop receiving push notifications for the given user mailbox.</p>
113<p class="toc_element">
114  <code><a href="#watch">watch(userId, body)</a></code></p>
115<p class="firstline">Set up or update a push notification watch on the given user mailbox.</p>
116<h3>Method Details</h3>
117<div class="method">
118    <code class="details" id="getProfile">getProfile(userId)</code>
119  <pre>Gets the current user's Gmail profile.
120
121Args:
122  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
123
124Returns:
125  An object of the form:
126
127    { # Profile for a Gmail user.
128    "threadsTotal": 42, # The total number of threads in the mailbox.
129    "emailAddress": "A String", # The user's email address.
130    "historyId": "A String", # The ID of the mailbox's current history record.
131    "messagesTotal": 42, # The total number of messages in the mailbox.
132  }</pre>
133</div>
134
135<div class="method">
136    <code class="details" id="stop">stop(userId)</code>
137  <pre>Stop receiving push notifications for the given user mailbox.
138
139Args:
140  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
141</pre>
142</div>
143
144<div class="method">
145    <code class="details" id="watch">watch(userId, body)</code>
146  <pre>Set up or update a push notification watch on the given user mailbox.
147
148Args:
149  userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
150  body: object, The request body. (required)
151    The object takes the form of:
152
153{ # Set up or update a new push notification watch on this user's mailbox.
154    "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.
155      "A String",
156    ],
157    "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).
158        #
159        # Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).
160    "labelFilterAction": "A String", # Filtering behavior of labelIds list specified.
161  }
162
163
164Returns:
165  An object of the form:
166
167    { # Push notification watch response.
168    "expiration": "A String", # When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch.
169    "historyId": "A String", # The ID of the mailbox's current history record.
170  }</pre>
171</div>
172
173</body></html>