SDK

Labels

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

Elke methode

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 levert een gewone array op, aangezien labels niet gepagineerd worden. color wordt bij leesacties teruggegeven in plaats van weggelaten, zodat een client een label kan tonen zoals de gebruiker het ziet. type is altijd user, dus daar valt niets op te vertakken. Ids worden van de naam afgeleid, dus Invoices wordt USER_INVOICES.

Parameters: labels.create en labels.update

namestringverplicht: De weergavenaam van het label, getrimd voordat hij gemeten wordt, dus de limiet is 1 tot 225 tekens na het trimmen. Alleen witruimte is een 422 in plaats van een naamloze rij met een kleurstip en niets om te lezen of aan te klikken. `create` weigert daarnaast zodra de mailbox al 50 gebruikerslabels bevat, met een 422 `label_limit_reached` die `name` noemt.
colorLabelColor: Optioneel bij beide aanroepen, en het weglaten bij `update` laat de opgeslagen kleur ongemoeid in plaats van hem te wissen. De body is strikt, dus een bijna-treffer zoals `colour` is een 422 in plaats van een stille no-op.
color.backgroundColorstringverplicht: Verplicht zodra `color` gegeven is, en maximaal 32 tekens. Op de eigen mailbox is dit de enige helft die bewaard blijft: de rij slaat één kleur op.
color.textColorstringverplicht: Verplicht zodra `color` gegeven is, en maximaal 32 tekens.

Antwoord: Label

object'label': Altijd de string `label`. Een schrijfactie geeft hem ook terug, op een `SavedLabelResource` in plaats van op dit type.
idstring: De eigen id van de mailbox, en wat `get`, `update` en `delete` accepteren. Bij een schrijfactie arriveert hij als `SavedLabelResource.id`, dat nullable is. Wanneer die null is, vind je het label door te listen.
namestring: Wat de gebruiker ziet, en een lege string in plaats van null wanneer de mailbox een label zonder naam teruggeeft. Op de eigen mailbox wordt de id van deze naam afgeleid (`Follow up` wordt `USER_FOLLOW_UP`), dus een tweede label dat naar dezelfde id normaliseert wordt geweigerd met een 409 `label_name_taken` in plaats van het eerste te overschrijven.
typestring: Altijd `user`. Hier worden alleen gebruikerslabels geserveerd: de standaard mapids worden eruit gefilterd voordat het antwoord wordt opgebouwd, en een systeem-id op `get` is een 404. De route valt terug op `user` wanneer de mailbox het veld weglaat, en niets in `LabelInput` stelt het in.
colorLabelColor | null: Null wanneer de mailbox geen kleur voor het label meldt. Toets de strings in plaats van het object voordat je rendert. Een leeg paar is niet hetzelfde als een afwezig paar.
color.backgroundColorstring: De achtergrond van het label zoals de mailbox die bewaart. Teruggegeven in plaats van weggelaten, zodat een client het label kan tonen zoals de gebruiker het in de app ziet.
color.textColorstring: De voorgrondkleur. De eigen mailbox heeft er geen kolom voor: leesacties geven `#ffffff` terug wat er ook geschreven is, dus een bleke achtergrond komt terug met onleesbare tekst erop.