SDK
Nhãn
`labels.list`, `get`, `create`, `update` và `delete`.
Mọi phương thức
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 trả về một mảng thuần, vì nhãn không phân trang. color được trả về khi đọc chứ không bị bỏ đi, nên client có thể vẽ nhãn đúng như người dùng nhìn thấy. type luôn là user, nên không có gì để rẽ nhánh. Id được suy ra từ tên, nên Invoices thành USER_INVOICES.
Tham số: labels.create và labels.update
namestringbắt buộc- Tên hiển thị của nhãn, được cắt khoảng trắng trước khi đo, nên giới hạn là 1 đến 225 ký tự sau khi cắt. Chỉ toàn khoảng trắng là một 422 chứ không phải một hàng không tên với một chấm màu mà chẳng có gì để đọc hay bấm. `create` còn từ chối khi hộp thư đã có 50 nhãn người dùng, với một 422 `label_limit_reached` nêu tên `name`.
colorLabelColor- Tuỳ chọn ở cả hai lời gọi, và bỏ qua nó trong `update` sẽ giữ nguyên màu đã lưu chứ không xoá nó. Body được kiểm tra nghiêm ngặt, nên một khoá gần đúng như `colour` là một 422 chứ không phải im lặng không làm gì.
color.backgroundColorstringbắt buộc- Bắt buộc một khi đã truyền `color`, và tối đa 32 ký tự. Trên hộp thư gốc, đây là nửa duy nhất được giữ lại: hàng dữ liệu chỉ lưu một màu.
color.textColorstringbắt buộc- Bắt buộc một khi đã truyền `color`, và tối đa 32 ký tự.
Phản hồi: Label
object'label'- Luôn là chuỗi `label`. Một thao tác ghi cũng trả về nó, nhưng trên một `SavedLabelResource` chứ không phải trên kiểu này.
idstring- Id riêng của hộp thư, và là thứ mà `get`, `update` và `delete` nhận. Khi ghi, nó tới dưới dạng `SavedLabelResource.id`, vốn có thể null. Khi nó null, hãy tìm nhãn bằng cách liệt kê.
namestring- Thứ người dùng nhìn thấy, và là một chuỗi rỗng chứ không phải null khi hộp thư trả về một nhãn không có tên. Trên hộp thư gốc, id được suy ra từ chính tên này (`Follow up` thành `USER_FOLLOW_UP`), nên một nhãn thứ hai chuẩn hoá ra cùng id sẽ bị từ chối với một 409 `label_name_taken` thay vì ghi đè cái đầu tiên.
typestring- Luôn là `user`. Chỉ nhãn người dùng được phục vụ ở đây: các id thư mục chuẩn bị lọc bỏ trước khi phản hồi được dựng, và một id hệ thống trong `get` là một 404. Route quay về `user` khi hộp thư bỏ trống trường này, và không có gì trong `LabelInput` đặt nó.
colorLabelColor | null- Null khi hộp thư báo rằng nhãn không có màu. Hãy kiểm tra các chuỗi chứ không phải đối tượng trước khi kết xuất. Một cặp rỗng không giống một cặp vắng mặt.
color.backgroundColorstring- Nền của nhãn đúng như hộp thư lưu. Được trả về chứ không bị bỏ đi, nên client có thể vẽ nhãn đúng như người dùng nhìn thấy trong ứng dụng.
color.textColorstring- Màu chữ. Hộp thư gốc không có cột cho nó: mọi lần đọc đều trả về `#ffffff` bất kể đã ghi gì, nên một nền nhạt sẽ trả về kèm chữ không thể đọc nổi trên đó.