API poczty e-mail

W tej chwili nie opublikowaliśmy jeszcze żadnych wrapperów API, ale planujemy to zrobić w najbliższej przyszłości. Wyślij wiadomość e-mail na adres api@forwardemail.net, jeśli chcesz otrzymywać powiadomienia o wydaniu wrappera API dla konkretnego języka programowania. W międzyczasie możesz korzystać z zalecanych bibliotek żądań HTTP w swojej aplikacji lub po prostu użyć kędzior, jak w poniższych przykładach.

Aktualna ścieżka bazowa URI HTTP to: https://api.forwardemail.net.

Wszystkie punkty końcowe wymagają, aby zmienna Klucz API była ustawiona jako wartość „username” nagłówka Podstawowa autoryzacja żądania (z wyjątkiem Alias Kontakty, Kalendarze Alias i Skrzynki pocztowe Alias, które używają wygenerowana nazwa użytkownika i hasło aliasu).

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.

Nasza usługa jest przetłumaczona na ponad 25 różnych języków. Wszystkie komunikaty odpowiedzi API są tłumaczone na ostatnią lokalizację wykrytą przez użytkownika wysyłającego żądanie API. Możesz to zmienić, przekazując niestandardowy nagłówek Accept-Language. Możesz to wypróbować, korzystając z menu rozwijanego języków na dole tej strony.

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).

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 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 żądanie:

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

Pobierz dzienniki

Nasze API programowo umożliwia pobieranie logów dla Twojego konta. Wysłanie żądania do tego punktu końcowego spowoduje przetworzenie wszystkich logów dla Twojego konta i wysłanie ich do Ciebie e-mailem w postaci załącznika (skompresowany plik arkusza kalkulacyjnego Gzip CSV) po zakończeniu.

Dzięki temu możesz tworzyć zadania w tle z Zadanie cron lub korzystać z naszego Oprogramowanie do planowania zadań Node.js Bree, aby odbierać logi w dowolnym momencie. Pamiętaj, że ten punkt końcowy jest ograniczony do 10 żądań dziennie.

Załącznik to email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz (pisane małymi literami), a sama wiadomość e-mail zawiera krótkie podsumowanie pobranych logów. Możesz również pobrać logi w dowolnym momencie z Moje konto → Dzienniki.

GET /v1/logs/download

Przykładowe żądanie:

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

Należy pamiętać, że do sprawdzenia składni wyrażenia zadania cron można użyć usług takich jak Crontab.guru.

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

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 systemów Linux 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 żądanie:

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

Pobierz konto

GET /v1/account

Przykładowe żądanie:

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

Aktualizuj konto

PUT /v1/account

Przykładowe żądanie:

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

Wyświetl listę kontaktów

GET /v1/contacts

Wkrótce

Utwórz kontakt

POST /v1/contacts

Wkrótce

Pobierz kontakt

GET /v1/contacts/:id

Wkrótce

Zaktualizuj kontakt

PUT /v1/contacts/:id

Wkrótce

Usuń kontakt

DELETE /v1/contacts/:id

Wkrótce

Wyświetl kalendarze

GET /v1/calendars

Wkrótce

Utwórz kalendarz

POST /v1/calendars

Wkrótce

Pobierz kalendarz

GET /v1/calendars/:id

Wkrótce

Aktualizacja kalendarza

PUT /v1/calendars/:id

Wkrótce

Usuń kalendarz

DELETE /v1/calendars/:id

Wkrótce

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

Instrukcje te można znaleźć w naszej sekcji FAQ Czy obsługujesz odbieranie wiadomości e-mail za pomocą protokołu IMAP?.

Wyświetl i wyszukaj wiadomości

GET /v1/messages

Wkrótce

Utwórz wiadomość

POST /v1/messages

Wkrótce

Pobierz wiadomość

GET /v1/messages/:id

Wkrótce

Aktualizacja wiadomości

PUT /v1/messages/:id

Wkrótce

Usuń wiadomość

DELETE /v1/messages:id

Wkrótce

Wyświetla listę folderów

GET /v1/folders

Wkrótce

Utwórz folder

POST /v1/folders

Wkrótce

Pobierz folder

GET /v1/folders/:id

Wkrótce

Aktualizacja folderu

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ś instrukcje konfiguracji dla swojej domeny.

