ارسال با SMTP

هر چیزی که از راه یک سرور SMTP ایمیل می‌فرستد می‌تواند از راه OpenEmail بفرستد: ارسال‌کنندهٔ ایمیلِ یک فریم‌ورک، یک CMS، یک ابزار پایش، یک چاپگر. با نام کاربری openemail و یک کلید API به‌عنوان گذرواژه وارد شوید. کلید به اسکوپ emails:send نیاز دارد، و پیامی که می‌سپارد همان ارسالی است که POST /emails با آن کلید انجام می‌دهد.

یک پیام را با نام message.eml ذخیره کنید و آن را با curl بسپارید. From باید نشانی‌ای باشد که کلید اجازهٔ ارسال با آن را دارد.

From: Acme <[email protected]>To: [email protected]Subject: Hello over SMTPMessage-ID: <[email protected]> It works.

curl --url "smtps://smtp.openemail.uk:465" \  --user "openemail:$OPENEMAIL_API_KEY" \  --mail-from "[email protected]" \  --mail-rcpt "[email protected]" \  --upload-file message.eml --crlf

curl --ssl-reqd --url "smtp://smtp.openemail.uk:587" \  --user "openemail:$OPENEMAIL_API_KEY" \  --mail-from "[email protected]" \  --mail-rcpt "[email protected]" \  --upload-file message.eml --crlf

پاسخ به پیامِ پذیرفته‌شده 250 2.0.0 OK queued as است و پس از آن شناسه‌اش می‌آید. این همان شناسه‌ای است که GET /emails/{id} می‌گیرد، پس پیام، رویدادهایش و ردیابی‌اش مثل هر ارسال دیگری خوانده می‌شوند.

پیام از همان راهی خوانده و فرستاده می‌شود که یک ارسال REST، پس دوباره از بخش‌هایش ساخته می‌شود و بایت به بایت عبور داده نمی‌شود.

هر چیزی که یک ارسال REST به آن پایبند است اینجا هم برقرار است، چون یک راه است.

• —اسکوپ‌های کلید، و نشانی‌ها و دامنه‌هایی که به آن‌ها محدود است.
• —بررسی فرستنده: From نشانی‌ای روی دامنه‌ای است که می‌تواند بفرستد، و نشانی‌ای که کلید اجازهٔ ارسال با آن را دارد.
• —سهمیهٔ ارسال فضای کاری و فهرست توقیف آن.
• —امضا و ردیابی بازشدن و کلیکِ نشانی‌ای که پیام از آن فرستاده می‌شود، مثل یک ارسال REST که نه signature را تنظیم می‌کند و نه tracking را.
• —مسیر: تا وقتی مسیر ارسال‌های گروهی متوقف است، پیامی با X-OpenEmail-Stream: broadcast رد می‌شود.
• —وب‌هوک‌ها و رویدادهای تحویل، که پیام را با شناسهٔ داخل پاسخ 250 نام می‌برند.

پیامی که Message-ID دارد یک بار فرستاده می‌شود. سپردن دوبارهٔ همان Message-ID برای همان گیرنده‌ها با شناسهٔ پیام نخست پاسخ می‌گیرد و چیزی نمی‌فرستد، پس نرم‌افزاری که پس از قطع شدن اتصال دوباره تلاش می‌کند نمی‌تواند آن را دو بار بفرستد. همان پیام برای گیرنده‌های دیگر یک ارسال دیگر است. به ایدمپوتنسی نگاه کنید.

هر پیامی که یک کلید می‌سپارد یک سطر در گزارش درخواست‌های آن است، با متد SMTP، مسیر /emails و وضعیتی که یک ارسال REST می‌داشت: 202 وقتی در صف قرار گرفته، و 403، 422 یا 429 با همان code خطا وقتی رد شده است. GET /keys/{id}/requests?path=/emails آن‌ها را کنار ارسال‌های REST فهرست می‌کند. ورودی که با یک کلید واقعی ناموفق باشد در فعالیت همان کلید دیده می‌شود.