API e-mail

Al momento non abbiamo ancora rilasciato alcun wrapper API, ma prevediamo di farlo nel prossimo futuro. Invia una e-mail a api@forwardemail.net se desideri essere avvisato quando viene rilasciato il wrapper API di un particolare linguaggio di programmazione. Nel frattempo, puoi utilizzare queste librerie di richieste HTTP consigliate nella tua applicazione o semplicemente usarle arricciare come negli esempi seguenti.

L'attuale percorso dell'URI di base HTTP è: https://api.forwardemail.net.

Tutti gli endpoint richiedono il tuo Chiave API da impostare come valore "nome utente" della richiesta Autorizzazione di base intestazione. Non preoccuparti: di seguito vengono forniti esempi per te se non sei sicuro di cosa si tratti.

Se si verificano errori, il corpo della risposta della richiesta API conterrà un messaggio di errore dettagliato.

Il nostro servizio è tradotto in oltre 25 lingue diverse. Tutti i messaggi di risposta API vengono tradotti nell'ultima locale rilevata dall'utente che effettua la richiesta API. Puoi ignorarlo passando un'abitudine Accept-Language intestazione. Sentiti libero di provarlo usando il menu a discesa della lingua in fondo a questa pagina.

Se desideri essere avvisato quando l'impaginazione è disponibile, invia un'e-mail api@forwardemail.net.

Recupera i log

La nostra API ti consente in modo programmatico di scaricare i log per il tuo account. L'invio di una richiesta a questo endpoint elaborerà tutti i log per il tuo account e te li invierà via email come allegato (Gzip compresso CSV file del foglio di calcolo) una volta completato.

Ciò ti consente di creare lavori in background con a Lavoro Cron o utilizzando il nostro Bree, il software di pianificazione dei lavori Node.js per ricevere i log ogni volta che lo desideri. Tieni presente che questo endpoint è limitato a 10 richieste al giorno.

L'allegato è la forma minuscola di email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz e l'e-mail stessa contiene un breve riepilogo dei registri recuperati. Puoi anche scaricare i registri in qualsiasi momento da Il mio account → Registri

GET /v1/logs/download

Richiesta di esempio:

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

Esempio di lavoro Cron (a mezzanotte tutti i giorni):

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

Tieni presente che puoi utilizzare servizi come Crontab.guru per convalidare la sintassi dell'espressione del processo cron.

Esempio di lavoro Cron (a mezzanotte tutti i giorni e con i registri del giorno precedente):

Per 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

Per Linux e 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

Creare un profilo

POST /v1/account

Richiesta di esempio:

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

Recupera account

GET /v1/account

Richiesta di esempio:

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

Aggiorna account

PUT /v1/account

Richiesta di esempio:

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

Assicurati di aver seguito le istruzioni di configurazione per il tuo dominio. Queste istruzioni sono disponibili all'indirizzo Il mio account → Domini → Impostazioni → Configurazione SMTP in uscita. Devi garantire la configurazione di DKIM, Return-Path e DMARC per l'invio di SMTP in uscita con il tuo dominio.

Elenca le email

Si noti che questo endpoint non restituisce un'e-mail già creata message, headers, accepted, né rejectedErrors proprietà.

Per restituire tali proprietà e i relativi valori, utilizzare il Recupera la posta elettronica endpoint con un ID e-mail.

Questo endpoint restituirà al massimo 50 risultati alla volta. Se desideri eseguire una query per più pagine, aggiungi ?page=NUMBER Dove NUMBER è un numero intero, ad es. ?page=1.

GET /v1/emails

Richiesta di esempio:

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

Crea e-mail

La nostra API per la creazione di un'e-mail è ispirata e sfrutta la configurazione delle opzioni di messaggio di Nodemailer. Si prega di rimandare al Configurazione dei messaggi di Nodemailer per tutti i parametri del corpo di seguito.

Si noti che ad eccezione di envelope e dkim (poiché li impostiamo automaticamente per te), supportiamo tutte le opzioni di Nodemailer. Abbiamo impostato automaticamente disableFileAccess e disableUrlAccess opzioni a true per motivi di sicurezza.

Dovresti passare l'unica opzione di raw con la tua e-mail completa non elaborata, comprese le intestazioni o passa le opzioni dei singoli parametri del corpo di seguito.

POST /v1/emails

Richiesta di esempio:

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"

Richiesta di esempio:

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

Recupera la posta elettronica

GET /v1/emails/:id

Richiesta di esempio:

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

Elimina e-mail

L'eliminazione dell'e-mail imposterà lo stato su "rejected" (e successivamente non elaborarlo in coda) se e solo se lo stato corrente è uno di "pending", "queued", o "deferred". Potremmo eliminare automaticamente le e-mail dopo 30 giorni dalla creazione e/o dall'invio, pertanto è necessario conservare una copia delle e-mail SMTP in uscita nel client, nel database o nell'applicazione. Puoi fare riferimento al nostro valore ID e-mail nel tuo database se lo desideri: questo valore viene restituito da entrambi Crea e-mail e Recupera la posta elettronica punti finali.

DELETE /v1/emails/:id

Richiesta di esempio:

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

Elenca domini

GET /v1/domains

Richiesta di esempio:

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

Crea dominio

POST /v1/domains

Richiesta di esempio:

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

Recupera dominio

GET /v1/domains/example.com

Richiesta di esempio:

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

Verifica i record di dominio

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

Richiesta di esempio:

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

Aggiorna dominio

PUT /v1/domains/example.com

Richiesta di esempio:

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

Elimina dominio

DELETE /v1/domains/:domain_name

Richiesta di esempio:

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

Accetta l'invito al dominio

GET /v1/domains/:domain_name/invites

Richiesta di esempio:

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

Crea un invito al dominio

POST /v1/domains/example.com/invites

Richiesta di esempio:

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

Rimuovi l'invito al dominio

DELETE /v1/domains/:domain_name/invites

Richiesta di esempio:

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

Aggiorna membro del dominio

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

Richiesta di esempio:

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

Rimuovi membro del dominio

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

Richiesta di esempio:

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

Elenca gli alias di dominio

GET /v1/domains/example.com/aliases

Richiesta di esempio:

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

Crea un nuovo alias di dominio

POST /v1/domains/example.com/aliases

Richiesta di esempio:

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

Recupera alias di dominio

Puoi recuperare un alias di dominio in entrambi i modi id o il suo name valore.

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

Richiesta di esempio:

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

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

Richiesta di esempio:

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

Aggiorna alias di dominio

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

Richiesta di esempio:

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

Elimina alias di dominio

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

Richiesta di esempio:

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