Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / gmail_v1.users.labels.html
blob: 2f22436c147130be63d38f8220028e442c9c22d2 [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> . <a href="gmail_v1.users.labels.html">labels</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(userId, body=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]79<p class="firstline">Creates a new label.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#delete">delete(userId, id, x__xgafv=None)</a></code></p>
82<p class="firstline">Immediately and permanently deletes the specified label and removes it from</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#get">get(userId, id, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]85<p class="firstline">Gets the specified label.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#list">list(userId, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]88<p class="firstline">Lists all labels in the user's mailbox.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#patch">patch(userId, id, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Patch the specified label.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#update">update(userId, id, body=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]94<p class="firstline">Updates the specified label.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]97 <code class="details" id="create">create(userId, body=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]98 <pre>Creates a new label.
99
100Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]101 userId: string, The user's email address. The special value &lt;code&gt;me&lt;/code&gt;
102can be used to indicate the authenticated user. (required)
103 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]104 The object takes the form of:
105
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]106{ # Labels are used to categorize messages and threads within the
107 # user's mailbox.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]108 "name": "A String", # The display name of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]110 "messagesTotal": 42, # The total number of messages with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 "color": { # The color to assign to the label. Color is only available for labels that
112 # have their &lt;code&gt;type&lt;/code&gt; set to &lt;code&gt;user&lt;/code&gt;.
113 # @mutable gmail.users.labels.create gmail.users.labels.update
114 "textColor": "A String", # The text color of the label, represented as hex string.
115 # This field is required in order to set the color of a label.
116 # Only the following predefined set of color values are allowed:
117 # &lt;br/&gt;
118 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
119 #
120 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
121 #
122 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
123 #
124 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
125 #
126 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
127 #
128 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
129 #
130 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
131 #
132 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
133 #
134 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
135 #
136 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
137 #
138 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
139 #
140 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
141 #
142 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
143 #
144 # @mutable gmail.users.labels.create gmail.users.labels.update
145 "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
146 # This field is required in order to set the color of a label.
147 # Only the following predefined set of color values are allowed:
148 # &lt;br/&gt;
149 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
150 #
151 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
152 #
153 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
154 #
155 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
156 #
157 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
158 #
159 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
160 #
161 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
162 #
163 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
164 #
165 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
166 #
167 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
168 #
169 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
170 #
171 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
172 #
173 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
174 #
175 # @mutable gmail.users.labels.create gmail.users.labels.update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 "type": "A String", # The owner type for the label. User labels are created by the user and
178 # can be modified and deleted by the user and can be applied to any
179 # message or thread. System labels are internally created and cannot be
180 # added, modified, or deleted. System labels may be able to be applied to or
181 # removed from messages and threads under some circumstances but this is
182 # not guaranteed. For example, users can apply and remove the
183 # &lt;code&gt;INBOX&lt;/code&gt; and &lt;code&gt;UNREAD&lt;/code&gt; labels from messages and
184 # threads, but cannot apply or remove the &lt;code&gt;DRAFTS&lt;/code&gt; or
185 # &lt;code&gt;SENT&lt;/code&gt; labels from messages or threads.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]186 "threadsTotal": 42, # The total number of threads with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]187 "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
188 # @mutable gmail.users.labels.create gmail.users.labels.update
189 "threadsUnread": 42, # The number of unread threads with the label.
190 "messageListVisibility": "A String", # The visibility of the label in the message list in the
191 # Gmail web interface.
192 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]193 "id": "A String", # The immutable ID of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]194 "messagesUnread": 42, # The number of unread messages with the label.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]195}
196
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]201
202Returns:
203 An object of the form:
204
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 { # Labels are used to categorize messages and threads within the
206 # user's mailbox.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]207 "name": "A String", # The display name of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]208 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]209 "messagesTotal": 42, # The total number of messages with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]210 "color": { # The color to assign to the label. Color is only available for labels that
211 # have their &lt;code&gt;type&lt;/code&gt; set to &lt;code&gt;user&lt;/code&gt;.
212 # @mutable gmail.users.labels.create gmail.users.labels.update
213 "textColor": "A String", # The text color of the label, represented as hex string.
214 # This field is required in order to set the color of a label.
215 # Only the following predefined set of color values are allowed:
216 # &lt;br/&gt;
217 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
218 #
219 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
220 #
221 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
222 #
223 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
224 #
225 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
226 #
227 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
228 #
229 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
230 #
231 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
232 #
233 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
234 #
235 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
236 #
237 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
238 #
239 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
240 #
241 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
242 #
243 # @mutable gmail.users.labels.create gmail.users.labels.update
244 "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
245 # This field is required in order to set the color of a label.
246 # Only the following predefined set of color values are allowed:
247 # &lt;br/&gt;
248 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
249 #
250 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
251 #
252 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
253 #
254 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
255 #
256 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
257 #
258 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
259 #
260 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
261 #
262 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
263 #
264 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
265 #
266 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
267 #
268 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
269 #
270 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
271 #
272 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
273 #
274 # @mutable gmail.users.labels.create gmail.users.labels.update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 "type": "A String", # The owner type for the label. User labels are created by the user and
277 # can be modified and deleted by the user and can be applied to any
278 # message or thread. System labels are internally created and cannot be
279 # added, modified, or deleted. System labels may be able to be applied to or
280 # removed from messages and threads under some circumstances but this is
281 # not guaranteed. For example, users can apply and remove the
282 # &lt;code&gt;INBOX&lt;/code&gt; and &lt;code&gt;UNREAD&lt;/code&gt; labels from messages and
283 # threads, but cannot apply or remove the &lt;code&gt;DRAFTS&lt;/code&gt; or
284 # &lt;code&gt;SENT&lt;/code&gt; labels from messages or threads.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]285 "threadsTotal": 42, # The total number of threads with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]286 "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
287 # @mutable gmail.users.labels.create gmail.users.labels.update
288 "threadsUnread": 42, # The number of unread threads with the label.
289 "messageListVisibility": "A String", # The visibility of the label in the message list in the
290 # Gmail web interface.
291 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]292 "id": "A String", # The immutable ID of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]293 "messagesUnread": 42, # The number of unread messages with the label.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]294 }</pre>
295</div>
296
297<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]298 <code class="details" id="delete">delete(userId, id, x__xgafv=None)</code>
299 <pre>Immediately and permanently deletes the specified label and removes it from
300any messages and threads that it is applied to.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]301
302Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]303 userId: string, The user's email address. The special value &lt;code&gt;me&lt;/code&gt;
304can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]305 id: string, The ID of the label to delete. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306 x__xgafv: string, V1 error format.
307 Allowed values
308 1 - v1 error format
309 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]310</pre>
311</div>
312
313<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]314 <code class="details" id="get">get(userId, id, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]315 <pre>Gets the specified label.
316
317Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]318 userId: string, The user's email address. The special value &lt;code&gt;me&lt;/code&gt;
319can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]320 id: string, The ID of the label to retrieve. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]321 x__xgafv: string, V1 error format.
322 Allowed values
323 1 - v1 error format
324 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]325
326Returns:
327 An object of the form:
328
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]329 { # Labels are used to categorize messages and threads within the
330 # user's mailbox.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]331 "name": "A String", # The display name of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]332 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]333 "messagesTotal": 42, # The total number of messages with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]334 "color": { # The color to assign to the label. Color is only available for labels that
335 # have their &lt;code&gt;type&lt;/code&gt; set to &lt;code&gt;user&lt;/code&gt;.
336 # @mutable gmail.users.labels.create gmail.users.labels.update
337 "textColor": "A String", # The text color of the label, represented as hex string.
338 # This field is required in order to set the color of a label.
339 # Only the following predefined set of color values are allowed:
340 # &lt;br/&gt;
341 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
342 #
343 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
344 #
345 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
346 #
347 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
348 #
349 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
350 #
351 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
352 #
353 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
354 #
355 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
356 #
357 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
358 #
359 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
360 #
361 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
362 #
363 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
364 #
365 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
366 #
367 # @mutable gmail.users.labels.create gmail.users.labels.update
368 "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
369 # This field is required in order to set the color of a label.
370 # Only the following predefined set of color values are allowed:
371 # &lt;br/&gt;
372 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
373 #
374 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
375 #
376 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
377 #
378 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
379 #
380 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
381 #
382 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
383 #
384 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
385 #
386 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
387 #
388 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
389 #
390 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
391 #
392 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
393 #
394 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
395 #
396 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
397 #
398 # @mutable gmail.users.labels.create gmail.users.labels.update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]400 "type": "A String", # The owner type for the label. User labels are created by the user and
401 # can be modified and deleted by the user and can be applied to any
402 # message or thread. System labels are internally created and cannot be
403 # added, modified, or deleted. System labels may be able to be applied to or
404 # removed from messages and threads under some circumstances but this is
405 # not guaranteed. For example, users can apply and remove the
406 # &lt;code&gt;INBOX&lt;/code&gt; and &lt;code&gt;UNREAD&lt;/code&gt; labels from messages and
407 # threads, but cannot apply or remove the &lt;code&gt;DRAFTS&lt;/code&gt; or
408 # &lt;code&gt;SENT&lt;/code&gt; labels from messages or threads.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]409 "threadsTotal": 42, # The total number of threads with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]410 "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
411 # @mutable gmail.users.labels.create gmail.users.labels.update
412 "threadsUnread": 42, # The number of unread threads with the label.
413 "messageListVisibility": "A String", # The visibility of the label in the message list in the
414 # Gmail web interface.
415 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]416 "id": "A String", # The immutable ID of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 "messagesUnread": 42, # The number of unread messages with the label.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]418 }</pre>
419</div>
420
421<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]422 <code class="details" id="list">list(userId, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]423 <pre>Lists all labels in the user's mailbox.
424
425Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]426 userId: string, The user's email address. The special value &lt;code&gt;me&lt;/code&gt;
427can be used to indicate the authenticated user. (required)
428 x__xgafv: string, V1 error format.
429 Allowed values
430 1 - v1 error format
431 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]432
433Returns:
434 An object of the form:
435
436 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]437 "labels": [ # List of labels. Note that each label resource only contains an
438 # &lt;code&gt;id&lt;/code&gt;, &lt;code&gt;name&lt;/code&gt;, &lt;code&gt;messageListVisibility&lt;/code&gt;,
439 # &lt;code&gt;labelListVisibility&lt;/code&gt;, and &lt;code&gt;type&lt;/code&gt;. The
440 # &lt;a href="/gmail/api/v1/reference/users/labels/get"&gt;labels.get&lt;/a&gt; method
441 # can fetch additional label details.
442 { # Labels are used to categorize messages and threads within the
443 # user's mailbox.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]444 "name": "A String", # The display name of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]445 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]446 "messagesTotal": 42, # The total number of messages with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]447 "color": { # The color to assign to the label. Color is only available for labels that
448 # have their &lt;code&gt;type&lt;/code&gt; set to &lt;code&gt;user&lt;/code&gt;.
449 # @mutable gmail.users.labels.create gmail.users.labels.update
450 "textColor": "A String", # The text color of the label, represented as hex string.
451 # This field is required in order to set the color of a label.
452 # Only the following predefined set of color values are allowed:
453 # &lt;br/&gt;
454 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
455 #
456 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
457 #
458 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
459 #
460 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
461 #
462 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
463 #
464 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
465 #
466 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
467 #
468 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
469 #
470 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
471 #
472 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
473 #
474 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
475 #
476 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
477 #
478 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
479 #
480 # @mutable gmail.users.labels.create gmail.users.labels.update
481 "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
482 # This field is required in order to set the color of a label.
483 # Only the following predefined set of color values are allowed:
484 # &lt;br/&gt;
485 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
486 #
487 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
488 #
489 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
490 #
491 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
492 #
493 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
494 #
495 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
496 #
497 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
498 #
499 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
500 #
501 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
502 #
503 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
504 #
505 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
506 #
507 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
508 #
509 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
510 #
511 # @mutable gmail.users.labels.create gmail.users.labels.update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]512 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]513 "type": "A String", # The owner type for the label. User labels are created by the user and
514 # can be modified and deleted by the user and can be applied to any
515 # message or thread. System labels are internally created and cannot be
516 # added, modified, or deleted. System labels may be able to be applied to or
517 # removed from messages and threads under some circumstances but this is
518 # not guaranteed. For example, users can apply and remove the
519 # &lt;code&gt;INBOX&lt;/code&gt; and &lt;code&gt;UNREAD&lt;/code&gt; labels from messages and
520 # threads, but cannot apply or remove the &lt;code&gt;DRAFTS&lt;/code&gt; or
521 # &lt;code&gt;SENT&lt;/code&gt; labels from messages or threads.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]522 "threadsTotal": 42, # The total number of threads with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]523 "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
524 # @mutable gmail.users.labels.create gmail.users.labels.update
525 "threadsUnread": 42, # The number of unread threads with the label.
526 "messageListVisibility": "A String", # The visibility of the label in the message list in the
527 # Gmail web interface.
528 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]529 "id": "A String", # The immutable ID of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]530 "messagesUnread": 42, # The number of unread messages with the label.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]531 },
532 ],
533 }</pre>
534</div>
535
536<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]537 <code class="details" id="patch">patch(userId, id, body=None, x__xgafv=None)</code>
538 <pre>Patch the specified label.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]539
540Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]541 userId: string, The user's email address. The special value &lt;code&gt;me&lt;/code&gt;
542can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]543 id: string, The ID of the label to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]544 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]545 The object takes the form of:
546
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]547{ # Labels are used to categorize messages and threads within the
548 # user's mailbox.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]549 "name": "A String", # The display name of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]550 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]551 "messagesTotal": 42, # The total number of messages with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]552 "color": { # The color to assign to the label. Color is only available for labels that
553 # have their &lt;code&gt;type&lt;/code&gt; set to &lt;code&gt;user&lt;/code&gt;.
554 # @mutable gmail.users.labels.create gmail.users.labels.update
555 "textColor": "A String", # The text color of the label, represented as hex string.
556 # This field is required in order to set the color of a label.
557 # Only the following predefined set of color values are allowed:
558 # &lt;br/&gt;
559 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
560 #
561 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
562 #
563 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
564 #
565 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
566 #
567 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
568 #
569 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
570 #
571 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
572 #
573 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
574 #
575 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
576 #
577 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
578 #
579 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
580 #
581 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
582 #
583 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
584 #
585 # @mutable gmail.users.labels.create gmail.users.labels.update
586 "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
587 # This field is required in order to set the color of a label.
588 # Only the following predefined set of color values are allowed:
589 # &lt;br/&gt;
590 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
591 #
592 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
593 #
594 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
595 #
596 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
597 #
598 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
599 #
600 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
601 #
602 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
603 #
604 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
605 #
606 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
607 #
608 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
609 #
610 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
611 #
612 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
613 #
614 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
615 #
616 # @mutable gmail.users.labels.create gmail.users.labels.update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]617 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]618 "type": "A String", # The owner type for the label. User labels are created by the user and
619 # can be modified and deleted by the user and can be applied to any
620 # message or thread. System labels are internally created and cannot be
621 # added, modified, or deleted. System labels may be able to be applied to or
622 # removed from messages and threads under some circumstances but this is
623 # not guaranteed. For example, users can apply and remove the
624 # &lt;code&gt;INBOX&lt;/code&gt; and &lt;code&gt;UNREAD&lt;/code&gt; labels from messages and
625 # threads, but cannot apply or remove the &lt;code&gt;DRAFTS&lt;/code&gt; or
626 # &lt;code&gt;SENT&lt;/code&gt; labels from messages or threads.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]627 "threadsTotal": 42, # The total number of threads with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]628 "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
629 # @mutable gmail.users.labels.create gmail.users.labels.update
630 "threadsUnread": 42, # The number of unread threads with the label.
631 "messageListVisibility": "A String", # The visibility of the label in the message list in the
632 # Gmail web interface.
633 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]634 "id": "A String", # The immutable ID of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]635 "messagesUnread": 42, # The number of unread messages with the label.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]636}
637
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]638 x__xgafv: string, V1 error format.
639 Allowed values
640 1 - v1 error format
641 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]642
643Returns:
644 An object of the form:
645
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]646 { # Labels are used to categorize messages and threads within the
647 # user's mailbox.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]648 "name": "A String", # The display name of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]649 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]650 "messagesTotal": 42, # The total number of messages with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]651 "color": { # The color to assign to the label. Color is only available for labels that
652 # have their &lt;code&gt;type&lt;/code&gt; set to &lt;code&gt;user&lt;/code&gt;.
653 # @mutable gmail.users.labels.create gmail.users.labels.update
654 "textColor": "A String", # The text color of the label, represented as hex string.
655 # This field is required in order to set the color of a label.
656 # Only the following predefined set of color values are allowed:
657 # &lt;br/&gt;
658 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
659 #
660 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
661 #
662 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
663 #
664 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
665 #
666 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
667 #
668 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
669 #
670 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
671 #
672 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
673 #
674 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
675 #
676 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
677 #
678 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
679 #
680 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
681 #
682 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
683 #
684 # @mutable gmail.users.labels.create gmail.users.labels.update
685 "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
686 # This field is required in order to set the color of a label.
687 # Only the following predefined set of color values are allowed:
688 # &lt;br/&gt;
689 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
690 #
691 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
692 #
693 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
694 #
695 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
696 #
697 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
698 #
699 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
700 #
701 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
702 #
703 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
704 #
705 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
706 #
707 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
708 #
709 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
710 #
711 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
712 #
713 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
714 #
715 # @mutable gmail.users.labels.create gmail.users.labels.update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]716 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]717 "type": "A String", # The owner type for the label. User labels are created by the user and
718 # can be modified and deleted by the user and can be applied to any
719 # message or thread. System labels are internally created and cannot be
720 # added, modified, or deleted. System labels may be able to be applied to or
721 # removed from messages and threads under some circumstances but this is
722 # not guaranteed. For example, users can apply and remove the
723 # &lt;code&gt;INBOX&lt;/code&gt; and &lt;code&gt;UNREAD&lt;/code&gt; labels from messages and
724 # threads, but cannot apply or remove the &lt;code&gt;DRAFTS&lt;/code&gt; or
725 # &lt;code&gt;SENT&lt;/code&gt; labels from messages or threads.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]726 "threadsTotal": 42, # The total number of threads with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]727 "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
728 # @mutable gmail.users.labels.create gmail.users.labels.update
729 "threadsUnread": 42, # The number of unread threads with the label.
730 "messageListVisibility": "A String", # The visibility of the label in the message list in the
731 # Gmail web interface.
732 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]733 "id": "A String", # The immutable ID of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]734 "messagesUnread": 42, # The number of unread messages with the label.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]735 }</pre>
736</div>
737
738<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]739 <code class="details" id="update">update(userId, id, body=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]740 <pre>Updates the specified label.
741
742Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]743 userId: string, The user's email address. The special value &lt;code&gt;me&lt;/code&gt;
744can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]745 id: string, The ID of the label to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]746 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]747 The object takes the form of:
748
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]749{ # Labels are used to categorize messages and threads within the
750 # user's mailbox.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]751 "name": "A String", # The display name of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]752 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]753 "messagesTotal": 42, # The total number of messages with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]754 "color": { # The color to assign to the label. Color is only available for labels that
755 # have their &lt;code&gt;type&lt;/code&gt; set to &lt;code&gt;user&lt;/code&gt;.
756 # @mutable gmail.users.labels.create gmail.users.labels.update
757 "textColor": "A String", # The text color of the label, represented as hex string.
758 # This field is required in order to set the color of a label.
759 # Only the following predefined set of color values are allowed:
760 # &lt;br/&gt;
761 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
762 #
763 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
764 #
765 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
766 #
767 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
768 #
769 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
770 #
771 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
772 #
773 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
774 #
775 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
776 #
777 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
778 #
779 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
780 #
781 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
782 #
783 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
784 #
785 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
786 #
787 # @mutable gmail.users.labels.create gmail.users.labels.update
788 "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
789 # This field is required in order to set the color of a label.
790 # Only the following predefined set of color values are allowed:
791 # &lt;br/&gt;
792 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
793 #
794 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
795 #
796 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
797 #
798 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
799 #
800 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
801 #
802 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
803 #
804 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
805 #
806 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
807 #
808 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
809 #
810 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
811 #
812 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
813 #
814 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
815 #
816 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
817 #
818 # @mutable gmail.users.labels.create gmail.users.labels.update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]819 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]820 "type": "A String", # The owner type for the label. User labels are created by the user and
821 # can be modified and deleted by the user and can be applied to any
822 # message or thread. System labels are internally created and cannot be
823 # added, modified, or deleted. System labels may be able to be applied to or
824 # removed from messages and threads under some circumstances but this is
825 # not guaranteed. For example, users can apply and remove the
826 # &lt;code&gt;INBOX&lt;/code&gt; and &lt;code&gt;UNREAD&lt;/code&gt; labels from messages and
827 # threads, but cannot apply or remove the &lt;code&gt;DRAFTS&lt;/code&gt; or
828 # &lt;code&gt;SENT&lt;/code&gt; labels from messages or threads.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]829 "threadsTotal": 42, # The total number of threads with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]830 "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
831 # @mutable gmail.users.labels.create gmail.users.labels.update
832 "threadsUnread": 42, # The number of unread threads with the label.
833 "messageListVisibility": "A String", # The visibility of the label in the message list in the
834 # Gmail web interface.
835 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]836 "id": "A String", # The immutable ID of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]837 "messagesUnread": 42, # The number of unread messages with the label.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]838}
839
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]840 x__xgafv: string, V1 error format.
841 Allowed values
842 1 - v1 error format
843 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]844
845Returns:
846 An object of the form:
847
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]848 { # Labels are used to categorize messages and threads within the
849 # user's mailbox.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]850 "name": "A String", # The display name of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]851 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]852 "messagesTotal": 42, # The total number of messages with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]853 "color": { # The color to assign to the label. Color is only available for labels that
854 # have their &lt;code&gt;type&lt;/code&gt; set to &lt;code&gt;user&lt;/code&gt;.
855 # @mutable gmail.users.labels.create gmail.users.labels.update
856 "textColor": "A String", # The text color of the label, represented as hex string.
857 # This field is required in order to set the color of a label.
858 # Only the following predefined set of color values are allowed:
859 # &lt;br/&gt;
860 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
861 #
862 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
863 #
864 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
865 #
866 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
867 #
868 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
869 #
870 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
871 #
872 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
873 #
874 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
875 #
876 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
877 #
878 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
879 #
880 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
881 #
882 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
883 #
884 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
885 #
886 # @mutable gmail.users.labels.create gmail.users.labels.update
887 "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000).
888 # This field is required in order to set the color of a label.
889 # Only the following predefined set of color values are allowed:
890 # &lt;br/&gt;
891 # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff,
892 #
893 # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3,
894 #
895 # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8,
896 #
897 # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9,
898 #
899 # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0,
900 #
901 # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798,
902 #
903 # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775,
904 #
905 # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
906 #
907 # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff,
908 #
909 # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5,
910 #
911 # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1,
912 #
913 # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
914 #
915 # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
916 #
917 # @mutable gmail.users.labels.create gmail.users.labels.update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]918 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]919 "type": "A String", # The owner type for the label. User labels are created by the user and
920 # can be modified and deleted by the user and can be applied to any
921 # message or thread. System labels are internally created and cannot be
922 # added, modified, or deleted. System labels may be able to be applied to or
923 # removed from messages and threads under some circumstances but this is
924 # not guaranteed. For example, users can apply and remove the
925 # &lt;code&gt;INBOX&lt;/code&gt; and &lt;code&gt;UNREAD&lt;/code&gt; labels from messages and
926 # threads, but cannot apply or remove the &lt;code&gt;DRAFTS&lt;/code&gt; or
927 # &lt;code&gt;SENT&lt;/code&gt; labels from messages or threads.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]928 "threadsTotal": 42, # The total number of threads with the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]929 "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface.
930 # @mutable gmail.users.labels.create gmail.users.labels.update
931 "threadsUnread": 42, # The number of unread threads with the label.
932 "messageListVisibility": "A String", # The visibility of the label in the message list in the
933 # Gmail web interface.
934 # @mutable gmail.users.labels.create gmail.users.labels.update
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]935 "id": "A String", # The immutable ID of the label.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]936 "messagesUnread": 42, # The number of unread messages with the label.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]937 }</pre>
938</div>
939
940</body></html>