API Email

Al momento non abbiamo ancora rilasciato wrapper API, ma prevediamo di farlo nel prossimo futuro. Invia una email a api@forwardemail.net se desideri essere avvisato quando viene rilasciato il wrapper API per un particolare linguaggio di programmazione. Nel frattempo, puoi utilizzare queste librerie HTTP consigliate nella tua applicazione, oppure semplicemente usare curl come negli esempi sottostanti.

Il percorso URI base HTTP corrente è: https://fe.tiamati.email.

Tutti gli endpoint richiedono l'autenticazione utilizzando la Basic Authorization. Supportiamo due metodi di autenticazione:

Autenticazione con Token API (Consigliata per la maggior parte degli endpoint)

Imposta la tua API key come valore "username" con una password vuota:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Nota i due punti (:) dopo il token API – indicano una password vuota nel formato Basic Auth.

Autenticazione con Credenziali Alias (Per email in uscita)

L'endpoint Create outbound SMTP email supporta anche l'autenticazione usando il tuo indirizzo email alias e una password alias generata:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

Questo metodo è utile quando si inviano email da applicazioni che già utilizzano credenziali SMTP e rende la migrazione da SMTP alla nostra API senza soluzione di continuità.

Endpoint Solo Alias

Gli endpoint Alias Contacts, Alias Calendars, Alias Messages e Alias Folders richiedono credenziali alias e non supportano l'autenticazione con token API.

Non preoccuparti – di seguito sono forniti esempi 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 sono tradotti nell'ultima lingua rilevata dell'utente che effettua la richiesta API. Puoi sovrascrivere questo comportamento passando un header Accept-Language personalizzato. Sentiti libero di provarlo usando il menu a tendina della lingua in fondo a questa pagina.

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

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

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

Esempio di richiesta:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Recupera log

La nostra API consente programmaticamente di scaricare i log per il tuo account. Inviando una richiesta a questo endpoint verranno elaborati tutti i log del tuo account e inviati via email come allegato (file CSV compresso con Gzip) una volta completato.

Questo ti permette di creare processi in background con un Cron job o utilizzando il nostro software di pianificazione lavori Node.js Bree per ricevere i log ogni volta che desideri. Nota che questo endpoint è limitato a 10 richieste al giorno.

L'allegato ha la forma 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 → Log

GET /v1/logs/download

Esempio di richiesta:

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

Esempio di Cron job (a mezzanotte ogni giorno):

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

Nota che puoi usare servizi come Crontab.guru per validare la sintassi della tua espressione cron.

Esempio di Cron job (a mezzanotte ogni giorno e con i log del giorno precedente):

Per MacOS:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Recupera account

GET /v1/account

Esempio di richiesta:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Aggiorna account

PUT /v1/account

Esempio di richiesta:

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

Elenca contatti

GET /v1/contacts

In arrivo

Crea contatto

POST /v1/contacts

In arrivo

Recupera contatto

GET /v1/contacts/:id

In arrivo

Aggiorna contatto

PUT /v1/contacts/:id

In arrivo

Elimina contatto

DELETE /v1/contacts/:id

In arrivo

Elenca calendari

GET /v1/calendars

In arrivo

Crea calendario

POST /v1/calendars

In arrivo

Recupera calendario

GET /v1/calendars/:id

In arrivo

Aggiorna calendario

PUT /v1/calendars/:id

In arrivo

Elimina calendario

DELETE /v1/calendars/:id

In arrivo

Si prega di assicurarsi di aver seguito le istruzioni di configurazione per il proprio dominio.

Queste istruzioni si trovano nella nostra sezione FAQ Supportate la ricezione di email con IMAP?.

Elenca e cerca messaggi

GET /v1/messages

In arrivo

Crea messaggio

POST /v1/messages

In arrivo

Recupera messaggio

GET /v1/messages/:id

In arrivo

Aggiorna messaggio

PUT /v1/messages/:id

In arrivo

Elimina messaggio

DELETE /v1/messages:id

In arrivo

Elenca cartelle

GET /v1/folders

In arrivo

Crea cartella

POST /v1/folders

In arrivo

Recupera cartella

GET /v1/folders/:id

In arrivo

Aggiorna cartella

PUT /v1/folders/:id

In arrivo

Elimina cartella

DELETE /v1/folders/:id

In arrivo

Copia cartella

POST /v1/folders/:id/copy

In arrivo

Si prega di assicurarsi di aver seguito le istruzioni di configurazione per il proprio dominio.

Queste istruzioni si trovano in Il mio account → Domini → Impostazioni → Configurazione SMTP in uscita. Devi assicurarti della configurazione di DKIM, Return-Path e DMARC per l'invio SMTP in uscita con il tuo dominio.

