Aller au contenu
Vérifié

Envoyer un e-mail

Confirmez que le courrier sortant est en place avec un seul appel, avant qu'une vraie notification en dépende.

test_email envoie un vrai message par le même chemin de soumission Stalwart que tous les e-mails de la plateforme, en sortie depuis @xuda.ai, avec DKIM et SPF alignés. Il n'y a rien à configurer d'abord : appelez-la, vérifiez la boîte de réception (ou l'erreur), et vous savez que le courrier sortant fonctionne avant que le reste de votre intégration n'en dépende.

Méthode

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Deux champs de plus que le registre ne liste pas

test_email déclare un seul champ obligatoire, email. Le gestionnaire lit aussi un app_id facultatif (il reprend l'image de marque de ce projet dans le modèle ; omis, c'est l'image de marque Xuda de la plateforme) et un from facultatif (une autre boîte Xuda à utiliser comme expéditeur ; son identifiant de soumission doit déjà exister côté serveur). Les deux sont reproduits ci-dessous à partir de la source, pas du registre.

Pas à pas

Envoyez-le

Juste api_key et l'adresse à laquelle vous voulez recevoir le 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 réponse

data est l'objet de résultat SMTP propre à nodemailer, transmis tel quel :

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 signifie que le serveur de soumission a accepté le message pour livraison, pas qu'il est arrivé dans la boîte de réception : accepted est la liste d'adresses que Stalwart lui-même a confirmée, et un rejected non vide sur une réponse par ailleurs à code: 1 signifie que Stalwart a accepté certains destinataires et en a refusé d'autres. Aucun webhook de livraison ne se trouve derrière cet appel : une réponse code: 1 est tout le signal que test_email vous donne par lui-même.

Erreurs

Suite