Email API

Obecnie nie wydaliśmy jeszcze żadnych wrapperów API, ale planujemy to zrobić w niedalekiej przyszłości. Wyślij e-mail na api@forwardemail.net, jeśli chcesz zostać powiadomiony, gdy zostanie wydany wrapper API dla konkretnego języka programowania. W międzyczasie możesz użyć tych rekomendowanych bibliotek do zapytań HTTP w swojej aplikacji lub po prostu użyć curl, jak w poniższych przykładach.

Aktualna ścieżka bazowego URI HTTP to: https://fe.tiamati.email.

Wszystkie punkty końcowe wymagają uwierzytelnienia za pomocą Basic Authorization. Obsługujemy dwie metody uwierzytelniania:

Uwierzytelnianie tokenem API (zalecane dla większości punktów końcowych)

Ustaw swój klucz API jako wartość "username" z pustym hasłem:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Zwróć uwagę na dwukropek (:) po tokenie API – wskazuje on na puste hasło w formacie Basic Auth.

Uwierzytelnianie poświadczeniami aliasu (dla wychodzącej poczty e-mail)

Punkt końcowy Create outbound SMTP email obsługuje również uwierzytelnianie za pomocą adresu e-mail aliasu i wygenerowanego hasła aliasu:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

Ta metoda jest przydatna podczas wysyłania e-maili z aplikacji, które już używają poświadczeń SMTP i umożliwia płynne przejście z SMTP na nasze API.

Punkty końcowe tylko dla aliasów

Punkty końcowe Alias Contacts, Alias Calendars, Alias Messages oraz Alias Folders wymagają poświadczeń aliasu i nie obsługują uwierzytelniania tokenem API.

Nie martw się – poniżej znajdziesz przykłady, jeśli nie jesteś pewien, co to jest.

Jeśli wystąpią jakiekolwiek błędy, ciało odpowiedzi żądania API będzie zawierać szczegółową wiadomość o błędzie.

Nasza usługa jest przetłumaczona na ponad 25 różnych języków. Wszystkie komunikaty odpowiedzi API są tłumaczone na ostatnio wykryty język użytkownika wykonującego żądanie API. Możesz to nadpisać, przekazując niestandardowy nagłówek Accept-Language. Zachęcamy do wypróbowania tego za pomocą rozwijanego menu języków na dole tej strony.

Paginacja jest obsługiwana przez wszystkie punkty końcowe API, które zwracają listy wyników.

Wystarczy podać właściwości zapytania page (oraz opcjonalnie limit).

Właściwość page powinna być liczbą większą lub równą 1. Jeśli podasz limit (również liczbę), minimalna wartość to 10, a maksymalna 50 (chyba że zaznaczono inaczej).

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Pobierz logi

Nasze API umożliwia programowe pobieranie logów dla Twojego konta. Wysłanie zapytania do tego endpointu spowoduje przetworzenie wszystkich logów dla Twojego konta i przesłanie ich do Ciebie w załączniku (skompresowany plik Gzip z arkuszem CSV) po zakończeniu.

Pozwala to na tworzenie zadań w tle za pomocą Cron job lub korzystając z naszego oprogramowania do harmonogramowania zadań Node.js Bree, aby otrzymywać logi kiedy tylko chcesz. Zwróć uwagę, że ten endpoint jest ograniczony do 10 zapytań dziennie.

Załącznik ma nazwę w formacie małych liter email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz, a sam e-mail zawiera krótkie podsumowanie pobranych logów. Możesz także pobierać logi w dowolnym momencie z Moje konto → Logi

GET /v1/logs/download

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

Przykładowe zadanie Cron (codziennie o północy):

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

Zwróć uwagę, że możesz użyć serwisów takich jak Crontab.guru do weryfikacji składni wyrażenia zadania cron.

Przykładowe zadanie Cron (codziennie o północy i z logami za poprzedni dzień):

Dla MacOS:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Dla Linux i Ubuntu:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Utwórz konto

POST /v1/account

Przykładowe zapytanie:

curl -X POST https://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Pobierz konto

GET /v1/account

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Aktualizuj konto

PUT /v1/account

Przykładowe zapytanie:

