مرجع حمولة البريد الإلكتروني

مرجع لرسالة EmailPayload المستخدمة بواسطة Notify عند إرسال بريد إلكتروني.

ملاحظة

لحمولات الإشعارات الفورية / الرسائل القصيرة / تطبيقات المراسلة، راجع مرجع الحمولة.

EmailPayload

• subject (map<string, string>): سطر الموضوع مفهرس حسب اللغة، على سبيل المثال {"en": "Hello!", "es": "¡Hola!"}.
• body (string): محتوى البريد الإلكتروني بصيغة HTML. لمحتويات HTML لكل لغة، استخدم email_template مع قالب بريد إلكتروني تم تكوينه في لوحة التحكم.
• attachments (array of Attachment): مرفقات الملفات.
• list_unsubscribe (string): عنوان URL مخصص لترويسة List-Unsubscribe.
• from (Address): تجاوز From الافتراضي الذي تم تكوينه في إعدادات البريد الإلكتروني للتطبيق.
• reply_to (Address): تجاوز Reply-To الافتراضي الذي تم تكوينه في إعدادات البريد الإلكتروني للتطبيق.
• email_template (string): رمز قالب بريد إلكتروني لاستخدامه بدلاً من body مضمن.

Attachment

{
  "name": "invoice.pdf",
  "content": "<base64-encoded bytes>"
}

الحقل	النوع	الوصف
name	string	اسم الملف كما يراه المستلم.
content	string	محتوى الملف بترميز Base64.

Address

{
  "name":  "Pushwoosh",
  "email": "support@example.com"
}

كلا الحقلين اختياريان. إذا تم حذف name، سيرى المستلم عنوان البريد الإلكتروني الخام.

مثال: إرسال بريد إلكتروني إلى شريحة

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "segment": {
      "application": "XXXXX-XXXXX",
      "platforms": ["EMAIL"],
      "code": "newsletter_subscribers",
      "email_payload": {
        "subject": { "en": "Our May updates", "es": "Novedades de mayo" },
        "email_template": "may-digest-2026",
        "from":     { "name": "Pushwoosh Team", "email": "news@example.com" },
        "reply_to": { "email": "replies@example.com" }
      },
      "schedule": { "at": "2026-05-01T09:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

مثال: بريد إلكتروني للمعاملات مع مرفق

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "transactional": {
      "application": "XXXXX-XXXXX",
      "platforms": ["EMAIL"],
      "users": { "list": ["customer-42"] },
      "email_payload": {
        "subject": { "en": "Your invoice" },
        "body":    "<p>Please find your invoice attached.</p>",
        "attachments": [
          { "name": "invoice.pdf", "content": "JVBERi0xLjQKJe..." }
        ]
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_TRANSACTIONAL"
    }
  }'