E-Mails empfangen: Flags und Labels

Flags setzen

Markieren Sie Nachrichten als gelesen oder ungelesen, mit Stern und als wichtig. Funktioniert für eine Nachricht oder einen Stapel.

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

Stapelbefehle antworten pro Element, daher lässt eine fehlende ID die anderen nicht scheitern.

Argumente

  • idsstring[]optional

    Bis zu 100 Nachrichten-IDs.

  • idstringoptional

    Eine einzelne Nachrichten-ID. Verwenden Sie diese oder ids.

  • is_readbooleanoptional

    Als gelesen (true) oder ungelesen (false) markieren.

  • is_starredbooleanoptional

    Stern hinzufügen oder entfernen.

  • is_importantbooleanoptional

    Wichtig-Flag hinzufügen oder entfernen.

  • scopestringoptional

    message (Standard) oder thread. Wirkt sich nur auf is_read aus.

Schnellstart

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

Antwort

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

Antwortfelder

  • items[].id

    Die ID, auf die sich dieses Element bezieht.

  • items[].ok

    true, wenn die Änderung für diese ID funktioniert hat.

  • items[].data

    Das Ergebnis für diese ID. Nur wenn ok den Wert true hat.

  • items[].code / message

    Der Fehler für diese ID. Nur wenn ok den Wert false hat.

  • ok_count / failed_count

    Wie viele IDs funktioniert haben und wie viele fehlgeschlagen sind.

Wie sich die Flags verhalten

  • is_read + scope: thread

    Markiert die gesamte Konversation.

  • is_starred / is_important: true

    Markiert nur die Nachricht der id.

  • is_starred / is_important: false

    Entfernt das Flag in der gesamten Konversation. Eine Konversationszeile zeigt „hat einen Stern“, daher muss das Entfernen des Sterns ihn bei allen Nachrichten entfernen.

Fehler

Fehler auf HTTP-Ebene liefern type, code und message. Mit CMD markierte Fehler kommen im Befehlsergebnis zurück, mit HTTP 200.

  • 401TOKEN_EXPIRED

    Der Access Token ist abgelaufen. Rufen Sie Refresh Token auf und wiederholen Sie die Anfrage.

  • 401INVALID_TOKEN

    Der Token ist fehlerhaft, unbekannt oder widerrufen.

  • 429RATE_LIMITED

    Mehr als 15 Anfragen/s oder 15 gleichzeitig laufende Anfragen für dieselbe IP + dasselbe Postfach. Warten Sie die in Retry-After angegebene Anzahl Sekunden.

  • CMDINVALID_ARGS

    Ein erforderliches Argument fehlt oder ist ungültig.

  • CMDNOT_FOUND

    Die Nachricht, die Konversation oder der Ordner existiert für diesen Token nicht.

  • CMDINTERNAL

    Serverfehler. Die Details werden nur ins Server-Log geschrieben.