Nachrichten

Nachrichten durchsuchen

Nachrichten mit begrenzter Paginierung durchsuchen. Gibt UIDVALIDITY für spätere Vorgänge zurück.

GET/api/v1/mailboxes/{mailboxId}/messages/

Berechtigung read

Pfadparameter

mailboxIdintegererforderlich

Die ID des ausgewählten E-Mail-Postfachs. Für den E-Mail-Zugriff ist eine aktuelle Postfachberechtigung erforderlich.

Abfrageparameter

folderstring

Der Name des E-Mail-Postfachordners. Unicode-Namen werden unterstützt.

Standard: "INBOX" · Maximal 255 Zeichen

limitinteger

Maximale Anzahl der Elemente, die auf dieser Seite zurückgegeben werden.

Standard: 25 · Minimum: 1 · Maximum: 100

cursorinteger

Der Fortsetzungscursor aus der vorherigen Antwort.

uidValiditystring

Der exakte UIDVALIDITY-Wert aus der Ordnerliste. Veraltete Werte werden abgelehnt.

fromstring

Absenderidentität. Muss exakt mit der freigegebenen E-Mail-Postfachadresse übereinstimmen.

Maximal 254 Zeichen

tostring

E-Mail-Adressen der Empfänger. An, Cc und Bcc dürfen zusammen höchstens 20 Adressen enthalten.

Maximal 254 Zeichen

subjectstring

Der E-Mail-Betreff ohne Steuerzeichen.

Maximal 200 Zeichen

textstring

Textkörper der Nachricht im Klartext.

Maximal 200 Zeichen

sincestring · date-time

Nachrichten ab diesem ISO-Datum und dieser Uhrzeit finden.

beforestring · date-time

Nachrichten vor diesem ISO-Datum und dieser Uhrzeit abgleichen.

seenboolean

Nach Lesestatus filtern.

flaggedboolean

Nach Sternstatus filtern.

Antworten

200Erfolgreich

Die angeforderte Ressource oder Sammlung.

400Ungültige Anfrage

Ungültige Eingabe oder fehlender Idempotenzschlüssel.

401Nicht authentifiziert

Fehlender, abgelaufener oder widerrufener Bearer-Token.

403Verboten

Falscher Verwendungszweck der Anmeldedaten, unzureichender Berechtigungsumfang oder fehlende Freigabe für das E-Mail-Postfach.

404Nicht gefunden

Ressource oder Nachricht nicht gefunden oder für diese Integration nicht verfügbar.

409Konflikt

Ressourcenkonflikt, veralteter Nachrichtenverweis, mehrdeutige Übermittlung oder Idempotenzkonflikt.

413Zu groß

Anfrage oder Nachricht überschreitet die unterstützte Größe.

429Ratenbegrenzung erreicht

Ratenlimit erreicht. Warte vor einem erneuten Versuch die unter Retry-After angegebene Zeit ab.

500Interner Serverfehler

Unerwarteter Serverfehler. Wende dich mit der Anfrage-ID an den Support. Prüfe unklare Schreibvorgänge, bevor du es erneut versuchst.

503Dienst nicht verfügbar

Integrationen deaktiviert oder ein vorgelagerter Dienst nicht verfügbar.

Unter Limits und Fehler findest du Informationen zur Wiederholungsbehandlung und zum Fehlerobjekt.

Beispielanfrage

curl 'https://cherrymail.net/api/v1/mailboxes/123/messages/?limit=1' \
  -H "Authorization: Bearer $CHERRYMAIL_API_KEY"

Antwortapplication/json

dataobjecterforderlich

Untergeordnete Felder anzeigen

uidValiditystringerforderlich

Folder UIDVALIDITY. Bewahre sie zusammen mit dem E-Mail-Postfach, dem Ordner und der UID auf, wenn du eine Nachricht adressierst.

messagesobject[]erforderlich

Untergeordnete Felder anzeigen

uidintegererforderlich

Maximum: 4294967295

subjectstringerforderlich

fromobject[]erforderlich

Untergeordnete Felder anzeigen

namestring

Anzeigename, sofern er im Nachrichten-Envelope angegeben ist.

addressstring

Umschlagadresse, sofern vorhanden. Eine Gruppenbezeichnung kann eine leere Zeichenfolge sein; Gruppenmitglieder werden in diesem Array zusammengeführt.

toobject[]erforderlich

Untergeordnete Felder anzeigen

namestring

Anzeigename, sofern er im Nachrichten-Envelope angegeben ist.

addressstring

Umschlagadresse, sofern vorhanden. Eine Gruppenbezeichnung kann eine leere Zeichenfolge sein; Gruppenmitglieder werden in diesem Array zusammengeführt.

datestring | nullerforderlich

Datum des Nachrichtenumschlags oder null, wenn nicht vorhanden.

flagsstring[]erforderlich

IMAP-Flags wie \Seen und \Flagged, einschließlich benutzerdefinierter Server-Schlüsselwörter.

sizeintegererforderlich

Codierte Nachrichtengröße in Byte.

Minimum: 0

messageIdstring | nullerforderlich

RFC-Message-ID oder null, wenn nicht vorhanden.

nextCursorinteger | nullerforderlich

Numerischer Fortsetzungscursor für die nächste Seite; am Ende null. Außerdem uidValidity beibehalten.

request_idstring · uuiderforderlich

Anfrage-ID für Support und Zuordnung. Wird auch in X-Request-ID zurückgegeben.

Beispiel

Antworttext für 200

{
  "data": {
    "uidValidity": "1730000000",
    "messages": [
      {
        "uid": 42,
        "subject": "Your invoice",
        "from": [
          {
            "name": "Accounts",
            "address": "accounts@example.org"
          }
        ],
        "to": [
          {
            "name": "Customer support",
            "address": "hello@example.com"
          }
        ],
        "date": "2026-10-25T17:00:00.000Z",
        "flags": [
          "\\Seen"
        ],
        "size": 2048,
        "messageId": "<invoice-1042@example.org>"
      }
    ],
    "nextCursor": 42
  },
  "request_id": "650f28e8-c344-42e4-ae43-c61539f83119"
}

Die angeforderte Ressource oder Sammlung.

Antwort-Header

Cache-Control: no-store

ui.811c9dc5

X-Request-ID

Dieselbe Request-ID wie im JSON-Body.

RateLimit-Limit: 120;w=60

Limit und Zeitfenster pro Zugangsdaten.

RateLimit-Reset: 60

Zeitfenster für Ratenbegrenzung in Sekunden.

Basis-URL
https://cherrymail.net/api/v1

OpenAPI-Vertrag ansehen ↗