Naar de inhoud springen
Geverifieerd

Een e-mail versturen

Controleer met één aanroep of uitgaande mail is aangesloten, voordat een echte melding ervan afhangt.

test_email verstuurt één echt bericht via hetzelfde Stalwart-submissionpad dat elke e-mail van het platform gebruikt: uitgaand vanaf @xuda.ai, met DKIM en SPF in lijn. Er hoeft niets vooraf te worden ingesteld: roep hem aan, controleer de inbox (of de fout), en je weet dat uitgaande mail werkt voordat iets anders in je integratie ervan afhangt.

Methode

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Twee velden meer die het register niet vermeldt

test_email declareert één verplicht veld, email. De handler leest ook een optionele app_id (haalt de huisstijl van dat project in het sjabloon; weggelaten betekent de eigen Xuda-huisstijl van het platform) en een optionele from (een ander Xuda-postvak om mee te versturen, waarvan het eigen submissiongegeven al aan serverzijde moet bestaan). Beide zijn hieronder uit de broncode overgenomen, niet uit het register.

Stappenplan

Verstuur het

Alleen api_key en het adres waarop je de test wilt ontvangen.

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

Het antwoord

data is het eigen SMTP-resultaatobject van nodemailer, rechtstreeks doorgegeven:

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 betekent dat de submissionserver het bericht heeft geaccepteerd voor aflevering, niet dat het in de inbox is beland. accepted is de adreslijst die Stalwart zelf heeft bevestigd, en een niet-lege rejected bij een verder code: 1-antwoord betekent dat Stalwart sommige ontvangers accepteerde en andere weigerde. Achter deze aanroep zit geen leverwebhook: een antwoord met code: 1 is het hele signaal dat je van test_email zelf krijgt.

Fouten

Volgende stap