Zum Inhalt springen
Geprüft

Eine E-Mail senden

Bestätige mit einem Aufruf, dass ausgehende Post eingerichtet ist, bevor sich eine echte Benachrichtigung darauf verlässt.

test_email sendet eine echte Nachricht über denselben Stalwart-Submission-Pfad, den jede Plattform-E-Mail nutzt, ausgehend von @xuda.ai, mit abgestimmtem DKIM und SPF. Du musst vorher nichts konfigurieren: Rufe sie auf, prüfe den Posteingang (oder den Fehler), und du weißt, dass ausgehende Post funktioniert, bevor irgendetwas anderes in deiner Integration davon abhängt.

Methode

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Zwei weitere Felder, die die Registry nicht auflistet

test_email deklariert ein Pflichtfeld, email. Der Handler liest außerdem ein optionales app_id (übernimmt das Branding dieses Projekts in die Vorlage, ohne Angabe gilt das eigene Xuda-Branding der Plattform) und ein optionales from (ein anderes Xuda-Postfach als Absender, dessen eigene Submission-Zugangsdaten serverseitig bereits existieren müssen). Beide sind unten aus dem Quellcode wiedergegeben, nicht aus der Registry.

Schritt für Schritt

Senden

Nur api_key und die Adresse, an die du den Test erhalten willst.

curl -s https://xuda.ai/cpi/test_email \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","email":"[email protected]"}'
const res = await fetch('https://xuda.ai/cpi/test_email', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY', email: '[email protected]' }),
});
const { code, data } = await res.json();
if (code > 0) console.log('sent:', data.messageId, data.accepted);
else console.log('failed:', data);
import requests

res = requests.post(
    'https://xuda.ai/cpi/test_email',
    json={'api_key': 'YOUR_API_KEY', 'email': '[email protected]'},
)
body = res.json()
if body['code'] > 0:
    print('sent:', body['data']['messageId'], body['data']['accepted'])
else:
    print('failed:', body['data'])

Die Antwort

data ist das eigene SMTP-Ergebnisobjekt von nodemailer, unverändert durchgereicht:

json
{
  "code": 1,
  "data": {
    "accepted": ["[email protected]"],
    "rejected": [],
    "envelopeTime": 210,
    "messageTime": 340,
    "messageSize": 812,
    "response": "250 2.0.0 OK",
    "envelope": { "from": "[email protected]", "to": ["[email protected]"] },
    "messageId": "<[email protected]>"
  }
}

code: 1 bedeutet, dass der Submission-Server die Nachricht zur Zustellung angenommen hat, nicht, dass sie im Posteingang gelandet ist. accepted ist die Adressliste, die Stalwart selbst bestätigt hat, und ein nicht leeres rejected bei einer sonst code: 1 lautenden Antwort bedeutet, dass Stalwart manche Empfänger angenommen und andere abgelehnt hat. Hinter diesem Aufruf steht kein Zustell-Webhook: Eine Antwort mit code: 1 ist das ganze Signal, das du von test_email selbst bekommst.

Fehler

Weiter