Имэйл илгээх
Энэ хүсэлтээр та өөрийн апп-аас имэйл илгээнэ. Жишээ нь захиалгын баталгаажуулалт, нууц үг сэргээх имэйл, төлбөрийн баримт. Гарчиг, агуулгыг таны апп илгээх бөгөөд Maildy имэйлийг таны өөрийн домэйноос хүргэнэ.
POST https://app.maildy.mn/api/v2/send
Имэйлийн загвараа Maildy-д хадгалаад зөвхөн нэр, дугаар зэргийг апп-аасаа бөглөх бол Загвараар илгээх хүсэлтийг ашиглана уу.
Эхлэхийн өмнө
Танд дараах гурван зүйл хэрэгтэй:
- Pro эсвэл Enterprise багц. API-аар илгээх боломж бусад багцад байхгүй.
- Баталгаажсан илгээх домэйн. Домэйн хэсэгт домэйнээ нэмж, DNS тохиргоог дуусгана. Зөвхөн баталгаажсан домэйн дээрх хаягаас илгээх боломжтой.
- Илгээх хандалт эсвэл Бүрэн хандалт бүхий API түлхүүр. API түлхүүр хэсгийг үзнэ үү.
Хүсэлт
API түлхүүрээ X-Api-Key толгойд илгээнэ.
curl -X POST 'https://app.maildy.mn/api/v2/send' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"to": ["[email protected]"],
"from": "[email protected]",
"subject": "Таны 12345 дугаартай захиалга баталгаажлаа",
"html": "<p>Сайн байна уу, Бат.</p><p>Захиалга өгсөнд баярлалаа.</p>"
}'
Хүсэлтийн талбарууд
| Талбар | Төрөл | Тайлбар | |
|---|---|---|---|
to | текстийн жагсаалт | Заавал | Хүлээн авагчийн хаягууд. Жагсаалтын хаяг бүр имэйлийг хүлээн авна. |
subject | текст | Заавал | Имэйлийн гарчиг. |
html | текст | Тайлбарыг үз | HTML агуулга. |
text | текст | Тайлбарыг үз | Энгийн текст агуулга. Зөвхөн html илгээвэл энгийн текст хувилбарыг түүнээс үүсгэнэ. Зөвхөн text илгээвэл имэйл энгийн текст хэлбэртэй очно. |
from | текст | Заавал биш | Илгээгчийн хаяг, жишээ нь [email protected]. Баталгаажсан домэйн дээрх хаяг байх ёстой. Орхивол эхний баталгаажсан домэйны noreply@ хаягаас илгээнэ. |
attachments | объектын жагсаалт | Заавал биш | Имэйлд хавсаргах файлууд. Хавсралт хэсгийг үз. |
html, text хоёрын аль нэгийг, эсвэл хоёуланг нь илгээнэ. Ядаж нэг нь заавал байх ёстой.
Агуулгын аль нэг хэсэгт таны хэрэглэгчийн бичсэн текст орж байвал html-д оруулахаасаа өмнө escape хийнэ үү.
Хавсралт
Нэхэмжлэх, хуулга зэрэг PDF болон бусад файл хавсаргах бол хүсэлтэд attachments нэмнэ. Жагсаалтын нэг мөр нь нэг файл:
{
"to": ["[email protected]"],
"subject": "Таны 10-р сарын хуулга",
"html": "<p>Сайн байна уу, Бат.</p><p>Хуулгыг хавсаргав.</p>",
"attachments": [
{
"filename": "huulga-2026-10.pdf",
"content": "JVBERi0xLjcKJeLjz9MK..."
}
]
}
| Талбар | Төрөл | Тайлбар | |
|---|---|---|---|
filename | текст | Заавал | Хүлээн авагчид харагдах файлын нэр, өргөтгөлтэйгөө. |
content | текст | Заавал | Файл өөрөө, base64 хэлбэрээр кодлогдсон. |
contentType | текст | Заавал биш | Файлын MIME төрөл, жишээ нь application/pdf. Орхивол файлын нэрийн өргөтгөлөөс тодорхойлно. |
Нэг имэйлд 10 хүртэл файл, нийт 8 MB хүртэл хавсаргаж болно (base64 болгохоос өмнөх хэмжээгээр). to талбарт хэд хэдэн хаяг байвал хүлээн авагч бүрт бүх файл очно.
Файлын нэр эсвэл агуулга байхгүй, base64 буруу, эсвэл хэмжээ хязгаараас хэтэрсэн бол хүсэлт 400 хариу буцаана. Аль файл буруу байгааг message хэлэх ба имэйл илгээгдэхгүй.
Хариу
Амжилттай илгээвэл хоосон биетэй 200 OK хариу ирнэ. Амжилттай хариуны биеийг JSON гэж уншиж болохгүй.
Хүсэлт амжилтгүй болбол хариуны бие нь JSON объект байх ба message талбар нь алдааг тайлбарлана.
| Төлөв | Хэзээ гардаг вэ |
|---|---|
| 400 | to хоосон, subject байхгүй, html, text хоёрын аль нь ч ирээгүй, from хаяг баталгаажсан домэйн дээр биш, эсвэл хавсралт буруу. |
| 401 | X-Api-Key толгой байхгүй, эсвэл түлхүүр буруу, идэвхгүй болсон. |
| 403 | Түлхүүрт илгээх эрх байхгүй, эсвэл бүртгэл түдгэлзсэн. Илгээх хандалт эсвэл Бүрэн хандалт бүхий түлхүүр ашиглана уу. |
| 429 | Таны бүртгэлийн имэйлийн эрх дууссан. |
| 500 | Бүртгэл API-аар илгээх боломжгүй байна: багцад ороогүй, эсвэл баталгаажсан домэйн байхгүй. Аль нь болохыг message хэлнэ. |
Хязгаар
Pro болон Enterprise багцад API-аар илгээх цагийн болон өдрийн хязгаар байхгүй, хүсэлтийн тоог ч хязгаарладаггүй. Апп доторх үйл явдал бүрт нэг хүсэлт илгээнэ үү, жишээ нь захиалга бүрт нэг баталгаажуулалт. Нэг имэйлийг жагсаалт бүхэлдээ рүү илгээх бол кампанит ажил ашиглана уу.
SMTP
Таны апп эсвэл фреймворк SMTP-ээр имэйл илгээдэг бол Pro болон Enterprise багцад SMTP хандалт мөн багтсан. Тохиргоо → SMTP хэсэгт хост, порт, хэрэглэгчийн нэр, нууц үг харагдана. Нэвтрэх эрх үүсээгүй бол тэр хуудсанд үүсгэж болно.
Кодын жишээ
JavaScript
const response = await fetch('https://app.maildy.mn/api/v2/send', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
to: ['[email protected]'],
from: '[email protected]',
subject: 'Таны 12345 дугаартай захиалга баталгаажлаа',
html: '<p>Сайн байна уу, Бат.</p><p>Захиалга өгсөнд баярлалаа.</p>'
})
})
if (!response.ok) {
const error = await response.json()
console.error(response.status, error.message)
}
Python
import requests
response = requests.post(
'https://app.maildy.mn/api/v2/send',
headers={'X-Api-Key': 'YOUR_API_KEY'},
json={
'to': ['[email protected]'],
'from': '[email protected]',
'subject': 'Таны 12345 дугаартай захиалга баталгаажлаа',
'html': '<p>Сайн байна уу, Бат.</p><p>Захиалга өгсөнд баярлалаа.</p>',
},
)
if response.status_code != 200:
print(response.status_code, response.json().get('message'))
PHP
<?php
$ch = curl_init('https://app.maildy.mn/api/v2/send');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'X-Api-Key: YOUR_API_KEY',
'Content-Type: application/json'
],
CURLOPT_POSTFIELDS => json_encode([
'to' => ['[email protected]'],
'from' => '[email protected]',
'subject' => 'Таны 12345 дугаартай захиалга баталгаажлаа',
'html' => '<p>Сайн байна уу, Бат.</p><p>Захиалга өгсөнд баярлалаа.</p>'
])
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status !== 200) {
echo $status . ' ' . json_decode($body, true)['message'];
}
$1{}