curl -X PUT https://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Lista kontaktów

GET /v1/contacts

Wkrótce dostępne

Utwórz kontakt

POST /v1/contacts

Wkrótce dostępne

Pobierz kontakt

GET /v1/contacts/:id

Wkrótce dostępne

Aktualizuj kontakt

PUT /v1/contacts/:id

Wkrótce dostępne

Usuń kontakt

DELETE /v1/contacts/:id

Wkrótce dostępne

Lista kalendarzy

GET /v1/calendars

Wkrótce dostępne

Utwórz kalendarz

POST /v1/calendars

Wkrótce dostępne

Pobierz kalendarz

GET /v1/calendars/:id

Wkrótce dostępne

Aktualizuj kalendarz

PUT /v1/calendars/:id

Wkrótce dostępne

Usuń kalendarz

DELETE /v1/calendars/:id

Wkrótce dostępne

Proszę upewnić się, że wykonałeś instrukcje konfiguracji dla swojej domeny.

Instrukcje te można znaleźć w naszej sekcji FAQ Czy obsługujecie odbieranie e-maili przez IMAP?.

Lista i wyszukiwanie wiadomości

GET /v1/messages

Wkrótce dostępne

Utwórz wiadomość

POST /v1/messages

Wkrótce dostępne

Pobierz wiadomość

GET /v1/messages/:id

Wkrótce dostępne

Aktualizuj wiadomość

PUT /v1/messages/:id

Wkrótce dostępne

Usuń wiadomość

DELETE /v1/messages:id

Wkrótce dostępne

Lista folderów

GET /v1/folders

Wkrótce dostępne

Utwórz folder

POST /v1/folders

Wkrótce dostępne

Pobierz folder

GET /v1/folders/:id

Wkrótce dostępne

Aktualizuj folder

PUT /v1/folders/:id

Wkrótce dostępne

Usuń folder

DELETE /v1/folders/:id

Wkrótce dostępne

Kopiuj folder

POST /v1/folders/:id/copy

Wkrótce dostępne

Proszę upewnić się, że wykonałeś instrukcje konfiguracji dla swojej domeny.

Instrukcje te można znaleźć pod adresem Moje konto → Domeny → Ustawienia → Konfiguracja wychodzącego SMTP. Musisz zapewnić konfigurację DKIM, Return-Path oraz DMARC dla wysyłania wychodzących wiadomości SMTP z Twojej domeny.

Pobierz limit wychodzących wiadomości SMTP

Jest to proste endpoint, który zwraca obiekt JSON zawierający count i limit dla liczby dziennych wychodzących wiadomości SMTP na konto.

GET /v1/emails/limit

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/emails/limit \
  -u API_TOKEN:

Lista wychodzących wiadomości SMTP

Zwróć uwagę, że ten endpoint nie zwraca wartości właściwości dla message, headers ani rejectedErrors wiadomości email.

Aby zwrócić te właściwości i ich wartości, użyj proszę endpointu Pobierz wiadomość z ID wiadomości.

GET /v1/emails

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

Utwórz wychodzącą wiadomość SMTP

Nasze API do tworzenia wiadomości jest inspirowane i wykorzystuje konfigurację opcji wiadomości Nodemailera. Prosimy odnieść się do konfiguracji wiadomości Nodemailer dla wszystkich poniższych parametrów ciała.

Z wyjątkiem envelope i dkim (które ustawiamy automatycznie za Ciebie), obsługujemy wszystkie opcje Nodemailera. Automatycznie ustawiamy opcje disableFileAccess i disableUrlAccess na true ze względów bezpieczeństwa.

Powinieneś przekazać albo pojedynczą opcję raw z surową pełną wiadomością email wraz z nagłówkami lub przekazać poszczególne opcje parametrów ciała poniżej.

