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.

POSThttps://g.sendcorex.com/v1command: set_flags
i

Comandos em lote respondem item por item, então um id inexistente não faz os outros falharem.

Argumentos

  • idsstring[]opcional

    Até 100 ids de mensagem.

  • idstringopcional

    Um único id de mensagem. Use este ou ids.

  • is_readbooleanopcional

    Marca como lida (true) ou não lida (false).

  • is_starredbooleanopcional

    Adiciona ou remove a estrela.

  • is_importantbooleanopcional

    Adiciona ou remove a flag de importante.

  • scopestringopcional

    message (padrão) ou thread. Só afeta is_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[].id

    O id a que este item se refere.

  • items[].ok

    true se a alteração funcionou para este id.

  • items[].data

    O resultado para este id. Só quando ok é true.

  • items[].code / message

    O erro para este id. Só quando ok é false.

  • ok_count / failed_count

    Quantos ids funcionaram e quantos falharam.

Como as flags se comportam

  • is_read + scope: thread

    Marca a conversa inteira.

  • is_starred / is_important: true

    Marca só a mensagem do id.

  • is_starred / is_important: false

    Limpa 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.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais 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.

  • CMDINVALID_ARGS

    Um argumento obrigatório está ausente ou é inválido.

  • CMDNOT_FOUND

    A mensagem, conversa ou pasta não existe para este token.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.