SDK

Etiquetas

`labels.list`, `get`, `create`, `update` e `delete`.

Todos os métodos

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 para um array simples, já que as etiquetas não são paginadas. color é devolvido nas leituras em vez de descartado, para que um cliente possa desenhar uma etiqueta como o utilizador a vê. type é sempre user, por isso não há nada sobre que ramificar. Os ids derivam do nome, por isso Invoices é USER_INVOICES.

Parâmetros: labels.create e labels.update

namestringobrigatório: O nome visível da etiqueta, aparado antes de ser medido, por isso o limite é de 1 a 225 caracteres depois de aparado. Apenas espaços em branco é um 422 em vez de uma linha sem nome com um ponto de cor e nada para ler ou clicar. `create` recusa ainda assim que a caixa de correio já tenha 50 etiquetas de utilizador, com um 422 `label_limit_reached` a nomear `name`.
colorLabelColor: Opcional em ambas as chamadas, e omiti-lo em `update` deixa a cor guardada intacta em vez de a limpar. O corpo é estrito, por isso uma chave quase certa como `colour` é um 422 e não um no-op silencioso.
color.backgroundColorstringobrigatório: Obrigatório assim que `color` é dado, e no máximo 32 caracteres. Na caixa de correio nativa esta é a única metade guardada: a linha armazena uma única cor.
color.textColorstringobrigatório: Obrigatório assim que `color` é dado, e no máximo 32 caracteres.

Resposta: Label

object'label': Sempre a string `label`. Uma escrita também o devolve, num `SavedLabelResource` em vez de neste tipo.
idstring: O id próprio da caixa de correio, e o que `get`, `update` e `delete` aceitam. Numa escrita chega como `SavedLabelResource.id`, que é nullable. Quando é null, encontre a etiqueta listando.
namestring: O que o utilizador vê, e uma string vazia em vez de null quando a caixa de correio devolve uma etiqueta sem um. Na caixa de correio nativa o id deriva deste nome (`Follow up` torna-se `USER_FOLLOW_UP`), por isso uma segunda etiqueta que normalize para o mesmo id é recusada com um 409 `label_name_taken` em vez de sobrescrever a primeira.
typestring: Sempre `user`. Só as etiquetas de utilizador são servidas aqui: os ids das pastas padrão são filtrados antes de a resposta ser construída, e um id de sistema em `get` é um 404. A rota recai em `user` quando a caixa de correio omite o campo, e nada em `LabelInput` o define.
colorLabelColor | null: Null quando a caixa de correio não reporta cor para a etiqueta. Teste as strings em vez do objeto antes de desenhar. Um par vazio não é o mesmo que um par ausente.
color.backgroundColorstring: O fundo da etiqueta tal como a caixa de correio o guarda. Devolvido em vez de descartado, para que um cliente possa desenhar a etiqueta como o utilizador a vê na aplicação.
color.textColorstring: A cor de primeiro plano. A caixa de correio nativa não tem coluna para ela: as leituras devolvem `#ffffff` seja o que for que tenha sido escrito, por isso um fundo claro volta com texto ilegível sobre ele.