Belgelere geç
Python

Etiketler

`labels.list`, `list_all`, `iterate`, `list_colors`, `get`, `create`, `update` ve `delete`.

Her yöntem

usage.py
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, ada göre sıralanmış etiketlerden oluşan tek bir Page döndürür; list_all ve iterate her sayfayı dolaşır. Her etiket rengini, threadCount değerini ve ne zaman oluşturulup en son ne zaman değiştirildiğini taşır. list_colors, uygulamanın sunduğu paleti, on dört düz renk ve yedi geçişi, düz bir liste olarak döndürür. type her zaman user olur. Id, etiketin oluşturulduğu addan gelir; yani Invoices, USER_INVOICES olur ve hiç değişmez.

Bir etiket çalışma alanına aittir, bu yüzden yeniden adlandırma, renk değiştirme ya da silme onu her üye ve her anahtar için değiştirir. threads.update bir konuşmaya etiket koyar ve kaldırır, threads.list(folder='USER_INVOICES') ise bir etiketi taşıyan her konuşmayı listeler.

Parametreler: labels.create ve labels.update

namestr
Etiketin görünen adı; ölçülmeden önce kırpılır, yani sınır kırpmadan sonra 1 ile 225 karakter arasıdır. `create` çağrısında zorunlu, `update` çağrısında isteğe bağlıdır; orada gönderilmezse ad korunur. Yalnızca boşluk 422 döndürür. Başka bir etiketin zaten sahip olduğu bir ad, büyük-küçük harf gözetilmeden karşılaştırılarak, 409 `label_name_taken` döndürür; `create` ise çalışma alanında 50 etiket olduğunda 422 `label_limit_reached` ile reddeder.
colorLabelColorInput | None
Her iki çağrıda da isteğe bağlıdır. `update` çağrısında gönderilmezse saklanan renk korunur, `None` ise rengi temizler. Gövde katıdır; dolayısıyla `colour` gibi az farklı bir anahtar sessizce etkisiz kalmak yerine 422 verir.
color.backgroundColorstrzorunlu
Bir hex rengi (`#RGB`, `#RGBA`, `#RRGGBB` ya da `#RRGGBBAA`, büyük harfle saklanır) ya da bir geçiş belirteci: `gradient:sunset`, `gradient:ember`, `gradient:meadow`, `gradient:lagoon`, `gradient:aurora`, `gradient:berry` ya da `gradient:midnight`. Boş bir dize renk olmadığı anlamına gelir; başka her şey 422 `invalid_parameter` döndürür.
color.textColorstr
Kabul edilir ve yok sayılır. Yazı rengi, uygulamada olduğu gibi `backgroundColor` değerinden hesaplanır.

Yanıt: LabelResource

objectLiteral['label']
Her zaman `label` dizesi. `create` ve `update` de saklandığı hâliyle okunan bu aynı türü döndürür.
idstr
Etiketin kimliği; `get`, `update`, `delete` ve `threads.update` bunu alır. Yeniden adlandırmadan sonra bile hiç değişmez.
namestr
Kullanıcının gördüğü.
typestr
Her zaman `user`. Sistem etiketleri burada hiç sunulmaz ve `get` çağrısında bir sistem kimliği 404 döndürür.
colorLabelColor | None
Etiketin rengi yoksa `None`.
color.backgroundColorstr
Saklanan renk: bir hex değeri ya da bir geçiş belirteci. `list_colors` bir geçişin iki ucunu verir.
color.textColorstr
Uygulamanın rengin üzerine çizdiği yazı rengi, `#18181B` ya da `#FFFFFF`; saklanmaz, sunucuda hesaplanır.
threadCountint
Etiketin şu anda kaç konuşmada bulunduğu. Belirli adreslerle sınırlı bir anahtar için yalnızca bu adreslere teslim edilen konuşmalar sayılır.
createdAtstr | None
Etiketin oluşturulduğu zaman, ISO 8601 olarak; bu zamanlar kaydedilmeden önce oluşturulmuş bir etikette `None`.
updatedAtstr | None
Son yeniden adlandırma ya da renk değişikliği, ISO 8601 olarak; bu zamanlar kaydedilmeden önce oluşturulmuş bir etikette `None`.

Yanıt: LabelColorResource

kindLiteral['solid', 'gradient']
Örneğin tek renk mi yoksa geçiş mi olduğu.
namestr
Örneğin adı, `red` ya da `sunset` gibi.
valuestr
Bu örneği kullanmak için `color.backgroundColor` olarak gönderilecek değer.
solidstr
Geçiş çizilemeyen yerler için tek bir hex değeri. Düz renkte `value` ile aynıdır.
fromstr | None
Geçişin başladığı yer, 135 derece açıyla çizilir. Düz renkte `None`.
tostr | None
Geçişin bittiği yer. Düz renkte `None`.
textColorstr
Uygulamanın bu örneğin üzerine çizdiği yazı rengi.

Referans