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- Цвет текста, который приложение рисует на этом образце.