Interfejs API poczty e-mail

W tej chwili nie wydaliśmy jeszcze żadnych wrapperów API, ale planujemy to zrobić w najbliższej przyszłości. Wysłać e-maila do api@forwardemail.net jeśli chcesz być powiadamiany o wydaniu wrappera API określonego języka programowania. W międzyczasie możesz użyć tych zalecanych bibliotek żądań HTTP w swojej aplikacji lub po prostu użyć kędzior jak w poniższych przykładach.

Bieżąca ścieżka podstawowego identyfikatora URI HTTP to: https://api.forwardemail.net.

Wszystkie punkty końcowe wymagają Twojego Klucz API być ustawionym jako wartość „nazwa użytkownika” żądania Podstawowa autoryzacja nagłówek (z wyjątkiem Alias Kontakty, Kalendarze Alias, oraz Skrzynki pocztowe Alias które używają wygenerowany alias nazwa użytkownika i hasło)..

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

Jeśli wystąpią jakiekolwiek błędy, treść odpowiedzi żądania API będzie zawierać szczegółowy komunikat o błędzie.

[!TIP] Jeśli otrzymasz kod statusu 5xx (co nie powinno mieć miejsca), skontaktuj się z nami pod adresem api@forwardemail.net a my pomożemy Ci natychmiast rozwiązać Twój problem.

Nasza usługa jest tłumaczona na ponad 25 różnych języków. Wszystkie komunikaty odpowiedzi API są tłumaczone na ostatnie wykryte ustawienia regionalne użytkownika zgłaszającego żądanie API. Możesz to zmienić, przekazując niestandardowy Accept-Language nagłówek. Wypróbuj go, korzystając z menu rozwijanego języka na dole tej strony.

[!UWAGA] Od 1 listopada 2024 r. punkty końcowe interfejsu API dla Lista domen oraz Wyświetlanie listy aliasów domen domyślnie będzie 1000 maks. wyników na stronę. Jeśli chcesz wcześnie włączyć się do tego zachowania, możesz przejść ?paginate=true jako dodatkowy parametr ciągu zapytania do adresu URL dla zapytania punktu końcowego.

Paginacja jest obsługiwana przez wszystkie punkty końcowe API, które wyświetlają wyniki.

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

Nieruchomość page powinna być liczbą większą lub równą 1. Jeśli podasz limit (również liczba), wówczas minimalna wartość to 10 a maksimum to 50 (chyba że zaznaczono inaczej).

Aby ustalić, czy dostępnych jest więcej wyników, udostępniamy następujące nagłówki odpowiedzi HTTP (które można przeanalizować w celu programowego podziału na strony):

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Pobierz dzienniki

Nasze API programowo umożliwia pobranie logów dla Twojego konta. Przesłanie żądania do tego punktu końcowego spowoduje przetworzenie wszystkich dzienników Twojego konta i przesłanie ich pocztą elektroniczną jako załącznik (Gzip sprężony CSV plik arkusza kalkulacyjnego) po zakończeniu.

Umożliwia to tworzenie zadań w tle za pomocą pliku Praca Crona lub korzystając z naszego Oprogramowanie do planowania zadań Node.js Bree aby otrzymywać logi kiedy tylko chcesz. Należy pamiętać, że ten punkt końcowy jest ograniczony do 10 żądań dziennie.

Załącznik pisany małymi literami email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz a sama wiadomość e-mail zawiera krótkie podsumowanie pobranych dzienników. W każdej chwili możesz także pobrać logi ze strony Moje konto → Dzienniki

GET /v1/logs/download

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

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

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

Pamiętaj, że możesz skorzystać z usług takich jak Crontab.guru aby sprawdzić składnię wyrażenia zadania cron.

Przykładowe zadanie Cron (codziennie o północy oraz logi z poprzedniego dnia):

Dla systemu MacOS:

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

Dla Linuksa i Ubuntu:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/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://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Odzyskać konto

GET /v1/account

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Zaktualizuj konto

PUT /v1/account

Przykładowe zapytanie:

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

[!UWAGA] W przeciwieństwie do innych punktów końcowych API, te wymagają Poświadczenie „username” równa się aliasowi nazwy użytkownika, a „password” równa się aliasowi wygenerowanemu hasłu jako nagłówki podstawowej autoryzacji.

[!OSTRZEŻENIE] Ta sekcja punktu końcowego jest w trakcie realizacji i zostanie wydana (miejmy nadzieję) w 2024 r. W międzyczasie prosimy o korzystanie z klienta IMAP z rozwijanego menu „Aplikacje” w nawigacji naszej witryny.

[!NOTE] Obsługa CardDAV nie jest jeszcze dostępna. Aby uzyskać aktualizacje, śledź tę dyskusję na GitHub.

Lista kontaktów

GET /v1/contacts

Wkrótce

Utwórz kontakt

POST /v1/contacts

Wkrótce

Pobierz kontakt

GET /v1/contacts/:id

Wkrótce

Aktualizuj kontakt

PUT /v1/contacts/:id

Wkrótce

Usuń kontakt

DELETE /v1/contacts/:id

