پرش به مستندات
SDK

برچسب‌ها

`labels.list`، `get`، `create`، `update` و `delete`.

همهٔ متدها

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 به یک آرایهٔ ساده resolve می‌شود، چون برچسب‌ها صفحه‌بندی نمی‌شوند. color در خواندن‌ها بازگردانده می‌شود نه حذف، تا یک کلاینت بتواند برچسب را همان‌گونه که کاربر می‌بیند رندر کند. type همیشه user است، پس چیزی برای شاخه زدن نیست. شناسه‌ها از نام مشتق می‌شوند، پس Invoices می‌شود USER_INVOICES.

پارامترها: labels.create و labels.update

namestringالزامی
نام نمایشی برچسب، که پیش از اندازه‌گیری trim می‌شود، پس محدودیت پس از trim برابر 1 تا 225 نویسه است. فقط فاصلهٔ خالی یک 422 است، نه ردیفی بی‌نام با یک نقطهٔ رنگی که نه خواندنی دارد نه چیزی برای کلیک. `create` افزون بر این، وقتی صندوق پستی از پیش 50 برچسب کاربری داشته باشد امتناع می‌کند، با یک 422 و `label_limit_reached` که `name` را نام می‌برد.
colorLabelColor
روی هر دو فراخوانی اختیاری است، و حذف آن در `update` رنگ ذخیره‌شده را دست‌نخورده می‌گذارد نه اینکه پاکش کند. بدنه سخت‌گیر است، پس کلیدی نزدیک اما نادرست مانند `colour` یک 422 است، نه یک بی‌اثر بودنِ خاموش.
color.backgroundColorstringالزامی
به محض آنکه `color` داده شود الزامی است، و حداکثر 32 نویسه. روی صندوق پستی بومی تنها همین نیمه نگه داشته می‌شود: ردیف یک رنگ واحد ذخیره می‌کند.
color.textColorstringالزامی
به محض آنکه `color` داده شود الزامی است، و حداکثر 32 نویسه.

پاسخ: Label

object'label'
همیشه رشتهٔ `label`. نوشتن هم آن را برمی‌گرداند، اما روی `SavedLabelResource` نه روی این تایپ.
idstring
شناسهٔ خودِ صندوق پستی، و همان چیزی که `get`، `update` و `delete` می‌گیرند. در یک نوشتن، به‌صورت `SavedLabelResource.id` می‌رسد که nullable است. وقتی null باشد، برچسب را با فهرست کردن پیدا کنید.
namestring
آنچه کاربر می‌بیند، و وقتی صندوق پستی برچسبی بدون نام بازگرداند، به‌جای null یک رشتهٔ خالی. روی صندوق پستی بومی شناسه از همین نام مشتق می‌شود (`Follow up` می‌شود `USER_FOLLOW_UP`)، پس برچسب دومی که به همان شناسه نرمال شود با یک 409 Conflict و `label_name_taken` رد می‌شود، نه اینکه اولی را بازنویسی کند.
typestring
همیشه `user`. تنها برچسب‌های کاربری اینجا سرو می‌شوند: شناسه‌های پوشه‌های استاندارد پیش از ساخته شدن پاسخ فیلتر می‌شوند و یک شناسهٔ سیستمی روی `get` یک 404 Not Found است. وقتی صندوق پستی این فیلد را ندهد، مسیر به `user` بازمی‌گردد، و هیچ‌چیز در `LabelInput` آن را تنظیم نمی‌کند.
colorLabelColor | null
وقتی صندوق پستی برای برچسب هیچ رنگی گزارش نکند null است. پیش از رندر، به‌جای خودِ object، رشته‌ها را بررسی کنید. یک جفت خالی با یک جفت غایب یکی نیست.
color.backgroundColorstring
پس‌زمینهٔ برچسب همان‌گونه که صندوق پستی نگه می‌دارد. بازگردانده می‌شود نه حذف، تا یک کلاینت بتواند برچسب را همان‌طور رندر کند که کاربر در اپ می‌بیند.
color.textColorstring
رنگ پیش‌زمینه. صندوق پستی بومی ستونی برای آن ندارد: خواندن‌ها هرچه نوشته شده باشد `#ffffff` برمی‌گردانند، پس پس‌زمینهٔ روشن با متنی ناخوانا روی آن بازمی‌گردد.