Przejdź do treści
Zweryfikowano

Wyślij e-mail

Potwierdź jednym wywołaniem, że poczta wychodząca jest podłączona, zanim zależeć od niej będzie prawdziwe powiadomienie.

test_email wysyła jedną prawdziwą wiadomość tą samą ścieżką zgłoszeniową Stalwart, której używa każdy e-mail platformy, wychodzącą z @xuda.ai, z dopasowanym DKIM i SPF. Nie trzeba niczego wcześniej konfigurować: wywołaj ją, sprawdź skrzynkę (albo błąd) i wiesz, że poczta wychodząca działa, zanim zależeć od niej zacznie cokolwiek innego w Twojej integracji.

Metoda

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Dwa dodatkowe pola, których rejestr nie wymienia

test_email deklaruje jedno obowiązkowe pole, email. Procedura obsługi czyta też opcjonalne app_id (wciąga branding tego projektu do szablonu; pominięte oznacza własny branding Xuda platformy) oraz opcjonalne from (inna skrzynka Xuda, jako którą wysłać, jej własne poświadczenie zgłoszeniowe musi już istnieć po stronie serwera). Oba są odtworzone poniżej ze źródła, a nie z rejestru.

Krok po kroku

Wyślij

Tylko api_key i adres, na który chcesz otrzymać test.

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'])

Odpowiedź

data to własny obiekt wyniku SMTP biblioteki nodemailer, przekazany wprost:

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 oznacza, że serwer zgłoszeniowy przyjął wiadomość do dostarczenia, a nie że trafiła do skrzynki: accepted to lista adresów potwierdzona przez samego Stalwart, a niepuste rejected w odpowiedzi z code: 1 oznacza, że Stalwart przyjął niektórych odbiorców, a innym odmówił. Za tym wywołaniem nie stoi żaden webhook dostarczenia: odpowiedź code: 1 to cały sygnał, jaki dostajesz od samego test_email.

Błędy

Dalej