Python
Libellés
`labels.list`, `list_all`, `iterate`, `list_colors`, `get`, `create`, `update` et `delete`.
Toutes les méthodes
from openemail import openemail page = openemail.labels.list(limit=50)every = openemail.labels.list_all()colors = openemail.labels.list_colors() created = openemail.labels.create({ 'name': 'Invoices', 'color': {'backgroundColor': 'gradient:sunset'},}) openemail.labels.update(created['id'], {'name': 'Invoices 2027'})openemail.labels.update(created['id'], {'color': {'backgroundColor': '#3B82F6'}})openemail.labels.delete(created['id'])list renvoie une Page de libellés triés par nom, et list_all et iterate parcourent toutes les pages. Chaque libellé porte sa couleur, threadCount et la date de sa création et de sa dernière modification. list_colors renvoie la palette de l'application, quatorze couleurs unies et sept dégradés, sous forme de simple liste. type vaut toujours user. L'identifiant est tiré du nom sous lequel le libellé a été créé, donc Invoices est USER_INVOICES, et il ne change jamais.
Un libellé appartient à l'espace de travail : un renommage, un changement de couleur ou une suppression le change pour chaque membre et chaque clé. threads.update pose et retire des libellés sur une conversation, et threads.list(folder='USER_INVOICES') liste toutes les conversations qui en portent un.
Paramètres : labels.create et labels.update
namestr- Le nom affiché du libellé, rogné avant d'être mesuré : la limite est donc de 1 à 225 caractères après rognage. Obligatoire sur `create` et optionnel sur `update`, où l'omettre garde le nom. Des espaces seuls donnent un 422. Un nom qu'un autre libellé porte déjà, comparé sans tenir compte de la casse, donne un 409 `label_name_taken`, et `create` refuse dès que l'espace de travail compte 50 libellés, avec un 422 `label_limit_reached`.
colorLabelColorInput | None- Optionnel sur les deux appels. L'omettre sur `update` garde la couleur stockée, et `None` l'efface. Le corps est strict : une clé approchante comme `colour` donne un 422 plutôt qu'une opération sans effet silencieuse.
color.backgroundColorstrobligatoire- Une couleur hexadécimale (`#RGB`, `#RGBA`, `#RRGGBB` ou `#RRGGBBAA`, stockée en majuscules) ou un jeton de dégradé : `gradient:sunset`, `gradient:ember`, `gradient:meadow`, `gradient:lagoon`, `gradient:aurora`, `gradient:berry` ou `gradient:midnight`. Une chaîne vide signifie aucune couleur, et tout le reste donne un 422 `invalid_parameter`.
color.textColorstr- Accepté et ignoré. L'encre est calculée à partir de `backgroundColor`, comme le fait l'app.
Réponse : LabelResource
objectLiteral['label']- Toujours la chaîne `label`. `create` et `update` renvoient ce même type, relu tel qu'il est stocké.
idstr- L'identifiant du libellé, et ce que prennent `get`, `update`, `delete` et `threads.update`. Il ne change jamais, même après un renommage.
namestr- Ce que voit l'utilisateur.
typestr- Toujours `user`. Les libellés système ne sont jamais servis ici, et un identifiant système sur `get` donne un 404.
colorLabelColor | None- `None` quand le libellé n'a pas de couleur.
color.backgroundColorstr- La couleur stockée : une valeur hexadécimale ou un jeton de dégradé. `list_colors` donne les deux extrémités d'un dégradé.
color.textColorstr- L'encre que l'app dessine sur la couleur, `#18181B` ou `#FFFFFF`, calculée sur le serveur plutôt que stockée.
threadCountint- Le nombre de conversations qui portent le libellé en ce moment. Pour une clé limitée à certaines adresses, seules comptent les conversations livrées à ces adresses.
createdAtstr | None- La date de création du libellé, en ISO 8601, ou `None` pour un libellé créé avant que ces dates ne soient enregistrées.
updatedAtstr | None- Le dernier renommage ou changement de couleur, en ISO 8601, ou `None` pour un libellé créé avant que ces dates ne soient enregistrées.
Réponse : LabelColorResource
kindLiteral['solid', 'gradient']- Si l'échantillon est une couleur unie ou un dégradé.
namestr- Le nom de l'échantillon, comme `red` ou `sunset`.
valuestr- Ce qu'il faut envoyer comme `color.backgroundColor` pour utiliser cet échantillon.
solidstr- Un unique hexadécimal pour les endroits où un dégradé ne peut pas être dessiné. Identique à `value` pour une couleur unie.
fromstr | None- Le point de départ d'un dégradé, dessiné à 135 degrés. `None` pour une couleur unie.
tostr | None- Le point d'arrivée d'un dégradé. `None` pour une couleur unie.
textColorstr- L'encre que l'app dessine sur cet échantillon.