SDK

Etiketler

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

Tüm metotlar

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 düz bir dizi döndürür, çünkü etiketler sayfalanmaz. color okuma yanıtlarında düşürülmek yerine döndürülür; böylece bir istemci etiketi kullanıcının gördüğü gibi çizebilir. type her zaman user'dır, dolayısıyla dallanılacak bir şey yoktur. Id'ler addan türetilir; örneğin Invoices, USER_INVOICES olur.

Parametreler: labels.create ve labels.update

namestringzorunlu: Etiketin görünen adı; ölçülmeden önce kırpılır, dolayısıyla sınır kırpma sonrasında 1 ila 225 karakterdir. Yalnızca boşluktan oluşan bir ad, renkli noktası olan ama okunacak ya da tıklanacak hiçbir şeyi olmayan adsız bir satır yerine 422 verir. `create` ayrıca posta kutusunda zaten 50 kullanıcı etiketi varken `name` alanını belirten 422 `label_limit_reached` ile reddeder.
colorLabelColor: Her iki çağrıda da isteğe bağlıdır ve `update` çağrısında belirtmemek, saklanan rengi temizlemek yerine olduğu gibi bırakır. Gövde katıdır; dolayısıyla `colour` gibi az farklı bir anahtar sessizce etkisiz kalmak yerine 422 verir.
color.backgroundColorstringzorunlu: `color` verildiğinde zorunludur, en fazla 32 karakter. Yerel posta kutusunda saklanan tek yarı budur: satır tek bir renk tutar.
color.textColorstringzorunlu: `color` verildiğinde zorunludur, en fazla 32 karakter.

Yanıt: Label

object'label': Her zaman `label` dizgesi. Bir yazma işlemi de bunu döndürür, ama bu tip üzerinde değil bir `SavedLabelResource` üzerinde.
idstring: Posta kutusunun kendi id'si; `get`, `update` ve `delete` çağrılarının aldığı değerdir. Bir yazma işleminde null olabilen `SavedLabelResource.id` olarak gelir. Null olduğunda etiketi listeleyerek bulun.
namestring: Kullanıcının gördüğü ad; posta kutusu adsız bir etiket döndürdüğünde null değil boş dizge olur. Yerel posta kutusunda id bu addan türetilir (`Follow up`, `USER_FOLLOW_UP` olur); dolayısıyla aynı id'ye normalleşen ikinci bir etiket, ilkinin üzerine yazmak yerine 409 `label_name_taken` ile reddedilir.
typestring: Her zaman `user`. Burada yalnızca kullanıcı etiketleri sunulur: standart klasör id'leri yanıt kurulmadan önce elenir ve `get` çağrısına verilen bir sistem id'si 404 verir. Posta kutusu bu alanı vermediğinde rota `user` değerine düşer ve `LabelInput` içindeki hiçbir şey bunu ayarlamaz.
colorLabelColor | null: Posta kutusu etiket için renk bildirmediğinde null. Çizmeden önce nesneyi değil dizgeleri sınayın. Boş bir çift, olmayan bir çiftle aynı şey değildir.
color.backgroundColorstring: Posta kutusunun tuttuğu hâliyle etiketin arka planı. Düşürülmek yerine döndürülür; böylece bir istemci etiketi kullanıcının uygulamada gördüğü gibi çizebilir.
color.textColorstring: Ön plan rengi. Yerel posta kutusunda bunun için bir sütun yoktur: ne yazılmış olursa olsun okumalar `#ffffff` döndürür, dolayısıyla açık renkli bir arka plan okunmaz bir metinle geri gelir.