एपीआई अवलोकन
RealSender आपको API (एप्लिकेशन प्रोग्रामिंग इंटरफेस) के माध्यम से ईमेल संदेश भेजने की सुविधा देता है।
इस तरह आप SMTP (सिंपल मेल ट्रांसफर प्रोटोकॉल) के माध्यम से गुजरे बिना सीधे अपने एप्लिकेशन से ईमेल भेज सकते हैं। हम वर्तमान में केवल POST अनुरोधों का समर्थन करते हैं।
सर्वर पता:
https://rsXXX-api.realsender.com/mail/send
आवश्यक/अनिवार्य मापदंड:
| पैरामीटर |
विवरण |
| एपीआई उपयोगकर्ता |
प्रमाणीकरण उपयोगकर्ता नाम |
| एपीआईपास |
प्रमाणीकरण पासवर्ड |
| से |
प्रेषक का ईमेल पता |
| को |
प्राप्तकर्ता का ईमेल पता |
| विषय |
ईमेल का विषय |
| मूलपाठ |
ईमेल का मुख्य भाग सादे पाठ में |
| एचटीएमएल |
ईमेल बॉडी को HTML प्रारूप में लिखें |
यदि सब कुछ ठीक रहा, तो संदेश भेज दिया जाएगा और आपको एक सकारात्मक JSON उत्तर प्राप्त होगा:
{"success":true}
त्रुटियों की स्थिति में आपको कुछ इस तरह का आउटपुट मिलेगा:
{"success":false,"errorMsgs":["Please provide the 'subject' value."]}
एपीआई विवरण
एपीआई विवरण
सामग्री को UTF-8 अंतर्राष्ट्रीय वर्णसेट का उपयोग करके भेजा जाना चाहिए।
इसे जांचने के लिए, अपने विषय में “€uro” जोड़ें और सबमिट करें। यदि कैरेक्टर सेट गलत है, तो आपको यह JSON चेतावनी प्राप्त होगी:
{"success":false,"errorMsgs":["The 'subject' value is not correctly encoded. It must be UTF-8 encoded."]}
आपने "टेक्स्ट" और "एचटीएमएल" में से एक या दोनों फ़ील्ड भरे हैं या नहीं, इसके आधार पर संदेश इनमें से किसी एक "कंटेंट-टाइप" का उपयोग करके भेजे जाएंगे:
| पैरामीटर |
विवरण |
| मूलपाठ |
text/plain (केवल पाठ) |
| एचटीएमएल |
text/html (केवल html) |
| टेक्स्ट+एचटीएमएल |
मल्टीपार्ट/वैकल्पिक (पाठ और एचटीएमएल दोनों) ईमेल क्लाइंट की सेटिंग्स यह तय करेंगी कि कौन सा हिस्सा प्रदर्शित होगा। |
आवश्यक नहीं/वैकल्पिक पैरामीटर:
| पैरामीटर |
विवरण |
| से नाम |
प्रेषक का विवरण |
| नाम देने के लिए |
प्राप्तकर्ता विवरण |
| को उत्तर |
वह ईमेल पता जिस पर उत्तर प्राप्त होंगे |
| वापसी का पथ |
वह ईमेल पता जिस पर बाउंस हुए ईमेल प्राप्त होंगे यह RealSender के अधिकृत प्रेषकों में मौजूद होना चाहिए। |
| प्रतिलिपि |
कार्बन कॉपी ईमेल पता |
| सीसीनाम |
कार्बन कॉपी विवरण |
| गुप्त प्रतिलिपि |
ब्लाइंड कार्बन कॉपी ईमेल पता |
| बीसीसीनाम |
ब्लाइंड कार्बन कॉपी विवरण |
| संलग्न करना |
संलग्न की जाने वाली फ़ाइलें - एक फ़ाइल कई बार संलग्न की जा सकती है - अधिकतम आकार 3MB फ़ाइल की सामग्री मल्टीपार्ट HTTP POST का हिस्सा होनी चाहिए। INPUT TYPE=FILE के लिए enctype=“multipart/form-data” आवश्यक है |
टू, सीसी और बीसीसी वैल्यू में एक सिंगल ईमेल एड्रेस या कॉमा से अलग की गई ईमेल एड्रेस की लिस्ट हो सकती है।
!! RealSender में प्रत्येक ईमेल के लिए प्राप्तकर्ताओं की कुल संख्या 25 तक सीमित है (इसे 100 तक बढ़ाया जा सकता है)।
सर्वर की प्रतिक्रियाएँ JSON (जावास्क्रिप्ट ऑब्जेक्ट नोटेशन) प्रारूप में होती हैं:
| विवरण |
प्रतिक्रिया |
| ईमेल भेजा गया |
{"success":true} |
| ईमेल नहीं भेजा गया |
{"success":false,"errorMsgs":["..."]} |
एपीआई उदाहरण
एपीआई उदाहरण
POST अनुरोध
PHP के साथ CURL-रहित विधि
<?php
$url = 'https://rsXXX-api.realsender.com/mail/send';
$data = array('apiuser' => 'the one we provided you', 'apipass' => 'the one we provided you', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => 'subject of the message', 'text' => 'email body in plain text', 'html' => 'email body in HTML format');
// use key 'http' even if you send the request to https://...
$options = array(
'http' => array(
'header' => "Content-type: application/x-www-form-urlencoded\r\n",
'method' => 'POST',
'content' => http_build_query($data),
),
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
var_dump($result);
?>
POST अनुरोध
CURL विधि
curl -d 'apiuser=वह पासवर्ड जो हमने आपको दिया है&apipass=वह पासवर्ड जो हमने आपको दिया है&from=sender@example.com&to=recipient@example.com&subject=संदेश का विषय&text=ईमेल का मुख्य भाग (साधारण टेक्स्ट में)&html=ईमेल का मुख्य भाग (HTML प्रारूप में)'https://rsXXX-api.realsender.com/mail/send
API के उदाहरण (संलग्नक सहित)
API उदाहरण (संलग्नक सहित)
अटैचमेंट के साथ POST अनुरोध (अधिकतम 5: attach1, attach2, …)
PHP के साथ CURL-रहित विधि
<?php
require_once 'HTTP/Request2.php';
$config = array('use_brackets' => false,
);
$request = new HTTP_Request2('https://rsXXX-api.realsender.com/mail/send',
HTTP_Request2::METHOD_POST,
$config);
$data = array('apiuser' => 'the one we provided you',
'apipass' => 'the one we provided you',
'from' => 'sender@example.com',
'to' => 'recipient@example.com',
'subject' => 'subject of the message',
'text' => 'email body in plain text',
'html' => 'email body in HTML format');
foreach ($data as $k => $d) {
$request->addPostParameter($k, $d);
};
$request->addUpload('attach1', './sample.pdf', 'sample.pdf', 'application/pdf');
$request->addUpload('attach2', './sample.txt', 'sample.txt', 'text/plain');
$result = $request->send();
var_dump($result);
?>
संलग्नकों के साथ POST अनुरोध
CURL विधि
curl -F 'apiuser=वह जो हमने आपको प्रदान किया है' \ -F 'apipass=वह जो हमने आपको प्रदान किया है' \ -F 'from=sender@example.com' \ -F 'to=recipient@example.com' \ -F 'subject=संदेश का विषय' \ -F 'text=साधारण पाठ में ईमेल बॉडी' \ -F 'html=HTML प्रारूप में ईमेल बॉडी' \ -F 'attach=@sample.pdf;type=application/pdf' \ -F 'attach=@sample.txt;type=text/plain' \ https://rsXXX-api.realsender.com/mail/send