Wkrótce

[!UWAGA] W przeciwieństwie do innych punktów końcowych API, te wymagają Poświadczenie „username” równa się aliasowi nazwy użytkownika, a „password” równa się aliasowi wygenerowanemu hasłu jako nagłówki podstawowej autoryzacji.

[!OSTRZEŻENIE] Ta sekcja punktu końcowego jest w trakcie realizacji i zostanie wydana (miejmy nadzieję) w 2024 r. W międzyczasie prosimy o korzystanie z klienta IMAP z rozwijanego menu „Aplikacje” w nawigacji naszej witryny.

Lista kalendarzy

GET /v1/calendars

Wkrótce

Utwórz kalendarz

POST /v1/calendars

Wkrótce

Pobierz kalendarz

GET /v1/calendars/:id

Wkrótce

Aktualizuj kalendarz

PUT /v1/calendars/:id

Wkrótce

Usuń kalendarz

DELETE /v1/calendars/:id

Wkrótce

[!UWAGA] W przeciwieństwie do innych punktów końcowych API, te wymagają Poświadczenie „username” równa się aliasowi nazwy użytkownika, a „password” równa się aliasowi wygenerowanemu hasłu jako nagłówki podstawowej autoryzacji.

[!OSTRZEŻENIE] Ta sekcja punktu końcowego jest w trakcie realizacji i zostanie wydana (miejmy nadzieję) w 2024 r. W międzyczasie prosimy o korzystanie z klienta IMAP z rozwijanego menu „Aplikacje” w nawigacji naszej witryny.

Upewnij się, że wykonałeś/aś instrukcje konfiguracji dla swojej domeny.

Instrukcje te można znaleźć w naszej sekcji FAQ Czy obsługujecie odbieranie poczty elektronicznej za pomocą protokołu IMAP?.

Lista i wyszukiwanie wiadomości

GET /v1/messages

Wkrótce

Utwórz wiadomość

[!UWAGA] To spowoduje NOT wyślij wiadomość e-mail – wiadomość zostanie po prostu dodana do folderu skrzynki pocztowej (np. jest to podobne do IMAP) APPEND polecenie). Jeśli chcesz wysłać e-mail, zobacz Utwórz wychodzącą pocztę SMTP poniżej. Po utworzeniu wychodzącej wiadomości e-mail SMTP możesz dołączyć jej kopię za pomocą tego punktu końcowego do skrzynki pocztowej swojego aliasu w celu przechowywania.

POST /v1/messages

Wkrótce

Pobierz wiadomość

GET /v1/messages/:id

Wkrótce

Aktualizuj wiadomość

PUT /v1/messages/:id

Wkrótce

Usuń wiadomość

DELETE /v1/messages:id

Wkrótce

[!TIP] Punkty końcowe folderu ze ścieżką folderu /v1/folders/:path ponieważ ich punkt końcowy jest wymienny z identyfikatorem folderu :idOznacza to, że do folderu można odwołać się albo poprzez jego path lub id wartość.

[!OSTRZEŻENIE] Ta sekcja punktu końcowego jest w trakcie realizacji i zostanie wydana (miejmy nadzieję) w 2024 r. W międzyczasie prosimy o korzystanie z klienta IMAP z rozwijanego menu „Aplikacje” w nawigacji naszej witryny.

Wyświetlanie listy folderów

GET /v1/folders

Wkrótce

Utwórz folder

POST /v1/folders

Wkrótce

Pobierz folder

GET /v1/folders/:id

Wkrótce

Aktualizuj folder

PUT /v1/folders/:id

Wkrótce

Usuń folder

DELETE /v1/folders/:id

Wkrótce

Kopiuj folder

POST /v1/folders/:id/copy

Wkrótce

Upewnij się, że wykonałeś/aś 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 i DMARC do wysyłania wychodzącego SMTP w swojej domenie.

Uzyskaj limit poczty wychodzącej SMTP

Jest to prosty punkt końcowy, który zwraca obiekt JSON zawierający count oraz limit dla liczby codziennych wiadomości wychodzących SMTP w przeliczeniu na konto.

GET /v1/emails/limit

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

Wyświetl listę wiadomości e-mail SMTP wychodzących

Należy pamiętać, że ten punkt końcowy nie zwraca wartości właściwości dla wiadomości e-mail. message, headers, ani rejectedErrors.

Aby zwrócić te właściwości i ich wartości, użyj metody Pobierz e-mail punkt końcowy z identyfikatorem e-mail.

GET /v1/emails

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

Utwórz wychodzącą pocztę SMTP

Nasz interfejs API do tworzenia wiadomości e-mail jest inspirowany konfiguracją opcji wiadomości Nodemailera i wykorzystuje ją. Proszę odłożyć na Konfiguracja wiadomości Nodemailer dla wszystkich parametrów ciała poniżej.

Zauważ, że z wyjątkiem envelope oraz dkim (ponieważ ustawiliśmy je automatycznie dla Ciebie), obsługujemy wszystkie opcje Nodemailer. Ustawiliśmy automatycznie disableFileAccess oraz disableUrlAccess opcje do true dla celów bezpieczeństwa.

