API'ye genel bakış
RealSender, API (Uygulama Programlama Arayüzü) aracılığıyla e-posta mesajları göndermenizi sağlar.
Bu sayede e-postaları SMTP (Basit Posta Transfer Protokolü) üzerinden geçirmeden doğrudan uygulamanızdan gönderebilirsiniz. Şu anda yalnızca POST isteklerini.
Sunucu adresi:
https://rsXXX-api.realsender.com/mail/send
Gerekli/zorunlu parametreler:
| Parametre |
Tanım |
| apiuser |
kimlik doğrulama kullanıcı adı |
| apipass |
kimlik doğrulama şifresi |
| itibaren |
gönderenin e-posta adresi |
| ile |
alıcının e-posta adresi |
| ders |
e-postanın konusu |
| metin |
e-posta içeriği düz metin olarak |
| HTML |
HTML formatında e-posta gövdesi |
Her şey yolunda ise mesaj gönderilecek ve olumlu bir JSON yanıtı alacaksınız:
{"success":true}
Hata oluşması durumunda şöyle bir şey alacaksınız:
{"success":false,"errorMsgs":["Lütfen 'subject' değerini belirtin."]}
API Ayrıntıları
API detayları
E-posta içeriği UTF-8 uluslararası karakter seti kullanılarak gönderilmelidir .
Bunu test etmek için, konu kısmına “€uro” ekleyin ve gönderin. Karakter seti yanlışsa, şu JSON uyarısını alacaksınız:
{"success":false,"errorMsgs":["'Konu' değeri doğru şekilde kodlanmamış. UTF-8 olarak kodlanmalıdır."]}
"Metin" ve "HTML" alanlarından birini veya her ikisini de doldurmanıza bağlı olarak, mesajlar şu "Content-Type" seçeneklerinden biri kullanılarak gönderilecektir:
| Parametre |
Tanım |
| metin |
metin/düz (sadece metin) |
| HTML |
metin/html (yalnızca HTML) |
| metin+html |
multipart/alternative (hem metin hem de HTML) e-posta istemci ayarları, hangi bölümün görüntüleneceğine karar verecektir. |
Zorunlu olmayan/isteğe bağlı parametreler:
| Parametre |
Tanım |
| isimden |
gönderen açıklaması |
| isim |
alıcı açıklaması |
| yanıtla |
Yanıtları alacak e-posta adresi |
| dönüş yolu |
Geri dönen e-postaları alacak olan e-posta adresi, RealSender'ın yetkili göndericileri arasında yer almalıdır. |
| cc |
karbon kopya e-posta adresi |
| ccname |
karbon kopya açıklaması |
| bcc |
gizli karbon kopya e-posta adresi |
| bccname |
kör karbon kopya açıklaması |
| eklemek |
Eklenecek dosya(lar) - formda birden fazla kez bulunabilir - maksimum 3 MB boyutunda - dosya içeriği çok parçalı HTTP POST isteğinin bir parçası olmalıdır - INPUT TYPE=FILE için enctype="multipart/form-data" gereklidir |
"Kime", "cc" ve "bcc" değerleri tek bir e-posta adresi veya virgülle ayrılmış bir e-posta adresi listesi içerebilir .
!! RealSender'da her bir e-posta için toplam alıcı sayısı 25 ile sınırlıdır (100'e kadar artırılabilir).
Sunucunun yanıtları JSON (JavaScript Object Notation) formatındadır:
| Tanım |
Cevap |
| e-posta gönderildi |
{"başarı":true} |
| E-posta gönderilmedi |
{"success":false,"errorMsgs":["..."]} |
API Örnekleri
API örnekleri
PHP ile CURL kullanmadan
POST isteği gönderme yöntemi
<?php $url = 'https://rsXXX-api.realsender.com/mail/send'; $data = array('apiuser' =>'size verdiğimiz', 'apipass' => 'size verdiğimiz', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => 'mesajın konusu', 'text' => 'e-posta gövdesi düz metin olarak', 'html' => 'e-posta gövdesi HTML formatında'); // İsteği https://... adresine gönderseniz bile 'http' anahtarını kullanın $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 isteği
CURL yöntemi
curl -d 'apiuser=size verdiğimiz şifre&apipass=size verdiğimiz şifre&from=sender@example.com&to=recipient@example.com&subject=mesajın konusu&text=e-posta gövdesi düz metin olarak&html=e-posta gövdesi HTML formatında'https://rsXXX-api.realsender.com/mail/send
Ekli API örnekleri
Ekli API örnekleri
Ekli dosyalarla (en fazla 5: attach1, attach2, …) POST isteği,
PHP ile CURL gerektirmeyen yöntem.
<?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' => 'size verdiğimiz kullanıcı adı', 'apipass' => 'size verdiğimiz kullanıcı adı', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => 'mesajın konusu', 'text' => 'e-posta gövdesi düz metin olarak', 'html' => 'e-posta gövdesi HTML formatında'); 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); ?>
Ekli dosyalarla POST isteği
CURL yöntemi
curl -F 'apiuser=size verdiğimiz şifre' \ -F 'apipass=size verdiğimiz şifre' \ -F 'from=sender@example.com' \ -F 'to=recipient@example.com' \ -F 'subject=mesajın konusu' \ -F 'text=e-posta gövdesi düz metin olarak' \ -F 'html=e-posta gövdesi HTML formatında' \ -F 'attach=@sample.pdf;type=application/pdf' \ -F 'attach=@sample.txt;type=text/plain' \ https://rsXXX-api.realsender.com/mail/send