SDK

Etiķetes

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

Katra metode

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 atrisinās par vienkāršu masīvu, jo etiķetes netiek lapotas. color lasījumos tiek atgriezts, nevis izmests, lai klients varētu etiķeti attēlot tā, kā to redz lietotājs. type vienmēr ir user, tāpēc nav pēc kā zaroties. Id tiek atvasināts no nosaukuma, tāpēc Invoices ir USER_INVOICES.

Parametri: labels.create un labels.update

namestringobligāts: Etiķetes redzamais nosaukums; pirms mērīšanas tas tiek apgriezts, tāpēc ierobežojums pēc apgriešanas ir no 1 līdz 225 rakstzīmēm. Tikai atstarpes ir 422, nevis bezvārda ieraksts ar krāsas punktu un neko, ko izlasīt vai uzklikšķināt. `create` papildus atsakās, tiklīdz pastkastē jau ir 50 lietotāja etiķešu, ar 422 `label_limit_reached`, kas nosauc `name`.
colorLabelColor: Neobligāts abos izsaukumos, un tā izlaišana `update` gadījumā atstāj saglabāto krāsu neskartu, nevis to notīra. Ķermenis ir strikts, tāpēc gandrīz pareiza atslēga, piemēram, `colour`, ir 422, nevis kluss bezdarbs.
color.backgroundColorstringobligāts: Obligāts, tiklīdz ir dots `color`, un ne garāks par 32 rakstzīmēm. Vietējā pastkastē šī ir vienīgā saglabātā puse: ieraksts glabā vienu krāsu.
color.textColorstringobligāts: Obligāts, tiklīdz ir dots `color`, un ne garāks par 32 rakstzīmēm.

Atbilde: Label

object'label': Vienmēr virkne `label`. Arī rakstīšana to atgriež, bet uz `SavedLabelResource`, nevis uz šī tipa.
idstring: Pastkastes paša id, un tas, ko pieņem `get`, `update` un `delete`. Rakstīšanā tas atnāk kā `SavedLabelResource.id`, kas var būt null. Kad tas ir null, atrodi etiķeti, izsaucot sarakstu.
namestring: Tas, ko redz lietotājs, un tukša virkne, nevis null, kad pastkaste atdod etiķeti bez tā. Vietējā pastkastē id tiek atvasināts no šī nosaukuma (`Follow up` kļūst par `USER_FOLLOW_UP`), tāpēc otra etiķete, kas normalizējas uz to pašu id, tiek noraidīta ar 409 `label_name_taken`, nevis pārraksta pirmo.
typestring: Vienmēr `user`. Šeit tiek piedāvātas tikai lietotāja etiķetes: standarta mapju id tiek izfiltrēti, pirms atbilde tiek uzbūvēta, un sistēmas id `get` gadījumā ir 404. Maršruts atkāpjas uz `user`, kad pastkaste šo lauku izlaiž, un `LabelInput` to neiestata nekur.
colorLabelColor | null: Null, kad pastkaste etiķetei neuzrāda nevienu krāsu. Pirms attēlošanas pārbaudi virknes, nevis objektu. Tukšs pāris nav tas pats, kas trūkstošs.
color.backgroundColorstring: Etiķetes fons tāds, kādu to glabā pastkaste. Tiek atgriezts, nevis izmests, lai klients varētu etiķeti attēlot tā, kā lietotājs to redz lietotnē.
color.textColorstring: Priekšplāna krāsa. Vietējai pastkastei tai nav kolonnas: lasījumi atgriež `#ffffff` neatkarīgi no ierakstītā, tāpēc gaišs fons atnāk ar nesalasāmu tekstu uz tā.