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 (ad eccezione di Contatti Alias, Calendari Alias, e Caselle postali alias che utilizzano un alias generato nome utente e password)..

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

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

[!TIP] Se ricevi un codice di stato 5xx (cosa che non dovrebbe accadere), contattaci all'indirizzo api@forwardemail.net e ti aiuteremo a risolvere immediatamente il tuo problema.

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.

[!NOTE] A partire dal 1° novembre 2024 gli endpoint API per Elenca domini e Elenca gli alias di dominio sarà impostato di default su 1000 risultati massimi per pagina. Se desideri aderire a questo comportamento in anticipo, puoi passare ?paginate=true come parametro querystring aggiuntivo all'URL per la query dell'endpoint.

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

Fornire semplicemente le proprietà della querystring page (e facoltativamente limit).

La proprietà page dovrebbe essere un numero maggiore o uguale a 1Se fornisci limit (anche un numero), allora 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 la suddivisione in pagine a livello di programmazione):

Richiesta di esempio:

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 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 (Zippaggio 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"

[!NOTE] A differenza di altri endpoint API, questi richiedono Autenticazione "username" uguale all'alias username e "password" uguale alla password generata dall'alias come intestazioni di autorizzazione di base.

[!WARNING] Questa sezione endpoint è un work in progress e verrà rilasciata (si spera) nel 2024. Nel frattempo, si prega di utilizzare un client IMAP dal menu a discesa "App" nella navigazione del nostro sito Web.

[!NOTE] Il supporto CardDAV non è ancora disponibile, segui questa discussione su GitHub per gli aggiornamenti.

Elenca i contatti

GET /v1/contacts

Prossimamente

Crea contatto

POST /v1/contacts

Prossimamente

Recupera contatto

GET /v1/contacts/:id

Prossimamente

Aggiorna contatto

PUT /v1/contacts/:id

Prossimamente

Elimina contatto

DELETE /v1/contacts/:id

Prossimamente

[!NOTE] A differenza di altri endpoint API, questi richiedono Autenticazione "username" uguale all'alias username e "password" uguale alla password generata dall'alias come intestazioni di autorizzazione di base.

[!WARNING] Questa sezione endpoint è un work in progress e verrà rilasciata (si spera) nel 2024. Nel frattempo, si prega di utilizzare un client IMAP dal menu a discesa "App" nella navigazione del nostro sito Web.

Elenca i calendari

GET /v1/calendars

Prossimamente

Crea calendario

POST /v1/calendars

Prossimamente

Recupera calendario

GET /v1/calendars/:id

Prossimamente

Aggiorna il calendario

PUT /v1/calendars/:id

Prossimamente

Elimina calendario

DELETE /v1/calendars/:id

Prossimamente

[!NOTE] A differenza di altri endpoint API, questi richiedono Autenticazione "username" uguale all'alias username e "password" uguale alla password generata dall'alias come intestazioni di autorizzazione di base.

[!WARNING] Questa sezione endpoint è un work in progress e verrà rilasciata (si spera) nel 2024. Nel frattempo, si prega di utilizzare un client IMAP dal menu a discesa "App" nella navigazione del nostro sito Web.

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

Queste istruzioni possono essere trovate nella nostra sezione FAQ Supportate la ricezione di email con IMAP?.

Elenca e cerca i messaggi

GET /v1/messages

Prossimamente

Crea messaggio

[!NOTE] Questo NOT invia un'e-mail: aggiungerà semplicemente il messaggio alla cartella della tua casella di posta (ad esempio, questo è simile all'IMAP APPEND comando). Se vuoi inviare un'e-mail, allora vedi Crea email SMTP in uscita di seguito. Dopo aver creato l'e-mail SMTP in uscita, puoi aggiungerne una copia utilizzando questo endpoint alla casella di posta del tuo alias per scopi di archiviazione.

POST /v1/messages

Prossimamente

Recupera messaggio

GET /v1/messages/:id

Prossimamente

Aggiorna messaggio

PUT /v1/messages/:id

Prossimamente

Elimina messaggio

DELETE /v1/messages:id

Prossimamente

[!TIP] Endpoint delle cartelle con il percorso di una cartella /v1/folders/:path poiché il loro endpoint è intercambiabile con l'ID di una cartella :idCiò significa che puoi fare riferimento alla cartella tramite il suo path o id valore.

[!WARNING] Questa sezione endpoint è un work in progress e verrà rilasciata (si spera) nel 2024. Nel frattempo, si prega di utilizzare un client IMAP dal menu a discesa "App" nella navigazione del nostro sito Web.

Elenca le cartelle

GET /v1/folders

Prossimamente

Crea cartella

POST /v1/folders

Prossimamente

Recupera cartella

GET /v1/folders/:id

Prossimamente

Aggiorna cartella

PUT /v1/folders/:id

Prossimamente

Elimina 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 possono essere trovate su 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.

Ottieni il limite di posta elettronica SMTP in uscita

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

GET /v1/emails/limit

Richiesta di esempio:

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 un'e-mail message, headers, né rejectedErrors.

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

GET /v1/emails

Richiesta di esempio:

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

Crea email SMTP in uscita

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.

Questo endpoint API codificherà automaticamente gli emoji per te se vengono trovati nelle intestazioni (ad esempio una riga dell'oggetto di Subject: 🤓 Hello viene convertito in Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello automaticamente). Il nostro obiettivo era di realizzare un'API di posta elettronica estremamente intuitiva e a prova di idiota.

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 email SMTP in uscita

GET /v1/emails/:id

Richiesta di esempio:

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

Elimina email SMTP in uscita

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:

[!TIP] Endpoint di dominio con un nome di dominio /v1/domains/:domain_name poiché il loro endpoint è intercambiabile con l'ID di un dominio :domain_id. Ciò significa che puoi fare riferimento al dominio con i suoi name o id valore.

Elenca domini

[!NOTE] A partire dal 1° novembre 2024 gli endpoint API per Elenca domini e Elenca gli alias di dominio sarà impostato di default su 1000 risultati massimi per pagina. Se desideri aderire a questo comportamento in anticipo, puoi passare ?paginate=true come parametro querystring aggiuntivo all'URL per la query dell'endpoint. Vedere paginatura per maggiori informazioni.

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

[!IMPORTANTE] Se l'utente invitato è già un membro accettato di uno qualsiasi degli altri domini di cui è membro l'amministratore che lo invita, accetterà automaticamente l'invito e non invierà un'e-mail.

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:

Genera una password alias

Tieni presente che se non invii le istruzioni via email, il nome utente e la password si troveranno nel corpo della risposta JSON di una richiesta andata a buon fine nel formato { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Richiesta di esempio:

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

Elenca gli alias di dominio

[!NOTE] A partire dal 1° novembre 2024 gli endpoint API per Elenca domini e Elenca gli alias di dominio sarà impostato di default su 1000 risultati massimi per pagina. Se desideri aderire a questo comportamento in anticipo, puoi passare ?paginate=true come parametro querystring aggiuntivo all'URL per la query dell'endpoint. Vedere paginatura per maggiori informazioni.

GET /v1/domains/example.com/aliases

Richiesta di esempio:

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

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:

Ti consentiamo di crittografare i record anche nel piano gratuito senza alcun costo. La privacy non dovrebbe essere una caratteristica, dovrebbe essere intrinsecamente integrata in tutti gli aspetti di un prodotto. Come altamente richiesto in a Discussione sulle Guide sulla privacy e così via i nostri problemi su GitHub abbiamo aggiunto questo.

Crittografa il record TXT

POST /v1/encrypt

Richiesta di esempio:

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