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. Nie martw się – poniżej znajdziesz przykłady, jeśli nie masz pewności, co to jest.

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

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.

Jeśli chcesz otrzymać powiadomienie o dostępności stronicowania, napisz e-mail api@forwardemail.net.

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"

Upewnij się, że postępujesz zgodnie z instrukcjami 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.

Lista e-maili

Pamiętaj, że ten punkt końcowy nie zwraca już utworzonych wiadomości e-mail message, headers, accepted, ani rejectedErrors nieruchomości.

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.

Ten punkt końcowy powróci co najwyżej 50 wyniki na raz. Jeśli chcesz zapytać o wiele stron, dołącz ?page=NUMBER Gdzie NUMBER jest liczbą całkowitą, np. ?page=1.

GET /v1/emails

Przykładowe zapytanie:

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

Utwórz e-mail

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.

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 e-mail

GET /v1/emails/:id

Przykładowe zapytanie:

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

Usuń e-mail

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:

Lista domen

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

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:

Wyświetlanie listy aliasów domen

GET /v1/domains/example.com/aliases

Przykładowe zapytanie:

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -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: