Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 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"> |
Jon Wayne Parrott | 7d5badb | 2016-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 Citro | 065b530 | 2014-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 Citro | 0bf61f2 | 2014-10-15 23:36:54 -0700 | [diff] [blame] | 107 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 108 | <code><a href="#close">close()</a></code></p> |
| 109 | <p class="firstline">Close httplib2 connections.</p> |
| 110 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 111 | <code><a href="#getProfile">getProfile(userId, x__xgafv=None)</a></code></p> |
Craig Citro | 0bf61f2 | 2014-10-15 23:36:54 -0700 | [diff] [blame] | 112 | <p class="firstline">Gets the current user's Gmail profile.</p> |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 113 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 114 | <code><a href="#stop">stop(userId, x__xgafv=None)</a></code></p> |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 115 | <p class="firstline">Stop receiving push notifications for the given user mailbox.</p> |
| 116 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 117 | <code><a href="#watch">watch(userId, body=None, x__xgafv=None)</a></code></p> |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 118 | <p class="firstline">Set up or update a push notification watch on the given user mailbox.</p> |
Craig Citro | 0bf61f2 | 2014-10-15 23:36:54 -0700 | [diff] [blame] | 119 | <h3>Method Details</h3> |
| 120 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 121 | <code class="details" id="close">close()</code> |
| 122 | <pre>Close httplib2 connections.</pre> |
| 123 | </div> |
| 124 | |
| 125 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 126 | <code class="details" id="getProfile">getProfile(userId, x__xgafv=None)</code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 127 | <pre>Gets the current user's Gmail profile. |
Craig Citro | 0bf61f2 | 2014-10-15 23:36:54 -0700 | [diff] [blame] | 128 | |
| 129 | Args: |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 130 | userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required) |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 131 | x__xgafv: string, V1 error format. |
| 132 | Allowed values |
| 133 | 1 - v1 error format |
| 134 | 2 - v2 error format |
Craig Citro | 0bf61f2 | 2014-10-15 23:36:54 -0700 | [diff] [blame] | 135 | |
| 136 | Returns: |
| 137 | An object of the form: |
| 138 | |
| 139 | { # Profile for a Gmail user. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 140 | "emailAddress": "A String", # The user's email address. |
| 141 | "historyId": "A String", # The ID of the mailbox's current history record. |
| 142 | "messagesTotal": 42, # The total number of messages in the mailbox. |
| 143 | "threadsTotal": 42, # The total number of threads in the mailbox. |
| 144 | }</pre> |
Craig Citro | 0bf61f2 | 2014-10-15 23:36:54 -0700 | [diff] [blame] | 145 | </div> |
| 146 | |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 147 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 148 | <code class="details" id="stop">stop(userId, x__xgafv=None)</code> |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 149 | <pre>Stop receiving push notifications for the given user mailbox. |
| 150 | |
| 151 | Args: |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 152 | userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required) |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 153 | x__xgafv: string, V1 error format. |
| 154 | Allowed values |
| 155 | 1 - v1 error format |
| 156 | 2 - v2 error format |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 157 | </pre> |
| 158 | </div> |
| 159 | |
| 160 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 161 | <code class="details" id="watch">watch(userId, body=None, x__xgafv=None)</code> |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 162 | <pre>Set up or update a push notification watch on the given user mailbox. |
| 163 | |
| 164 | Args: |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 165 | userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 166 | body: object, The request body. |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 167 | The object takes the form of: |
| 168 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 169 | { # Set up or update a new push notification watch on this user's mailbox. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 170 | "labelFilterAction": "A String", # Filtering behavior of labelIds list specified. |
| 171 | "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. |
| 172 | "A String", |
| 173 | ], |
| 174 | "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). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request). |
| 175 | } |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 176 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 177 | x__xgafv: string, V1 error format. |
| 178 | Allowed values |
| 179 | 1 - v1 error format |
| 180 | 2 - v2 error format |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 181 | |
| 182 | Returns: |
| 183 | An object of the form: |
| 184 | |
| 185 | { # Push notification watch response. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 186 | "expiration": "A String", # When Gmail will stop sending notifications for mailbox updates (epoch millis). Call `watch` again before this time to renew the watch. |
| 187 | "historyId": "A String", # The ID of the mailbox's current history record. |
| 188 | }</pre> |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 189 | </div> |
| 190 | |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 191 | </body></html> |