SDK

Labels

`labels.list`, `get`, `create`, `update` und `delete`.

Alle Methoden

usage.ts

const labels = await openemail.labels.list()const label = await openemail.labels.get('USER_INVOICES') const created = await openemail.labels.create({  name: 'Invoices',  color: { backgroundColor: '#e8eaed', textColor: '#3c4043' },}) await openemail.labels.update(created.id!, { name: 'Invoices 2027' })await openemail.labels.delete(created.id!)

list löst zu einem einfachen array auf, da Labels nicht paginiert werden. color wird bei Lesezugriffen zurückgegeben statt verworfen, damit ein Client ein Label so darstellen kann, wie der Benutzer es sieht. type ist immer user, es gibt also nichts, worüber zu verzweigen wäre. Ids werden aus dem Namen abgeleitet, Invoices wird daher zu USER_INVOICES.

Parameter: labels.create und labels.update

namestringerforderlich: Der Anzeigename des Labels, vor der Messung getrimmt, das Limit beträgt daher 1 bis 225 Zeichen nach dem Trimmen. Nur Leerraum ergibt ein 422 statt einer namenlosen Zeile mit einem Farbpunkt und nichts zu lesen oder anzuklicken. `create` lehnt zusätzlich ab, sobald das Postfach bereits 50 Benutzerlabels enthält, mit einem 422 `label_limit_reached`, das `name` nennt.
colorLabelColor: Bei beiden Aufrufen optional, und es bei `update` wegzulassen lässt die gespeicherte Farbe unverändert, statt sie zu löschen. Der Body ist strikt, ein knapp danebenliegender Schlüssel wie `colour` ergibt daher ein 422 und kein stilles Nichtstun.
color.backgroundColorstringerforderlich: Erforderlich, sobald `color` angegeben ist, und höchstens 32 Zeichen. Im nativen Postfach ist dies die einzige Hälfte, die aufbewahrt wird: Die Zeile speichert eine einzelne Farbe.
color.textColorstringerforderlich: Erforderlich, sobald `color` angegeben ist, und höchstens 32 Zeichen.

Antwort: Label

object'label': Immer der String `label`. Ein Schreibvorgang gibt ihn ebenfalls zurück, auf einer `SavedLabelResource` statt auf diesem Typ.
idstring: Die eigene id des Postfachs, und das, was `get`, `update` und `delete` entgegennehmen. Bei einem Schreibvorgang kommt sie als `SavedLabelResource.id`, die nullable ist. Ist sie null, finden Sie das Label über eine Auflistung.
namestring: Was der Benutzer sieht, und eine leere Zeichenkette statt null, wenn das Postfach ein Label ohne Namen zurückgibt. Im nativen Postfach wird die id aus diesem Namen abgeleitet (`Follow up` wird zu `USER_FOLLOW_UP`), ein zweites Label, das auf dieselbe id normalisiert, wird daher mit einem 409 `label_name_taken` abgelehnt, statt das erste zu überschreiben.
typestring: Immer `user`. Hier werden ausschließlich Benutzer-Labels ausgeliefert: Die IDs der Standardordner werden herausgefiltert, bevor die Antwort aufgebaut wird, und eine System-ID bei `get` ergibt einen 404. Fehlt das Feld im Postfach, fällt die Route auf `user` zurück, und nichts in `LabelInput` setzt es.
colorLabelColor | null: null, wenn das Postfach keine Farbe für das Label meldet. Prüfen Sie vor dem Rendern die Strings statt des Objekts. Ein leeres Paar ist nicht dasselbe wie ein fehlendes.
color.backgroundColorstring: Der Hintergrund des Labels, so wie ihn das Postfach vorhält. Er wird zurückgegeben statt verworfen, damit ein Client das Label so darstellen kann, wie der Benutzer es in der App sieht.
color.textColorstring: Die Vordergrundfarbe. Das native Postfach hat keine Spalte dafür: Lesevorgänge liefern `#ffffff` zurück, ganz gleich was geschrieben wurde, sodass ein heller Hintergrund mit darauf unlesbarem Text zurückkommt.