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