Přeskočit na obsah
Ověřeno

Odeslat e-mail

Jedním voláním ověřte, že odchozí pošta funguje, než na ní začne záviset skutečné oznámení.

test_email odešle jednu skutečnou zprávu toutéž odesílací cestou Stalwart, kterou používá každý e-mail platformy, odchozí z @xuda.ai, s DKIM a SPF. Nic není třeba předem nastavovat: zavolejte ji, zkontrolujte schránku (nebo chybu) a víte, že odchozí pošta funguje, než na ní cokoli dalšího ve vaší integraci začne záviset.

Metoda

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Dvě další pole, která registr neuvádí

test_email deklaruje jedno povinné pole, email. Obslužná rutina čte také volitelné app_id (do šablony vloží branding daného projektu; bez něj se použije vlastní branding platformy Xuda) a volitelné from (jiná schránka Xuda, jako kterou odeslat; její odesílací pověření už musí na serveru existovat). Obě jsou zde uvedena ze zdrojového kódu, ne z registru.

Postup

Odeslat

Stačí api_key a adresa, na kterou chcete test přijmout.

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

Odpověď

data je vlastní výsledný objekt SMTP z nodemaileru, předaný beze změny:

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 znamená, že odesílací server přijal zprávu k doručení, ne že dorazila do schránky, accepted je seznam adres, které Stalwart sám potvrdil, a neprázdné rejected u jinak úspěšné odpovědi code: 1 znamená, že Stalwart některé příjemce přijal a jiné odmítl. Za tímto voláním není žádný webhook doručení: odpověď code: 1 je veškerý signál, který ze samotného test_email dostanete.

Chyby

Dále