Hopp til innholdet
Bekreftet

Send en e-post

Bekreft at utgående e-post er koblet opp med ett kall, før en ekte varsling avhenger av det.

test_email sender én ekte melding gjennom den samme Stalwart-innleveringsveien som all plattform-e-post bruker, utgående fra @xuda.ai, med DKIM og SPF på linje. Det er ingenting å sette opp først: kall den, sjekk innboksen (eller feilen), så vet du at utgående e-post fungerer før noe annet i integrasjonen din avhenger av det.

Metode

POST/cpi/test_email
admin

Test Email

Runs a test for email.

To felt til som registeret ikke viser

test_email deklarerer ett obligatorisk felt, email. Behandleren leser også et valgfritt app_id (henter det prosjektets merkevare inn i malen, utelatt betyr Xudas egen plattformmerkevare) og et valgfritt from (en annen Xuda-postboks å sende som, dens egen innleveringslegitimasjon må allerede finnes på serversiden). Begge er gjengitt her fra kildekoden, ikke fra registeret.

Gjennomgang

Send den

Bare api_key og adressen du vil motta 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 rett 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 betyr at innleveringsserveren tok imot meldingen for levering, ikke at den havnet i innboksen. accepted er adresselisten Stalwart selv bekreftet, og en rejected som ikke er tom i et ellers code: 1-svar betyr at Stalwart godtok noen mottakere og avviste andre. Det finnes ingen leveringswebhook bak dette kallet: et code: 1-svar er hele signalet du får fra selve test_email.

Feil

Neste