Preskočiť na obsah
Overené

Poslať e-mail

Overte jedným volaním, že odchádzajúca pošta je zapojená, skôr než sa na ňu spoľahne skutočné upozornenie.

test_email odošle jednu skutočnú správu rovnakou cestou odosielania Stalwart, akou prechádza každý e-mail platformy, odchádzajúca pošta @xuda.ai, DKIM a SPF zarovnané. Nie je nič, čo by ste museli najprv nastaviť: zavolajte ju, skontrolujte schránku (alebo chybu) a viete, že odchádzajúca pošta funguje, skôr než na nej bude závisieť čokoľvek iné vo vašej integrácii.

Method

POST/cpi/test_email
admin

Test Email

Runs a test for email.

Dve ďalšie polia, ktoré register neuvádza

test_email deklaruje jedno povinné pole, email. Obsluha číta aj voliteľné app_id (vtiahne do šablóny značku daného projektu; vynechané znamená vlastnú značku Xuda platformy) a voliteľné from (iná schránka Xuda, z ktorej sa odošle, jej vlastné prihlasovacie údaje na odosielanie už musia existovať na strane servera). Obe sú nižšie uvedené podľa zdroja, nie podľa registra.

Walkthrough

Send it

Len api_key a adresa, na ktorú chcete test prijať.

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

The response

data je vlastný výsledný objekt SMTP z nodemailer, odovzdaný priamo:

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 znamená, že odosielací server prijal správu na doručenie, nie že pristála v schránke, accepted je zoznam adries, ktorý potvrdil sám Stalwart, a neprázdne rejected pri inak úspešnej odpovedi code: 1 znamená, že Stalwart niektorých príjemcov prijal a iných odmietol. Za týmto volaním nestojí žiadny webhook doručenia: odpoveď code: 1 je celý signál, ktorý z test_email samotného dostanete.

Errors

Next