API e-mail

Al momento non abbiamo ancora rilasciato alcun wrapper API, ma prevediamo di farlo a breve. Invia un'email a api@forwardemail.net se desideri essere avvisato quando verrà rilasciato il wrapper API di un particolare linguaggio di programmazione. Nel frattempo, puoi utilizzare queste librerie di richiesta HTTP consigliate nella tua applicazione o semplicemente utilizzare arricciare come negli esempi seguenti.

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

Tutti gli endpoint richiedono che chiave API sia impostato come valore "username" dell'intestazione Autorizzazione di base della richiesta (ad eccezione di Contatti alias, Calendari Alias e Caselle postali alias che utilizzano nome utente e password alias generati).

Non preoccuparti: se non sei sicuro di cosa si tratta, di seguito sono riportati degli esempi.

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 lingua rilevata dall'utente che effettua la richiesta API. È possibile ignorare questa impostazione passando un'intestazione Accept-Language personalizzata. Sentitevi liberi di provarla utilizzando il menu a tendina delle lingue in fondo a questa pagina.

La paginazione è supportata da tutti gli endpoint API che elencano i risultati.

Basta fornire le proprietà della querystring page (e facoltativamente limit).

La proprietà page deve essere un numero maggiore o uguale a 1. Se si specifica limit (anch'esso un numero), il valore minimo è 10 e il massimo è 50 (salvo diversa indicazione).

Per determinare se sono disponibili altri risultati, forniamo queste intestazioni di risposta HTTP (che puoi analizzare per effettuare la suddivisione in pagine a livello di programmazione):

Esempio di richiesta:

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

Recupera i log

La nostra API ti consente di scaricare i log del tuo account in modo programmatico. Inviando una richiesta a questo endpoint, tutti i log del tuo account verranno elaborati e, una volta completata la richiesta, te li invieremo via email come allegato (file di foglio di calcolo compresso Gzip o CSV).

Questo ti consente di creare processi in background con un Cron job o di utilizzare il nostro Software di pianificazione dei lavori Node.js Bree per ricevere i log ogni volta che lo desideri. Tieni presente che questo endpoint è limitato a richieste 10 al giorno.

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

GET /v1/logs/download

Esempio di richiesta:

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

Esempio di Cron job (ogni giorno a mezzanotte):

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 tuo cron job.

Esempio di Cron job (ogni giorno a mezzanotte e con i log 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

Crea account

POST /v1/account

Esempio di richiesta:

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

Recupera account

GET /v1/account

Esempio di richiesta:

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

Aggiorna account

PUT /v1/account

Esempio di richiesta:

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

Elenca i contatti

GET /v1/contacts

Prossimamente

Crea contatto

POST /v1/contacts

Prossimamente

Recupera il contatto

GET /v1/contacts/:id

Prossimamente

Aggiorna contatto

PUT /v1/contacts/:id

Prossimamente

Elimina contatto

DELETE /v1/contacts/:id

Prossimamente

Elenca calendari

GET /v1/calendars

Prossimamente

Crea calendario

POST /v1/calendars

Prossimamente

Recupera il calendario

GET /v1/calendars/:id

Prossimamente

Aggiorna calendario

PUT /v1/calendars/:id

Prossimamente

Elimina calendario

DELETE /v1/calendars/:id

Prossimamente

Assicurati di aver seguito le istruzioni di configurazione per il tuo dominio.

Queste istruzioni si trovano nella nostra sezione FAQ Supportate la ricezione di posta elettronica tramite IMAP?.

Elenca e cerca i messaggi

GET /v1/messages

Prossimamente

Crea messaggio

POST /v1/messages

Prossimamente

Recupera il messaggio

GET /v1/messages/:id

Prossimamente

Aggiorna messaggio

PUT /v1/messages/:id

Prossimamente

Elimina messaggio

DELETE /v1/messages:id

Prossimamente

Elenca cartelle

GET /v1/folders

Prossimamente

Crea cartella

POST /v1/folders

Prossimamente

Recupera la cartella

GET /v1/folders/:id

Prossimamente

Aggiorna cartella

PUT /v1/folders/:id

Prossimamente

Elimina la cartella

DELETE /v1/folders/:id

Prossimamente

Copia cartella

POST /v1/folders/:id/copy

Prossimamente

Assicurati di aver seguito le istruzioni di configurazione per il tuo dominio.

Queste istruzioni sono disponibili in Il mio account → Domini → Impostazioni → Configurazione SMTP in uscita. È necessario assicurarsi di aver configurato DKIM, Return-Path e DMARC per l'invio di messaggi SMTP in uscita con il proprio dominio.

Ottieni il limite di posta elettronica SMTP in uscita

Si tratta di un endpoint semplice che restituisce un oggetto JSON contenente count e limit per il numero di messaggi SMTP in uscita giornalieri per account.

GET /v1/emails/limit

Esempio di richiesta:

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

Elenca le email SMTP in uscita

Si noti che questo endpoint non restituisce valori di proprietà per message, headers o rejectedErrors di un'e-mail.

Per restituire tali proprietà e i relativi valori, utilizzare l'endpoint Recupera email con un ID e-mail.

GET /v1/emails

Esempio di richiesta:

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

Crea email SMTP in uscita

La nostra API per la creazione di email si ispira e sfrutta la configurazione delle opzioni di messaggio di Nodemailer. Per tutti i parametri del corpo dell'email, fare riferimento a Configurazione dei messaggi di Nodemailer.

Si noti che, ad eccezione di envelope e dkim (poiché le impostiamo automaticamente), supportiamo tutte le opzioni di Nodemailer. Per motivi di sicurezza, le opzioni disableFileAccess e disableUrlAccess vengono impostate automaticamente su true.

Dovresti passare l'unica opzione raw con la tua email completa, incluse le intestazioni, oppure passare le singole opzioni dei parametri del corpo sottostanti.

Questo endpoint API codificherà automaticamente gli emoji se presenti nelle intestazioni (ad esempio, un oggetto Subject: 🤓 Hello verrà convertito automaticamente in Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Il nostro obiettivo era creare un'API email estremamente intuitiva per gli sviluppatori e a prova di errore.

POST /v1/emails

Esempio di richiesta:

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"

Esempio di richiesta:

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

Recupera email SMTP in uscita

GET /v1/emails/:id

Esempio di richiesta:

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

Elimina email SMTP in uscita

L'eliminazione dell'email imposterà lo stato a "rejected" (e successivamente non verrà elaborata nella coda) solo se lo stato corrente è "pending", "queued" o "deferred". Potremmo eliminare automaticamente le email dopo 30 giorni dalla loro creazione e/o invio, pertanto ti consigliamo di conservare una copia delle email SMTP in uscita nel tuo client, database o applicazione. Se lo desideri, puoi fare riferimento al valore del nostro ID email nel tuo database: questo valore viene restituito da entrambi gli endpoint Crea email e Recupera email.

DELETE /v1/emails/:id

Esempio di richiesta:

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

Elenca i domini

GET /v1/domains

Esempio di richiesta:

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

Crea dominio

POST /v1/domains

Esempio di richiesta:

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

Recupera il dominio

GET /v1/domains/example.com

Esempio di richiesta:

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

Verifica i record del dominio

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

Esempio di richiesta:

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

Verifica i record SMTP del dominio

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

Esempio di richiesta:

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

Elenca le password catch-all dell'intero dominio

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

Esempio di richiesta:

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

Crea una password catch-all per l'intero dominio

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

Esempio di richiesta:

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

Rimuovi la password catch-all per l'intero dominio

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

Esempio di richiesta:

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

Aggiorna dominio

PUT /v1/domains/example.com

Esempio di richiesta:

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

Elimina il dominio

DELETE /v1/domains/:domain_name

Esempio di richiesta:

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

Esempio di richiesta:

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

Crea invito al dominio

POST /v1/domains/example.com/invites

Esempio di richiesta:

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

Rimuovi invito al dominio

DELETE /v1/domains/:domain_name/invites

Esempio di richiesta:

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

Aggiorna il membro del dominio

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

Esempio di richiesta:

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

Esempio di richiesta:

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

Genera una password alias

Tieni presente che se non invii istruzioni tramite e-mail, il nome utente e la password saranno presenti nel corpo della risposta JSON di una richiesta riuscita nel formato { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Esempio di richiesta:

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

Elenca gli alias di dominio

GET /v1/domains/example.com/aliases

Esempio di richiesta:

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

Crea un nuovo alias di dominio

POST /v1/domains/example.com/aliases

Esempio di richiesta:

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

Recupera l'alias del dominio

È possibile recuperare un alias di dominio tramite il suo valore id o name.

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

Esempio di richiesta:

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

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

Esempio di richiesta:

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

Aggiorna l'alias del dominio

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

Esempio di richiesta:

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

Elimina l'alias di dominio

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

Esempio di richiesta:

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

Ti consentiamo di crittografare i record anche con il piano gratuito, senza alcun costo. La privacy non dovrebbe essere una funzionalità, ma dovrebbe essere integrata in tutti gli aspetti di un prodotto. Come richiesto a gran voce in Discussione sulle guide sulla privacy e in i nostri problemi su GitHub, abbiamo aggiunto questa funzionalità.

Crittografa il record TXT

POST /v1/encrypt

Esempio di richiesta:

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