رفتن به محتوای اصلی
سندک

مستنداتارسال

پیوست

ارسال فایل پیوست و تصویر درون‌متنی با API.

آخرین ویرایش: ۲۱ آبان ۱۴۰۵

پیوست‌ها در بدنه‌ی JSON و به‌صورت base64 فرستاده می‌شوند.

نمونه

بدنه
{
  "from": "hello@shop.ir",
  "to": ["ali@gmail.com"],
  "subject": "فاکتور سفارش ۱۲۰۱",
  "text": "فاکتور پیوست است.",
  "attachments": [
    {
      "filename": "invoice-1201.pdf",
      "content_type": "application/pdf",
      "content": "JVBERi0xLjQK…"
    }
  ]
}

با پایتون یا هر زبان دیگر، فایل را بخوانید و محتوا را base64 کنید. در پوسته:

base64
base64 -w0 invoice-1201.pdf

فیلدها

فیلدتوضیح
filenameلازم؛ حداکثر ۲۰۰ نویسه، بدون نویسه‌ی کنترلی
contentلازم؛ محتوای base64
content_typeاختیاری؛ مثل application/pdf
content_idاختیاری؛ برای تصویر درون‌متنی

تصویر درون‌متنی

برای نمایش تصویر داخل متن HTML، content_id بدهید و در HTML با cid: به آن اشاره کنید:

تصویر درون‌متنی
{
  "html": "<p>لوگو:</p><img src=\"cid:logo\">",
  "attachments": [
    { "filename": "logo.png", "content_type": "image/png", "content_id": "logo", "content": "iVBORw0KGgo…" }
  ]
}

محدودیت‌ها

  • حداکثر ۱۰ پیوست در هر پیام.
  • مجموع اندازه‌ی پیوست‌ها حداکثر ۱۰ مگابایت است (پیش از base64)؛ بیشتر از آن خطای attachment_too_large (۴۱۳).
  • محتوایی که base64 معتبر نباشد خطای attachment_invalid (۴۲۲) می‌دهد.
  • بعضی نوع فایل‌ها، مثل فایل‌های اجرایی، رد می‌شوند و خطای attachment_blocked (۴۲۲) می‌دهند. این از امنیت گیرنده‌ها و اعتبار ارسال محافظت می‌کند.

نکته: پیوست بزرگ به گیرنده‌ی کند یا صندوق محدود برمی‌خورد و احتمال برگشت را بالا می‌برد. برای فایل‌های بزرگ، پیوند دانلود بفرستید.