Sari la conținut
Verificat

Trimite un e-mail

Confirmă cu un singur apel că poșta de ieșire este configurată, înainte ca o notificare reală să depindă de ea.

test_email trimite un mesaj real prin aceeași cale de trimitere Stalwart pe care o folosește fiecare e-mail al platformei, de ieșire @xuda.ai, cu DKIM și SPF aliniate. Nu trebuie configurat nimic înainte: îl apelezi, verifici inboxul (sau eroarea) și știi că poșta de ieșire funcționează înainte ca orice altceva din integrarea ta să depindă de ea.

Metodă

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Încă două câmpuri pe care registrul nu le listează

test_email declară un singur câmp obligatoriu, email. Handlerul citește și un app_id opțional (aduce brandingul acelui proiect în șablon; omis înseamnă brandingul propriu al platformei Xuda) și un from opțional (o altă căsuță Xuda de pe care să trimită, al cărei credențial de trimitere trebuie să existe deja pe server). Ambele sunt reproduse mai jos din sursă, nu din registru.

Parcurgere

Trimiteți

Doar api_key și adresa la care vrei să primești testul.

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

Răspunsul

data este chiar obiectul de rezultat SMTP al nodemailer, transmis neschimbat:

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 înseamnă că serverul de trimitere a acceptat mesajul pentru livrare, nu că a ajuns în inbox, accepted este lista de adrese confirmată chiar de Stalwart, iar un rejected negol într-un răspuns altfel code: 1 înseamnă că Stalwart a acceptat unii destinatari și i-a refuzat pe alții. În spatele acestui apel nu există niciun webhook de livrare: un răspuns code: 1 este întregul semnal pe care îl primești de la test_email însuși.

Erori

Urmează