Gå til indhold
Bekræftet

Send en e-mail

Bekræft med ét kald, at udgående mail er sat op, før en reel notifikation afhænger af den.

test_email sender én rigtig besked gennem den samme Stalwart-afsendelsessti, som al platformens e-mail bruger, @xuda.ai udgående, med DKIM og SPF på linje. Der er intet at konfigurere først: kald den, tjek indbakken (eller fejlen), og du ved, at udgående mail virker, før noget andet i din integration afhænger af den.

Metode

POST/cpi/test_email
admin

Test Email

Runs a test for email.

To felter mere, som registret ikke viser

test_email erklærer ét obligatorisk felt, email. Handleren læser også et valgfrit app_id (trækker det projekts branding ind i skabelonen; udeladt betyder platformens egen Xuda-branding) og et valgfrit from (en anden Xuda-postkasse at sende som, dens egen afsendelseslegitimation skal allerede findes på serversiden). Begge er gengivet nedenfor fra kildekoden, ikke fra registret.

Gennemgang

Send den

Kun api_key og den adresse, du vil modtage testen på.

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

Svaret

data er nodemailers eget SMTP-resultatobjekt, sendt direkte videre:

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 betyder, at afsendelsesserveren har accepteret beskeden til levering, ikke at den er havnet i indbakken. accepted er den adresseliste, Stalwart selv har bekræftet, og et ikke-tomt rejected på et ellers code: 1-svar betyder, at Stalwart accepterede nogle modtagere og afviste andre. Der er ingen leveringswebhook bag dette kald: et code: 1-svar er hele det signal, du får fra test_email selv.

Fejl

Næste