Python
Etiquetas
`labels.list`, `list_all`, `iterate`, `list_colors`, `get`, `create`, `update` e `delete`.
Todos os métodos
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 devolve uma Page de etiquetas ordenadas por nome, e list_all e iterate percorrem todas as páginas. Cada etiqueta tem a sua cor, threadCount e quando foi criada e alterada pela última vez. list_colors devolve a paleta que a aplicação oferece, catorze sólidas e sete gradientes, como uma lista simples. type é sempre user. O id vem do nome com que a etiqueta foi criada, por isso Invoices é USER_INVOICES, e nunca muda.
Uma etiqueta pertence ao espaço de trabalho, por isso renomeá-la, mudar-lhe a cor ou eliminá-la altera-a para todos os membros e todas as chaves. threads.update põe e tira etiquetas de uma conversa, e threads.list(folder='USER_INVOICES') lista todas as conversas que têm uma.
Parâmetros: labels.create e labels.update
namestr- O nome visível da etiqueta, aparado antes de ser medido, por isso o limite é de 1 a 225 caracteres depois de aparar. Obrigatório em `create` e opcional em `update`, onde omiti-lo mantém o nome. Só espaços é um 422. Um nome que outra etiqueta já tem, comparado sem distinguir maiúsculas, é um 409 `label_name_taken`, e `create` recusa quando o espaço de trabalho já tem 50 etiquetas, com um 422 `label_limit_reached`.
colorLabelColorInput | None- Opcional em ambas as chamadas. Omiti-lo em `update` mantém a cor guardada, e `None` limpa-a. O corpo é estrito, por isso uma chave quase certa como `colour` é um 422 e não um no-op silencioso.
color.backgroundColorstrobrigatório- Uma cor hexadecimal (`#RGB`, `#RGBA`, `#RRGGBB` ou `#RRGGBBAA`, guardada em maiúsculas) ou um token de gradiente: `gradient:sunset`, `gradient:ember`, `gradient:meadow`, `gradient:lagoon`, `gradient:aurora`, `gradient:berry` ou `gradient:midnight`. Uma string vazia significa sem cor, e qualquer outra coisa é um 422 `invalid_parameter`.
color.textColorstr- Aceite e ignorado. A tinta é calculada a partir de `backgroundColor`, tal como a app faz.
Resposta: LabelResource
objectLiteral['label']- Sempre a string `label`. `create` e `update` devolvem este mesmo tipo, lido tal como está guardado.
idstr- O id da etiqueta, e o que `get`, `update`, `delete` e `threads.update` aceitam. Nunca muda, nem depois de uma mudança de nome.
namestr- O que o utilizador vê.
typestr- Sempre `user`. As etiquetas de sistema nunca são servidas aqui, e um id de sistema em `get` é um 404.
colorLabelColor | None- `None` quando a etiqueta não tem cor.
color.backgroundColorstr- A cor guardada: um valor hexadecimal ou um token de gradiente. `list_colors` dá as duas pontas de um gradiente.
color.textColorstr- A tinta que a app desenha sobre a cor, `#18181B` ou `#FFFFFF`, calculada no servidor em vez de guardada.
threadCountint- Quantas conversas têm a etiqueta neste momento. Para uma chave limitada a certos endereços, só contam as conversas entregues a esses endereços.
createdAtstr | None- Quando a etiqueta foi criada, em ISO 8601, ou `None` numa etiqueta criada antes de estas datas serem registadas.
updatedAtstr | None- A última mudança de nome ou de cor, em ISO 8601, ou `None` numa etiqueta criada antes de estas datas serem registadas.
Resposta: LabelColorResource
kindLiteral['solid', 'gradient']- Se a amostra é uma só cor ou um gradiente.
namestr- O nome da amostra, como `red` ou `sunset`.
valuestr- O que enviar como `color.backgroundColor` para usar esta amostra.
solidstr- Um único hexadecimal para os sítios onde não se pode desenhar um gradiente. O mesmo que `value` numa sólida.
fromstr | None- Onde começa um gradiente, desenhado a 135 graus. `None` numa sólida.
tostr | None- Onde acaba um gradiente. `None` numa sólida.
textColorstr- A tinta que a app desenha sobre esta amostra.