Ottieni limite email SMTP in uscita

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

GET /v1/emails/limit

Esempio di richiesta:

curl https://fe.tiamati.email/v1/emails/limit \
  -u API_TOKEN:

Elenca email SMTP in uscita

Nota che questo endpoint non restituisce i valori delle proprietà per il message, headers né rejectedErrors di un'email.

Per restituire quelle proprietà e i loro valori, usa l'endpoint Recupera email con un ID email.

GET /v1/emails

Esempio di richiesta:

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

Crea email SMTP in uscita

La nostra API per creare un'email è ispirata e sfrutta la configurazione delle opzioni messaggio di Nodemailer. Consulta la configurazione messaggio di Nodemailer per tutti i parametri del corpo qui sotto.

Nota che, fatta eccezione per envelope e dkim (poiché li impostiamo automaticamente per te), supportiamo tutte le opzioni di Nodemailer. Impostiamo automaticamente le opzioni disableFileAccess e disableUrlAccess a true per motivi di sicurezza.

Devi passare o l'unica opzione raw con la tua email completa raw inclusi gli header oppure passare i singoli parametri del corpo elencati di seguito.

Questo endpoint API codificherà automaticamente le emoji per te se sono presenti negli header (es. una riga oggetto Subject: 🤓 Hello viene convertita automaticamente in Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Il nostro obiettivo è stato creare un'API email estremamente amichevole per gli sviluppatori e a prova di errore.

Autenticazione: Questo endpoint supporta sia l'autenticazione con token API sia l'autenticazione con credenziali alias. Consulta la sezione Autenticazione sopra per i dettagli.

POST /v1/emails

Richiesta di esempio (Token API):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Richiesta di esempio (Credenziali Alias):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Richiesta di esempio (Email Raw):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Recupera email SMTP in uscita

GET /v1/emails/:id

Richiesta di esempio:

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Elimina email SMTP in uscita

L'eliminazione dell'email imposterà lo stato su "rejected" (e successivamente non la processerà nella coda) se e solo se lo stato attuale è uno tra "pending", "queued", o "deferred". Potremmo eliminare automaticamente le email dopo 30 giorni dalla loro creazione e/o invio – pertanto dovresti conservare una copia delle email SMTP in uscita nel tuo client, database o applicazione. Puoi fare riferimento al nostro valore ID email nel tuo database se desideri – questo valore viene restituito sia dagli endpoint Create email che Retrieve email.

DELETE /v1/emails/:id

Richiesta di esempio:

curl -X DELETE https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Elenca domini

GET /v1/domains

Richiesta di esempio:

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

Crea dominio

POST /v1/domains

Esempio di richiesta:

curl -X POST https://fe.tiamati.email/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Recupera dominio

GET /v1/domains/example.com

Esempio di richiesta:

curl https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Verifica record dominio

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

Esempio di richiesta:

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Verifica record SMTP dominio

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

Esempio di richiesta:

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Elenca password catch-all a livello di dominio

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

Esempio di richiesta:

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Crea password catch-all a livello di 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 password catch-all a livello di dominio

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

Esempio di richiesta:

curl -X DELETE https://fe.tiamati.email/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://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Elimina dominio

DELETE /v1/domains/:domain_name

Esempio di richiesta:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name \
  -u API_TOKEN:

Accetta invito dominio

GET /v1/domains/:domain_name/invites

Esempio di richiesta:

curl https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Crea invito dominio

POST /v1/domains/example.com/invites

Esempio di richiesta:

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

Rimuovi invito dominio

DELETE /v1/domains/:domain_name/invites

Esempio di richiesta:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Aggiorna membro dominio

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

Esempio di richiesta:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Rimuovi membro dominio

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

Esempio di richiesta:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Genera una password per alias

Nota che se non invii istruzioni via email, allora username e password saranno 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://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Elenca alias di dominio

GET /v1/domains/example.com/aliases

Esempio di richiesta:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Crea nuovo alias di dominio

POST /v1/domains/example.com/aliases

Esempio di richiesta:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

Recupera alias di dominio

Puoi 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://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

Esempio di richiesta:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Aggiorna alias di dominio

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

Esempio di richiesta:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Elimina alias dominio

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

Esempio di richiesta:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Consentiamo di crittografare i record anche nel piano gratuito senza costi. La privacy non dovrebbe essere una funzionalità, dovrebbe essere intrinsecamente integrata in tutti gli aspetti di un prodotto. Come molto richiesto in una discussione di Privacy Guides e nelle nostre issue su GitHub abbiamo aggiunto questa funzione.

Crittografa record TXT

POST /v1/encrypt

Esempio di richiesta:

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"