Users.labels

For a list of methods for this resource, see the end of this page.

Resource representations

Labels are used to categorize messages and threads within the user's mailbox.

{
  "id": string,
  "name": string,
  "messageListVisibility": string,
  "labelListVisibility": string,
  "type": string,
  "messagesTotal": integer,
  "messagesUnread": integer,
  "threadsTotal": integer,
  "threadsUnread": integer,
  "color": {
    "textColor": string,
    "backgroundColor": string
  }
}
Property name Value Description Notes
color nested object The color to assign to the label. Color is only available for labels that have their type set to user. writable
color.backgroundColor string The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed:
#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
writable
color.textColor string The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed:
#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c
writable
id string The immutable ID of the label.
labelListVisibility string The visibility of the label in the label list in the Gmail web interface.

Acceptable values are:
  • "labelHide": Do not show the label in the label list.
  • "labelShow": Show the label in the label list. (Default)
  • "labelShowIfUnread": Show the label if there are any unread messages with that label.
writable
messageListVisibility string The visibility of messages with this label in the message list in the Gmail web interface.

Acceptable values are:
  • "hide": Do not show the label in the message list.
  • "show": Show the label in the message list. (Default)
writable
messagesTotal integer The total number of messages with the label.
messagesUnread integer The number of unread messages with the label.
name string The display name of the label. writable
threadsTotal integer The total number of threads with the label.
threadsUnread integer The number of unread threads with the label.
type string The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.

Acceptable values are:
  • "system": Labels created by Gmail.
  • "user": Custom labels created by the user or application.

Methods

create
Creates a new label.
delete
Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.
get
Gets the specified label.
list
Lists all labels in the user's mailbox.
patch
Updates the specified label. This method supports patch semantics.
update
Updates the specified label.

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.