Poniższa dokumentacja jest już nieaktualna kliknij w link poniżej aby przejść do aktualnej dokumentacji.
Przejdź do dokumentacji API >>>
Funkcja umożliwia wysyłanie wiadomości. Zapytanie należy kierować na podany poniżej adres przy użyciu metody POST:
Adres URL:
|
1 |
https://api.emaillabs.net.pl/ |
Metoda:
|
1 |
POST |
Wywołanie:
|
1 |
/api/sendmail |
Parametry:
| Parametr | Opis | Wymagalność |
|---|---|---|
| to | Adres e-mail odbiorcy wiadomości e-mail ( w formie tablicy ) | tak |
| smtp_account | Konto SMTP przez które chcesz wysłać wiadomość | tak |
| subject | Temat wiadomości ( max. 128 znaków ) | tak |
| html | Wiadomość w formacie HTML | tak* |
| text | Wiadomość w formacie tekstowym | tak** |
| from | Adres e-mail nadawcy wiadomości | tak |
| from_name | Wyświetlana nazwa nadawcy wiadomości ( max. 128 znaków ) | nie |
| headers | Dodatkowe nagłówki w formie tablicy jako nazwa_nagłówka => wartość | nie |
| cc | Adres e-mail na który zostanie wysłana kopia wiadomości | nie |
| cc_name | Nazwa odbiorcy wiadomości ( max. 128 znaków ) | nie |
| bcc | Adres e-mail na który zostanie wysłana kopia wiadomości ( ukryty adres ) | nie |
| bcc_name | Nazwa odbiorcy wiadomości ( max. 128 znaków ) | nie |
| reply_to | Adres e-mail „odpowiedź do” | nie |
| tags | Tagi wiadomości w formie tablicy ( razem max. 128 znaków ) | nie |
| files | Załączniki jakie mają zostać dodane do pliku w formie tablicy | nie |
| files > name | Nazwa pliku | nie |
| files > mime | Typ pliku w formie rfc2045 | nie |
| files > content | Zawartość pliku zakodowana w base64 | nie |
| files > inline | Umożliwia osadzenie obrazka w treści wiadomości HTML ( obrazek powinien zawierać następującą notyfikację <img src=”cid:nazwa_pliku”/> ) | nie |
* – wymagane jeżeli nie występuje parametr text
** – wymagane jeżeli nie występuje parametr html, w przypadku wystąpienia obu parametrów text zostanie ustawione jako wiadomość alternatywna
Wynik zapytania:
|
1 2 3 4 5 6 7 8 9 |
{ "code":200, "status":"success", "message":Message sent, "data":[ {"adres_email_0@domena.pl":"message_id_01@api.emiallabs.net.pl"}, {"adres_email_1@domena.pl":"message_id_02@api.emiallabs.net.pl"} ] } |
Zwrócone parametry:
| Parametr | Opis |
|---|---|
| code | status zwrócony przez serwer w formie numerycznej |
| status | status zwrócony przez serwer w formie tekstowej |
| message | wiadomość z serwera w formie tekstowej |
| data | W przypadku odpowiedzi poprawnej zwraca dane w formacie adres_email :: nadane_message_id ( każdy adres email otrzymuje indywidualny message_id ), w przypadku wystąpienia błędu zawarte będą błędy zwrócone przez serwer. |
Przykłady użycia:
Jeżeli masz problem z SSL-em dodaj poniższe linijki
|
1 2 |
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0); |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
<?php //Inicjalizacja biblioteki CURL $curl = curl_init(); //Ustawienie adresu z którego zostaną pobrane dane $url = "https://api.emaillabs.net.pl/api/sendmail"; //Ustawienie klucza App Key $appkey = 'Przykladowy_Klucz_App_key'; //Ustawienie klucza Secret Key $secret = 'Przykladowy_Klucz_Secret'; //Tworzenie kryteriów wysyłki $data = array( 'to' => array( 'adres@domena', ), 'smtp_account' => '1.twoje-konto.smtp', 'subject' => 'Tytuł wiadomości', 'html' => '<p>Wiadomość w formacie html</p>' 'text' => 'Prosta wiadomość w formie TXT', 'from' => 'adres@domena', 'from_name' => 'Nadawca wiadomości', 'tags' => array( 'Tag1', 'Tag2' ) ); //Ustawienie metody POST curl_setopt($curl, CURLOPT_POST, 1); //Przekazanie danych do POST curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query( $data )); //Ustawianie typu autoryzacji curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); //Przekazywanie danych do logowania curl_setopt($curl, CURLOPT_USERPWD , "$appkey:$secret"); //Przekazywania adresu URL z akcją curl_setopt($curl, CURLOPT_URL, $url); //Ustawienia dotyczące zwrotu z serwera curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); //Pobieranie wyniku $result = curl_exec($curl); //Wyświetlanie wyniku echo $result; |
Wkrótce dostępny
Wkrótce dostępny