Receber e-mails: Flags e marcadores
Definir flags
Marque mensagens como lidas ou não lidas, com estrela e importantes. Funciona em uma mensagem ou em lote.
https://g.sendcorex.com/v1command: set_flagsComandos em lote respondem item por item, então um id inexistente não faz os outros falharem.
Argumentos
idsstring[]opcionalAté 100 ids de mensagem.
idstringopcionalUm único id de mensagem. Use este ou
ids.is_readbooleanopcionalMarca como lida (
true) ou não lida (false).is_starredbooleanopcionalAdiciona ou remove a estrela.
is_importantbooleanopcionalAdiciona ou remove a flag de importante.
scopestringopcionalmessage(padrão) outhread. Só afetais_read.
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1',
{
commands: [
{
command: "set_flags",
args: {
ids: [
"Vj0xQUJDMTIz"
],
is_read: true,
scope: "thread"
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);
const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);Resposta
{
"type": "SUCCESS",
"results": [
{
"command": "set_flags",
"id": "0",
"type": "SUCCESS",
"data": {
"items": [
{
"id": "Vj0xQUJDMTIz",
"ok": true,
"data": {
"changed": 2
}
}
],
"ok_count": 1,
"failed_count": 0
}
}
]
}Campos da resposta
items[].idO id a que este item se refere.
items[].oktruese a alteração funcionou para este id.items[].dataO resultado para este id. Só quando
okétrue.items[].code / messageO erro para este id. Só quando
okéfalse.ok_count / failed_countQuantos ids funcionaram e quantos falharam.
Como as flags se comportam
is_read + scope: threadMarca a conversa inteira.
is_starred / is_important: trueMarca só a mensagem do
id.is_starred / is_important: falseLimpa a flag na conversa inteira. Uma linha de conversa mostra "tem estrela", então tirar a estrela precisa limpar todas as mensagens.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 401
TOKEN_EXPIREDO access token expirou. Chame Refresh Token e repita a requisição.
- 401
INVALID_TOKENO token está malformado, é desconhecido ou foi revogado.
- 429
RATE_LIMITEDMais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.
- CMD
INVALID_ARGSUm argumento obrigatório está ausente ou é inválido.
- CMD
NOT_FOUNDA mensagem, conversa ou pasta não existe para este token.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.