Ten endpoint API automatycznie zakoduje emoji, jeśli zostaną znalezione w nagłówkach (np. temat Subject: 🤓 Hello zostanie automatycznie przekonwertowany na Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Naszym celem było stworzenie bardzo przyjaznego dla programistów i odpornego na błędy API email.

Uwierzytelnianie: Ten endpoint obsługuje zarówno uwierzytelnianie tokenem API, jak i uwierzytelnianie poświadczeniami aliasu. Szczegóły znajdziesz w sekcji Uwierzytelnianie powyżej.

POST /v1/emails

Przykładowe żądanie (token API):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Przykładowe żądanie (dane aliasu):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Przykładowe żądanie (surowy email):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Pobierz wychodzący email SMTP

GET /v1/emails/:id

Przykładowe żądanie:

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Usuń wychodzący email SMTP

Usunięcie emaila ustawi status na "rejected" (i w konsekwencji nie będzie przetwarzany w kolejce) tylko wtedy, gdy aktualny status to jeden z "pending", "queued" lub "deferred". Możemy automatycznie usuwać emaile po 30 dniach od ich utworzenia i/lub wysłania – dlatego powinieneś przechowywać kopię wychodzących emaili SMTP w swoim kliencie, bazie danych lub aplikacji. Możesz odwoływać się do naszej wartości ID emaila w swojej bazie danych, jeśli chcesz – ta wartość jest zwracana zarówno przez endpointy Create email, jak i Retrieve email.

DELETE /v1/emails/:id

Przykładowe żądanie:

curl -X DELETE https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Lista domen

GET /v1/domains

Przykładowe żądanie:

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

Utwórz domenę

POST /v1/domains

Przykładowe zapytanie:

curl -X POST https://fe.tiamati.email/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Pobierz domenę

GET /v1/domains/example.com

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Zweryfikuj rekordy domeny

GET /v1/domains/example.com/verify-records

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Zweryfikuj rekordy SMTP domeny

GET /v1/domains/example.com/verify-smtp

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Lista haseł catch-all dla całej domeny

GET /v1/domains/example.com/catch-all-passwords

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Utwórz hasło catch-all dla całej domeny

POST /v1/domains/example.com/catch-all-passwords

Przykładowe zapytanie:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Usuń hasło catch-all dla całej domeny

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

Przykładowe zapytanie:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Aktualizuj domenę

PUT /v1/domains/example.com

Przykładowe żądanie:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Usuń domenę

DELETE /v1/domains/:domain_name

Przykładowe żądanie:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name \
  -u API_TOKEN:

Zaakceptuj zaproszenie do domeny

GET /v1/domains/:domain_name/invites

Przykładowe żądanie:

curl https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Utwórz zaproszenie do domeny

POST /v1/domains/example.com/invites

Przykładowe żądanie:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Usuń zaproszenie do domeny

DELETE /v1/domains/:domain_name/invites

Przykładowe żądanie:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Aktualizuj członka domeny

PUT /v1/domains/example.com/members/:member_id

Przykładowe żądanie:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Usuń członka domeny

DELETE /v1/domains/:domain_name/members/:member_id

Przykładowe żądanie:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Wygeneruj hasło aliasu

Zauważ, że jeśli nie wyślesz instrukcji e-mailem, nazwa użytkownika i hasło będą w ciele odpowiedzi JSON udanego żądania w formacie { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Przykładowe zapytanie:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Lista aliasów domeny

GET /v1/domains/example.com/aliases

Przykładowe zapytanie:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Utwórz nowy alias domeny

POST /v1/domains/example.com/aliases

Przykładowe żądanie:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

Pobierz alias domeny

Możesz pobrać alias domeny za pomocą jego wartości id lub name.

GET /v1/domains/:domain_name/aliases/:alias_id

Przykładowe żądanie:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Przykładowe żądanie:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Aktualizuj alias domeny

PUT /v1/domains/example.com/aliases/:alias_id

Przykładowe zapytanie:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Usuń alias domeny

DELETE /v1/domains/:domain_name/aliases/:alias_id

Przykładowe zapytanie:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Pozwalamy na szyfrowanie rekordów nawet w darmowym planie bez dodatkowych kosztów. Prywatność nie powinna być funkcją, powinna być wbudowana we wszystkie aspekty produktu. Na prośbę wielu użytkowników w dyskusji Privacy Guides oraz na naszych zgłoszeniach GitHub dodaliśmy tę funkcję.

Szyfruj rekord TXT

POST /v1/encrypt

Przykładowe zapytanie:

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"