דילוג לתוכן
אומת

שליחת אימייל

לוודא בקריאה אחת שהדואר היוצא מחובר, לפני שהתראה אמיתית תלויה בו.

test_email שולחת הודעה אמיתית אחת דרך אותו מסלול הגשה של Stalwart שכל אימייל של הפלטפורמה משתמש בו, יוצא מ-@xuda.ai, עם DKIM ו-SPF מיושרים. אין מה להגדיר קודם: קוראים לה, בודקים את תיבת הדואר (או את השגיאה), וכך יודעים שהדואר היוצא עובד לפני שמשהו אחר באינטגרציה שלכם תלוי בו.

שיטה

POST/cpi/test_email
admin

Test Email

Runs a test for email.

שני שדות נוספים שהרישום לא מפרט

test_email מצהירה על שדה חובה אחד, email. ה-handler קורא גם app_id אופציונלי (מושך את המיתוג של אותו פרויקט אל התבנית; כשמושמט, זה המיתוג של Xuda עצמה) ו-from אופציונלי (תיבת Xuda אחרת לשלוח ממנה, פרטי ההגשה שלה צריכים כבר להתקיים בצד השרת). שניהם משוחזרים להלן מהקוד המקורי, לא מהרישום.

הדרכה צעד אחר צעד

שולחים

רק api_key והכתובת שרוצים לקבל בה את הבדיקה.

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

התשובה

data הוא אובייקט תוצאת ה-SMTP של nodemailer עצמו, מועבר כמות שהוא:

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 אומר ששרת ההגשה קיבל את ההודעה למסירה, לא שהיא הגיעה לתיבת הדואר, accepted היא רשימת הכתובות ש-Stalwart עצמו אישר, ו-rejected לא ריק בתשובה שבכל מקרה היא code: 1 אומר ש-Stalwart קיבל חלק מהנמענים וסירב לאחרים. אין webhook של מסירה מאחורי הקריאה הזו: תשובה עם code: 1 היא כל האות שמקבלים מ-test_email עצמה.

שגיאות

הבא