Siirry sisältöön
Tarkistettu

Lähetä sähköposti

Varmista yhdellä kutsulla, että lähtevä posti on kytketty, ennen kuin oikea ilmoitus riippuu siitä.

test_email lähettää yhden oikean viestin saman Stalwart-lähetyspolun kautta, jota jokainen alustan sähköposti käyttää: @xuda.ai-lähtevä, DKIM ja SPF kohdistettu. Mitään ei tarvitse määrittää ensin: kutsu sitä, tarkista postilaatikko (tai virhe), ja tiedät, että lähtevä posti toimii, ennen kuin mikään muu integraatiossasi riippuu siitä.

Metodi

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Kaksi kenttää lisää, joita rekisteri ei listaa

test_email ilmoittaa yhden pakollisen kentän, email. Käsittelijä lukee myös valinnaisen app_id:n (tuo kyseisen projektin brändin mallipohjaan; pois jätettynä käytetään alustan omaa Xuda-brändiä) ja valinnaisen from:n (toinen Xuda-postilaatikko, jona lähetetään; sen oman lähetystunnuksen on jo oltava olemassa palvelinpuolella). Molemmat on kirjattu alle lähdekoodista, ei rekisteristä.

Läpikäynti

Lähetä se

Vain api_key ja osoite, johon haluat testin vastaanottaa.

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

Vastaus

data on nodemailerin oma SMTP-tulosobjekti, välitetty sellaisenaan:

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 tarkoittaa, että lähetyspalvelin hyväksyi viestin toimitettavaksi, ei sitä, että se päätyi postilaatikkoon. accepted on osoitelista, jonka Stalwart itse vahvisti, ja ei-tyhjä rejected muuten code: 1 -vastauksessa tarkoittaa, että Stalwart hyväksyi osan vastaanottajista ja hylkäsi toiset. Tämän kutsun takana ei ole toimitus-webhookia: code: 1 -vastaus on koko signaali, jonka saat test_email:ltä itseltään.

Virheet

Seuraavaksi