Python
Labels
`labels.list`, `list_all`, `iterate`, `list_colors`, `get`, `create`, `update` und `delete`.
Jede Methode
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 gibt eine Page mit nach Namen sortierten Labels zurück, und list_all und iterate gehen jede Seite durch. Jedes Label trägt seine Farbe, threadCount und den Zeitpunkt, zu dem es angelegt und zuletzt geändert wurde. list_colors gibt die Palette der App zurück, vierzehn Volltonfarben und sieben Verläufe, als einfache Liste. type ist immer user. Die ID stammt aus dem Namen, unter dem das Label angelegt wurde, Invoices ist also USER_INVOICES, und sie ändert sich nie.
Ein Label gehört zum Workspace, eine Umbenennung, Umfärbung oder Löschung ändert es also für jedes Mitglied und jeden Key. threads.update setzt Labels auf eine Unterhaltung und nimmt sie wieder ab, und threads.list(folder='USER_INVOICES') listet jede Unterhaltung, die eines trägt.
Parameter: labels.create und labels.update
namestr- Der Anzeigename des Labels, vor dem Messen gekürzt, das Limit liegt also bei 1 bis 225 Zeichen nach dem Kürzen. Bei `create` erforderlich und bei `update` optional, wo Weglassen den Namen behält. Nur Leerraum ergibt 422. Ein Name, den schon ein anderes Label hat, ohne Beachtung der Groß- und Kleinschreibung verglichen, ergibt 409 `label_name_taken`, und `create` lehnt ab, sobald der Workspace 50 Labels hat, mit 422 `label_limit_reached`.
colorLabelColorInput | None- Bei beiden Aufrufen optional. Weglassen bei `update` behält die gespeicherte Farbe, und `None` löscht sie. Der Body ist strikt, ein knapp danebenliegender Schlüssel wie `colour` ergibt daher ein 422 und kein stilles Nichtstun.
color.backgroundColorstrerforderlich- Eine Hex-Farbe (`#RGB`, `#RGBA`, `#RRGGBB` oder `#RRGGBBAA`, in Großbuchstaben gespeichert) oder ein Verlaufs-Token: `gradient:sunset`, `gradient:ember`, `gradient:meadow`, `gradient:lagoon`, `gradient:aurora`, `gradient:berry` oder `gradient:midnight`. Ein leerer String bedeutet keine Farbe, alles andere ergibt 422 `invalid_parameter`.
color.textColorstr- Wird angenommen und ignoriert. Die Schriftfarbe wird aus `backgroundColor` berechnet, genauso wie in der App.
Antwort: LabelResource
objectLiteral['label']- Immer der String `label`. `create` und `update` geben denselben Typ zurück, so gelesen, wie er gespeichert ist.
idstr- Die ID des Labels, und was `get`, `update`, `delete` und `threads.update` nehmen. Sie ändert sich nie, auch nicht nach einer Umbenennung.
namestr- Was der Nutzer sieht.
typestr- Immer `user`. System-Labels werden hier nie ausgeliefert, und eine System-ID bei `get` ergibt 404.
colorLabelColor | None- `None`, wenn das Label keine Farbe hat.
color.backgroundColorstr- Die gespeicherte Farbe: ein Hex-Wert oder ein Verlaufs-Token. `list_colors` liefert die beiden Enden eines Verlaufs.
color.textColorstr- Die Schriftfarbe, die die App auf die Farbe zeichnet, `#18181B` oder `#FFFFFF`, auf dem Server berechnet statt gespeichert.
threadCountint- Wie viele Unterhaltungen das Label gerade tragen. Für einen auf bestimmte Adressen beschränkten Key zählen nur Unterhaltungen, die an diese zugestellt wurden.
createdAtstr | None- Wann das Label angelegt wurde, als ISO 8601, oder `None` bei einem Label, das angelegt wurde, bevor diese Zeiten erfasst wurden.
updatedAtstr | None- Die letzte Umbenennung oder Umfärbung, als ISO 8601, oder `None` bei einem Label, das angelegt wurde, bevor diese Zeiten erfasst wurden.
Antwort: LabelColorResource
kindLiteral['solid', 'gradient']- Ob das Farbfeld eine Farbe oder ein Verlauf ist.
namestr- Der Name des Farbfelds, etwa `red` oder `sunset`.
valuestr- Was als `color.backgroundColor` zu senden ist, um dieses Farbfeld zu verwenden.
solidstr- Ein einzelner Hex-Wert für Stellen, an denen kein Verlauf gezeichnet werden kann. Bei einer Volltonfarbe dasselbe wie `value`.
fromstr | None- Wo ein Verlauf beginnt, im Winkel von 135 Grad gezeichnet. `None` bei einer Volltonfarbe.
tostr | None- Wo ein Verlauf endet. `None` bei einer Volltonfarbe.
textColorstr- Die Schriftfarbe, die die App auf dieses Farbfeld zeichnet.