Powinieneś przekazać pojedynczą opcję of raw z nieprzetworzonym pełnym e-mailem, w tym nagłówkami lub przekaż poniżej poszczególne opcje parametrów ciała.

Ten punkt końcowy interfejsu API automatycznie zakoduje dla Ciebie emotikony, jeśli zostaną znalezione w nagłówkach (np. w temacie wiadomości). Subject: 🤓 Hello zostaje przekonwertowany na Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello automatycznie). Naszym celem było stworzenie niezwykle przyjaznego dla programistów i odpornego na błędy API poczty e-mail.

POST /v1/emails

Przykładowe zapytanie:

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

Przykładowe zapytanie:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Pobierz wychodzącą pocztę SMTP

GET /v1/emails/:id

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Usuń wychodzącą pocztę SMTP

Usunięcie wiadomości e-mail spowoduje ustawienie stanu na "rejected" (a następnie nie przetwarzać go w kolejce) wtedy i tylko wtedy, gdy bieżący status to jeden z "pending", "queued", lub "deferred". Możemy usuwać wiadomości e-mail automatycznie po 30 dniach od ich utworzenia i/lub wysłania — dlatego należy przechowywać kopię wychodzących wiadomości e-mail SMTP w swoim kliencie, bazie danych lub aplikacji. W razie potrzeby możesz odwołać się do naszej wartości identyfikatora e-mail w swojej bazie danych — ta wartość jest zwracana z obu Utwórz e-mail oraz Pobierz e-mail punkty końcowe.

DELETE /v1/emails/:id

Przykładowe zapytanie:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

[!TIP] Punkty końcowe domeny z nazwą domeny /v1/domains/:domain_name ponieważ ich punkt końcowy jest wymienny z identyfikatorem domeny :domain_id. Oznacza to, że możesz odwoływać się do domeny przez jej name lub id wartość.

Lista domen

[!UWAGA] Od 1 listopada 2024 r. punkty końcowe interfejsu API dla Lista domen oraz Wyświetlanie listy aliasów domen domyślnie będzie 1000 maks. wyników na stronę. Jeśli chcesz wcześnie włączyć się do tego zachowania, możesz przejść ?paginate=true jako dodatkowy parametr ciągu zapytania do adresu URL dla zapytania punktu końcowego. Zobacz Paginacja aby uzyskać więcej informacji.

GET /v1/domains

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

Utwórz domenę

POST /v1/domains

Przykładowe zapytanie:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Odzyskaj domenę

GET /v1/domains/example.com

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Sprawdź rekordy domeny

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

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Zaktualizuj domenę

PUT /v1/domains/example.com

Przykładowe zapytanie:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Usuń domenę

DELETE /v1/domains/:domain_name

Przykładowe zapytanie:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

Zaakceptuj zaproszenie do domeny

GET /v1/domains/:domain_name/invites

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Utwórz zaproszenie do domeny

POST /v1/domains/example.com/invites

Przykładowe zapytanie:

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

[!WAŻNE] Jeśli zapraszany użytkownik jest już zaakceptowanym członkiem jakiejkolwiek innej domeny, której członkiem jest zapraszający go administrator, zaproszenie zostanie automatycznie zaakceptowane i nie zostanie wysłany e-mail.

Usuń zaproszenie do domeny

DELETE /v1/domains/:domain_name/invites

Przykładowe zapytanie:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Zaktualizuj członka domeny

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

Przykładowe zapytanie:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Usuń członka domeny

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

Przykładowe zapytanie:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Wygeneruj hasło aliasu

Pamiętaj, że jeśli nie wyślesz instrukcji e-mailem, nazwa użytkownika i hasło znajdą się w treści odpowiedzi JSON pomyślnego żą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://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Wyświetlanie listy aliasów domen

[!UWAGA] Od 1 listopada 2024 r. punkty końcowe interfejsu API dla Lista domen oraz Wyświetlanie listy aliasów domen domyślnie będzie 1000 maks. wyników na stronę. Jeśli chcesz wcześnie włączyć się do tego zachowania, możesz przejść ?paginate=true jako dodatkowy parametr ciągu zapytania do adresu URL dla zapytania punktu końcowego. Zobacz Paginacja aby uzyskać więcej informacji.

GET /v1/domains/example.com/aliases

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Utwórz nowy alias domeny

POST /v1/domains/example.com/aliases

Przykładowe zapytanie:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Pobierz alias domeny

Możesz pobrać alias domeny przez jego id lub jego name wartość.

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

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Zaktualizuj alias domeny

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

Przykładowe zapytanie:

curl -X PUT https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Umożliwiamy szyfrowanie zapisów nawet w planie darmowym, bez żadnych kosztów. Prywatność nie powinna być cechą, powinna być nieodłącznie wbudowana we wszystkie aspekty produktu. Zgodnie z prośbą w A Dyskusja na temat Przewodników dotyczących prywatności i dalej nasze problemy z GitHubem dodaliśmy to.

Zaszyfruj rekord TXT

POST /v1/encrypt

Przykładowe zapytanie:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"