Python
برچسب‌ها
`labels.list`، `list_all`، `iterate`، `list_colors`، `get`، `create`، `update` و `delete`.
همهٔ متدها
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 یک Page از برچسب‌های مرتب‌شده بر اساس نام برمی‌گرداند، و list_all و iterate همهٔ صفحه‌ها را می‌پیمایند. هر برچسب رنگش، threadCount و زمان ساخت و آخرین تغییرش را دارد. list_colors پالتی را که برنامه پیشنهاد می‌کند، چهارده رنگ یکدست و هفت گرادیان، به‌صورت یک فهرست ساده برمی‌گرداند. type همیشه user است. شناسه از نامی می‌آید که برچسب با آن ساخته شده، پس Invoices می‌شود USER_INVOICES، و هیچ‌وقت عوض نمی‌شود.
برچسب به فضای کاری تعلق دارد، پس تغییر نام، تغییر رنگ یا حذف آن را برای همهٔ اعضا و همهٔ کلیدها تغییر می‌دهد. threads.update برچسب‌ها را روی یک گفتگو می‌گذارد و برمی‌دارد، و threads.list(folder='USER_INVOICES') هر گفتگویی را که یک برچسب دارد فهرست می‌کند.
پارامترها: labels.create و labels.update
namestr- نام نمایشی برچسب، که پیش از اندازه‌گیری کوتاه‌سازی می‌شود، پس محدوده پس از کوتاه‌سازی 1 تا 225 نویسه است. در `create` الزامی و در `update` اختیاری است، که نفرستادنش نام را نگه می‌دارد. فقط فاصله یک 422 است. نامی که برچسب دیگری از قبل دارد، با مقایسه‌ای بی‌توجه به بزرگی و کوچکی حروف، یک 409 `label_name_taken` است، و `create` وقتی فضای کاری 50 برچسب دارد با یک 422 `label_limit_reached` رد می‌کند.
colorLabelColorInput | None- روی هر دو فراخوانی اختیاری است. نفرستادنش در `update` رنگ ذخیره‌شده را نگه می‌دارد، و `None` آن را پاک می‌کند. بدنه سخت‌گیر است، پس کلیدی نزدیک اما نادرست مانند `colour` یک 422 است، نه یک بی‌اثر بودنِ خاموش.
color.backgroundColorstrالزامی- یک رنگ hex (`#RGB`، `#RGBA`، `#RRGGBB` یا `#RRGGBBAA`، که با حروف بزرگ ذخیره می‌شود) یا یک توکن گرادیان: `gradient:sunset`، `gradient:ember`، `gradient:meadow`، `gradient:lagoon`، `gradient:aurora`، `gradient:berry` یا `gradient:midnight`. رشتهٔ خالی یعنی بی‌رنگ، و هر چیز دیگری یک 422 `invalid_parameter` است.
color.textColorstr- پذیرفته و نادیده گرفته می‌شود. جوهر از `backgroundColor` محاسبه می‌شود، همان‌طور که برنامه این کار را می‌کند.
پاسخ: LabelResource
objectLiteral['label']- همیشه رشتهٔ `label`. `create` و `update` هم همین نوع را برمی‌گردانند، همان‌طور که ذخیره شده خوانده می‌شود.
idstr- شناسهٔ برچسب، و چیزی که `get`، `update`، `delete` و `threads.update` می‌گیرند. هیچ‌وقت عوض نمی‌شود، حتی پس از تغییر نام.
namestr- چیزی که کاربر می‌بیند.
typestr- همیشه `user`. برچسب‌های سیستمی هرگز اینجا ارائه نمی‌شوند، و شناسهٔ سیستمی در `get` یک 404 است.
colorLabelColor | None- وقتی برچسب رنگی ندارد `None` است.
color.backgroundColorstr- رنگ ذخیره‌شده: یک مقدار hex یا یک توکن گرادیان. `list_colors` دو سر یک گرادیان را می‌دهد.
color.textColorstr- جوهری که برنامه روی رنگ می‌کشد، `#18181B` یا `#FFFFFF`، که به‌جای ذخیره‌شدن روی سرور محاسبه می‌شود.
threadCountint- تعداد گفتگوهایی که اکنون برچسب را دارند. برای کلیدی که به نشانی‌های خاصی محدود است، فقط گفتگوهای تحویل‌شده به همان نشانی‌ها شمرده می‌شوند.
createdAtstr | None- زمان ساخته‌شدن برچسب، به‌صورت ISO 8601، یا `None` برای برچسبی که پیش از ثبت این زمان‌ها ساخته شده.
updatedAtstr | None- آخرین تغییر نام یا رنگ، به‌صورت ISO 8601، یا `None` برای برچسبی که پیش از ثبت این زمان‌ها ساخته شده.
پاسخ: LabelColorResource
kindLiteral['solid', 'gradient']- اینکه نمونه یک رنگ است یا یک گرادیان.
namestr- نام نمونه، مانند `red` یا `sunset`.
valuestr- چیزی که باید به‌عنوان `color.backgroundColor` فرستاد تا از این نمونه استفاده شود.
solidstr- یک hex تنها برای جاهایی که نمی‌توان گرادیان کشید. در رنگ یکدست همان `value` است.
fromstr | None- جایی که گرادیان شروع می‌شود، با زاویهٔ 135 درجه. در رنگ یکدست `None` است.
tostr | None- جایی که گرادیان تمام می‌شود. در رنگ یکدست `None` است.
textColorstr- جوهری که برنامه روی این نمونه می‌کشد.