Menerima Email: Flag & label

Atur flag

Tandai pesan sebagai dibaca atau belum dibaca, berbintang, dan penting. Berfungsi untuk satu pesan atau satu batch.

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

Perintah batch menjawab per item, jadi satu id yang tidak ada tidak membuat yang lain gagal.

Argumen

  • idsstring[]opsional

    Hingga 100 id pesan.

  • idstringopsional

    Satu id pesan. Gunakan ini atau ids.

  • is_readbooleanopsional

    Tandai sebagai dibaca (true) atau belum dibaca (false).

  • is_starredbooleanopsional

    Tambah atau hapus bintang.

  • is_importantbooleanopsional

    Tambah atau hapus flag penting.

  • scopestringopsional

    message (default) atau thread. Hanya memengaruhi is_read.

Mulai cepat

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

Respons

{
  "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
      }
    }
  ]
}

Field respons

  • items[].id

    Id yang dirujuk item ini.

  • items[].ok

    true jika perubahan berhasil untuk id ini.

  • items[].data

    Hasil untuk id ini. Hanya jika ok bernilai true.

  • items[].code / message

    Error untuk id ini. Hanya jika ok bernilai false.

  • ok_count / failed_count

    Berapa id yang berhasil dan berapa yang gagal.

Cara kerja flag

  • is_read + scope: thread

    Menandai seluruh percakapan.

  • is_starred / is_important: true

    Hanya menandai pesan dari id.

  • is_starred / is_important: false

    Menghapus flag di seluruh percakapan. Baris percakapan menampilkan "berbintang", jadi menghapus bintang harus membersihkan semua pesan.

Error

Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.

  • 401TOKEN_EXPIRED

    Access token sudah kedaluwarsa. Panggil Refresh Token lalu ulangi request.

  • 401INVALID_TOKEN

    Token salah format, tidak dikenal, atau dicabut.

  • 429RATE_LIMITED

    Lebih dari 15 request/detik atau 15 yang sedang diproses untuk IP + kotak surat yang sama. Tunggu sesuai jumlah detik di Retry-After.

  • CMDINVALID_ARGS

    Argumen wajib tidak ada atau tidak valid.

  • CMDNOT_FOUND

    Pesan, percakapan, atau folder tidak ada untuk token ini.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.