Vai al contenuto
Verificata

Inviare un'email

Verifica con una sola chiamata che la posta in uscita sia configurata, prima che una vera notifica ne dipenda.

test_email invia un vero messaggio attraverso lo stesso percorso di submission Stalwart che usa ogni email della piattaforma, in uscita da @xuda.ai, con DKIM e SPF allineati. Non c'è nulla da configurare prima: chiamalo, controlla la casella (o l'errore) e sai che la posta in uscita funziona prima che qualsiasi altra parte della tua integrazione ne dipenda.

Metodo

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Altri due campi che il registro non elenca

test_email dichiara un solo campo obbligatorio, email. Il gestore legge anche un app_id facoltativo (porta nel modello il branding di quel progetto; se omesso, vale il branding Xuda della piattaforma) e un from facoltativo (un'altra casella Xuda da cui inviare, la cui credenziale di submission deve già esistere lato server). Entrambi sono riportati qui sotto dal sorgente, non dal registro.

Procedura

Invialo

Basta api_key e l'indirizzo a cui vuoi ricevere il 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'])

La risposta

data è l'oggetto risultato SMTP di nodemailer, passato così com'è:

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 significa che il server di submission ha accettato il messaggio per la consegna, non che sia arrivato nella casella: accepted è l'elenco di indirizzi che Stalwart stesso ha confermato, e un rejected non vuoto in una risposta altrimenti code: 1 significa che Stalwart ha accettato alcuni destinatari e ne ha rifiutati altri. Dietro questa chiamata non c'è alcun webhook di consegna: una risposta code: 1 è tutto il segnale che ottieni da test_email stesso.

Errori

Passi successivi