Recibir correos: Flags y etiquetas

Establecer flags

Marca mensajes como leídos o no leídos, destacados e importantes. Funciona con un mensaje o con un lote.

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

Los comandos en lote responden elemento por elemento, así que un id inexistente no hace fallar a los demás.

Argumentos

  • idsstring[]opcional

    Hasta 100 ids de mensaje.

  • idstringopcional

    Un único id de mensaje. Usa este o ids.

  • is_readbooleanopcional

    Marca como leído (true) o no leído (false).

  • is_starredbooleanopcional

    Añade o quita el destacado.

  • is_importantbooleanopcional

    Añade o quita el flag de importante.

  • scopestringopcional

    message (por defecto) o thread. Solo afecta a is_read.

Inicio 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);

Respuesta

{
  "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 de la respuesta

  • items[].id

    El id al que se refiere este elemento.

  • items[].ok

    true si el cambio funcionó para este id.

  • items[].data

    El resultado para este id. Solo cuando ok es true.

  • items[].code / message

    El error para este id. Solo cuando ok es false.

  • ok_count / failed_count

    Cuántos ids funcionaron y cuántos fallaron.

Cómo se comportan los flags

  • is_read + scope: thread

    Marca toda la conversación.

  • is_starred / is_important: true

    Marca solo el mensaje del id.

  • is_starred / is_important: false

    Quita el flag en toda la conversación. Una fila de conversación muestra "tiene destacado", así que quitar el destacado tiene que limpiar todos los mensajes.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 401TOKEN_EXPIRED

    El access token expiró. Llama a Refresh Token y repite la solicitud.

  • 401INVALID_TOKEN

    El token está mal formado, es desconocido o fue revocado.

  • 429RATE_LIMITED

    Más de 15 solicitudes/s o 15 en curso para la misma IP + buzón. Espera la cantidad de segundos indicada en Retry-After.

  • CMDINVALID_ARGS

    Falta un argumento obligatorio o no es válido.

  • CMDNOT_FOUND

    El mensaje, la conversación o la carpeta no existe para este token.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.