ای میل بھیجیں
/v3/smtp/email اینڈ پوائنٹ استعمال کرتے ہوئے انفرادی ٹرانزیکشنل ای میلز بھیجیں۔
اینڈ پوائنٹ
POST /v3/smtp/emailدرخواست کی باڈی
بنیادی ای میل
{ "sender": { "name": "Your App", }, "to": [ { "name": "John Doe" } ], "subject": "Welcome to our service!", "htmlContent": "<html><body><h1>Welcome!</h1><p>Thank you for signing up.</p></body></html>"}جدید ای میل
{ "sender": { "name": "Your App", }, "to": [ { "name": "John Doe" } ], "cc": [ { "name": "CC User" } ], "bcc": [ { } ], "subject": "Order Confirmation #{{order_id}}", "htmlContent": "<html><body><h1>Order Confirmed</h1><p>Your order {{order_id}} has been confirmed.</p></body></html>", "textContent": "Your order {{order_id}} has been confirmed.", "params": { "order_id": "12345" }, "tags": ["transactional", "order-confirmation"], "headers": { "X-Custom-Header": "custom-value" }}کوڈ کی مثالیں
JavaScript/Node.js
const brevo = require('@getbrevo/brevo');
const apiInstance = new brevo.TransactionalEmailsApi();apiInstance.setApiKey(brevo.TransactionalEmailsApiApiKeys.apiKey, process.env.BREVO_API_KEY);
const sendEmail = async () => { const sendSmtpEmail = new brevo.SendSmtpEmail();
sendSmtpEmail.subject = "Welcome to our service!"; sendSmtpEmail.htmlContent = "<html><body><h1>Welcome!</h1></body></html>";
try { const result = await apiInstance.sendTransacEmail(sendSmtpEmail); console.log('Email sent:', result); return result; } catch (error) { console.error('Error sending email:', error); throw error; }};Python
import sib_api_v3_sdkfrom sib_api_v3_sdk.rest import ApiException
configuration = sib_api_v3_sdk.Configuration()configuration.api_key['api-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration))
send_smtp_email = sib_api_v3_sdk.SendSmtpEmail( subject="Welcome to our service!", html_content="<html><body><h1>Welcome!</h1></body></html>")
try: api_response = api_instance.send_transac_email(send_smtp_email) print(api_response)except ApiException as e: print("Exception when calling TransactionalEmailsApi->send_transac_email: %s\n" % e)cURL
curl -X POST "https://api.brevo.com/v3/smtp/email" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "api-key: YOUR_API_KEY" \ -d '{ "sender": { "name": "Your App", "email": "[email protected]" }, "to": [ { "email": "[email protected]", "name": "John Doe" } ], "subject": "Welcome to our service!", "htmlContent": "<html><body><h1>Welcome!</h1></body></html>" }'جواب
کامیابی کا جواب (201 Created)
{}خامی کے جوابات
غلط API کلید (401)
{ "code": "unauthorized", "message": "Invalid API key provided"}ای میل کا غلط فارمیٹ (400)
{ "code": "invalid_parameter", "message": "Invalid email format in 'to' field"}ریٹ لمٹ سے تجاوز (429)
{ "code": "too_many_requests", "message": "Rate limit exceeded"}پیرامیٹرز
لازمی پیرامیٹرز
| پیرامیٹر | قسم | تفصیل |
|---|---|---|
sender | object | بھیجنے والے کی معلومات |
to | array | وصول کنندگان کے آبجیکٹس کی array |
subject | string | ای میل کی سبجیکٹ لائن |
اختیاری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل |
|---|---|---|
htmlContent | string | ای میل کا HTML مواد |
textContent | string | ای میل کا ٹیکسٹ مواد |
cc | array | CC وصول کنندگان |
bcc | array | BCC وصول کنندگان |
replyTo | object | جواب دینے کا پتہ |
attachments | array | فائل اٹیچمنٹس |
params | object | ٹیمپلیٹ کے پیرامیٹرز |
tags | array | ٹریکنگ کے لیے ای میل ٹیگز |
headers | object | کسٹم ہیڈرز |
ٹیمپلیٹ ویری ایبلز
اپنے سبجیکٹ اور مواد میں ٹیمپلیٹ ویری ایبلز استعمال کریں:
{ "subject": "Welcome {{firstName}}!", "htmlContent": "<h1>Hello {{firstName}} {{lastName}}</h1>", "params": { "firstName": "John", "lastName": "Doe" }}اٹیچمنٹس
فائل اٹیچمنٹس شامل کریں:
{ "attachments": [ { "content": "base64_encoded_content", "name": "invoice.pdf" }, { "url": "https://example.com/document.pdf", "name": "document.pdf" } ]}بہترین طریقے
- HTML اور ٹیکسٹ دونوں مواد ہمیشہ شامل کریں تاکہ ڈیلیوری بہتر ہو
- ٹیمپلیٹ ویری ایبلز استعمال کریں، مواد کو جوڑنے کے بجائے
- بھیجنے والے کی درست معلومات شامل کریں تاکہ اسپام فلٹرز سے بچا جا سکے
- ٹیگز شامل کریں ٹریکنگ اور اینالیٹکس کے لیے
- ای میل پتوں کی تصدیق کریں بھیجنے سے پہلے
- خامیوں کو احتیاط سے سنبھالیں ری ٹرائی لاجک کے ساتھ
ریٹ لمٹس
- API ریٹ لمٹ: جنرل ٹائر پر، جو ہر پلان کو ملتا ہے، یہ اینڈ پوائنٹ فی سیکنڈ 1,000 اور فی گھنٹہ 3,600,000 درخواستوں کی اجازت دیتا ہے۔ ایڈوانسڈ ٹائر (Professional اور Enterprise) فی سیکنڈ 2,000 اور ایکسٹینڈڈ ٹائر (Enterprise) 6,000 کی اجازت دیتا ہے۔
- بھیجنے کا حجم: آپ کتنی ای میلز بھیج سکتے ہیں، یہ آپ کے Brevo پلان سے طے ہوتا ہے، جو ریٹ لمٹ سے الگ ہے۔
ریٹ لمٹس اور Brevo کا ریٹ لمٹس صفحہ دیکھیں۔
ٹریکنگ
اس اینڈ پوائنٹ کے ذریعے بھیجی گئی ای میلز کے لیے یہ خودکار طور پر ٹریک ہوتا ہے:
- ڈیلیوری کی حالت
- اوپن ریٹس
- کلک ٹریکنگ
- باؤنس ہینڈلنگ
تفصیلی اینالیٹکس اپنے Brevo ڈیش بورڈ میں Statistics → Transactional کے تحت دیکھیں۔
متعلقہ اینڈ پوائنٹس
- ای میل ٹیمپلیٹس
- اٹیچمنٹس
- ای میل کے اعدادوشمار