Te instrukcje znajdziesz w Moje konto → Domeny → Ustawienia → Konfiguracja SMTP wychodzącego. Musisz skonfigurować DKIM, Return-Path i DMARC, aby wysyłać wiadomości wychodzące SMTP z Twojej domeny.

Limit wiadomości e-mail SMTP wychodzących

Jest to prosty punkt końcowy, który zwraca obiekt JSON zawierający wartości count i limit określające liczbę dziennych wiadomości wychodzących SMTP dla każdego konta.

GET /v1/emails/limit

Przykładowe żądanie:

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 message, headers ani rejectedErrors wiadomości e-mail.

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

GET /v1/emails

Przykładowe żądanie:

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

Utwórz wychodzącą wiadomość e-mail SMTP

Nasze API do tworzenia wiadomości e-mail jest inspirowane konfiguracją opcji wiadomości Nodemailer i wykorzystuje ją. Proszę odwołać się do Konfiguracja wiadomości Nodemailer dla wszystkich poniższych parametrów treści.

Pamiętaj, że z wyjątkiem envelope i dkim (ponieważ ustawiamy je automatycznie), obsługujemy wszystkie opcje Nodemailera. Ze względów bezpieczeństwa opcje disableFileAccess i disableUrlAccess są automatycznie ustawiane na true.

Należy przekazać pojedynczą opcję raw wraz z pełną treścią wiadomości e-mail, łącznie z nagłówkami lub przekazać poniższe opcje parametrów treści wiadomości.

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

POST /v1/emails

Przykładowe żądanie:

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 żądanie:

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

Pobierz wychodzącą wiadomość e-mail SMTP

GET /v1/emails/:id

Przykładowe żądanie:

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

Usuń wychodzącą wiadomość e-mail SMTP

Usunięcie wiadomości e-mail spowoduje ustawienie statusu na "rejected" (i nie będzie ona przetwarzana w kolejce) tylko wtedy, gdy aktualny status to "pending", "queued" lub "deferred". Możemy automatycznie usuwać wiadomości e-mail po 30 dniach od ich utworzenia i/lub wysłania – dlatego należy zachować kopię wychodzących wiadomości SMTP w kliencie, bazie danych lub aplikacji. W razie potrzeby można odwołać się do wartości naszego identyfikatora e-mail w bazie danych – wartość ta jest zwracana zarówno z punktów końcowych Utwórz e-mail, jak i Pobierz e-mail.

DELETE /v1/emails/:id

Przykładowe żądanie:

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

Wyświetl listę domen

GET /v1/domains

Przykładowe żądanie:

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

Utwórz domenę

POST /v1/domains

Przykładowe żądanie:

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

Pobierz domenę

GET /v1/domains/example.com

Przykładowe żądanie:

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

Zweryfikuj rekordy domeny

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

Przykładowe żądanie:

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

Zweryfikuj rekordy SMTP domeny

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

Przykładowe żądanie:

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

Wyświetl listę haseł uniwersalnych dla całej domeny

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

Przykładowe żądanie:

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

Utwórz hasło uniwersalne dla całej domeny

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

Przykładowe żądanie:

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

Usuń hasło uniwersalne dla całej domeny

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

Przykładowe żądanie:

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

Aktualizacja domeny

PUT /v1/domains/example.com

Przykładowe żądanie:

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

Usuń domenę

DELETE /v1/domains/:domain_name

Przykładowe żądanie:

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 żądanie:

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 żądanie:

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

Aktualizacja członka domeny

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

Przykładowe żądanie:

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 żądanie:

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

Wygeneruj hasło aliasu

Należy pamiętać, że jeśli nie wyślesz instrukcji e-mailem, nazwa użytkownika i hasło zostaną umieszczone 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 żądanie:

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

Wyświetl listę aliasów domen

GET /v1/domains/example.com/aliases

Przykładowe żądanie:

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 żądanie:

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

Pobierz alias domeny

Alias domeny można pobrać według wartości id lub name.

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

Przykładowe żądanie:

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 żądanie:

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 żądanie:

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 żądanie:

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

Umożliwiamy szyfrowanie rekordów nawet w ramach darmowego planu, bez żadnych kosztów. Prywatność nie powinna być funkcją, lecz integralną częścią wszystkich aspektów produktu. Zgodnie z gorącymi prośbami w Dyskusja na temat przewodników dotyczących prywatności i nasze problemy na GitHubie, dodaliśmy tę funkcję.

Szyfruj rekord TXT

POST /v1/encrypt

Przykładowe żądanie:

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