E-posta API'si

Şu anda henüz herhangi bir API sarmalayıcısı yayınlamadık, ancak yakın gelecekte bunu yapmayı planlıyoruz. Belirli bir programlama dilinin API sarmalayıcısı yayınlandığında bilgilendirilmek isterseniz api@forwardemail.net adresine e-posta gönderin. Bu arada, uygulamanızda bu önerilen HTTP istek kütüphanelerini kullanabilir veya aşağıdaki örneklerde olduğu gibi basitçe curl kullanabilirsiniz.

Mevcut HTTP temel URI yolu: https://fe.tiamati.email.

Tüm uç noktalar Temel Yetkilendirme kullanılarak kimlik doğrulaması gerektirir. İki kimlik doğrulama yöntemi destekliyoruz:

API Jetonu Kimlik Doğrulaması (Çoğu uç nokta için önerilir)

API anahtarınızı "kullanıcı adı" değeri olarak, boş bir parola ile ayarlayın:

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

API jetonundan sonra gelen iki nokta üst üste (:) işaretine dikkat edin – bu, Temel Yetkilendirme formatında boş bir parolayı gösterir.

Takma Ad Kimlik Bilgileri Kimlik Doğrulaması (Giden e-posta için)

SMTP üzerinden giden e-posta oluşturma uç noktası, takma ad e-posta adresiniz ve oluşturulmuş takma ad parolası kullanılarak kimlik doğrulamayı da destekler:

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"

Bu yöntem, zaten SMTP kimlik bilgileri kullanan uygulamalardan e-posta gönderirken faydalıdır ve SMTP'den API'ye geçişi sorunsuz hale getirir.

Sadece Takma Ad Uç Noktaları

Takma Ad Kişileri, Takma Ad Takvimleri, Takma Ad Mesajları ve Takma Ad Klasörleri uç noktaları takma ad kimlik bilgileri gerektirir ve API jetonu kimlik doğrulamasını desteklemez.

Endişelenmeyin – ne olduğunu bilmiyorsanız aşağıda örnekler sağlanmıştır.

Herhangi bir hata oluşursa, API isteğinin yanıt gövdesinde ayrıntılı bir hata mesajı bulunacaktır.

Hizmetimiz 25'ten fazla farklı dile çevrilmiştir. Tüm API yanıt mesajları, API isteğini yapan kullanıcının algılanan son yereline göre çevrilir. Bunu, özel bir Accept-Language başlığı geçirerek geçersiz kılabilirsiniz. Bu sayfanın altındaki dil açılır menüsünü kullanarak denemekten çekinmeyin.

Sayfalama, sonuçları listeleyen tüm API uç noktaları tarafından desteklenir.

Sadece page (ve isteğe bağlı olarak limit) sorgu dizesi özelliklerini sağlayın.

page özelliği 1 veya daha büyük bir sayı olmalıdır. limit sağlarsanız (o da bir sayı), minimum değer 10 ve maksimum değer 50'dir (aksi belirtilmedikçe).

Örnek İstek:

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

Kayıtları al

API'miz, hesabınız için kayıtları programlı olarak indirmenize olanak tanır. Bu uç noktaya yapılan bir istek, hesabınızdaki tüm kayıtları işler ve tamamlandığında bunları bir ek olarak (Gzip sıkıştırılmış CSV elektronik tablo dosyası) e-posta ile size gönderir.

Bu, istediğiniz zaman kayıtları almak için bir Cron işi veya bizim Node.js iş zamanlama yazılımımız Bree kullanarak arka plan işleri oluşturmanıza olanak tanır. Bu uç noktanın günde 10 istek ile sınırlı olduğunu unutmayın.

Ek dosya, email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz dosyasının küçük harfli hali olup, e-postanın kendisi alınan kayıtların kısa bir özetini içerir. Ayrıca kayıtları istediğiniz zaman Hesabım → Kayıtlar bölümünden indirebilirsiniz.

GET /v1/logs/download

Örnek İstek:

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

Örnek Cron işi (her gece yarısı):

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

Cron işi ifade sözdiziminizi doğrulamak için Crontab.guru gibi hizmetleri kullanabileceğinizi unutmayın.

Örnek Cron işi (her gece yarısı ve önceki günün kayıtları ile):

MacOS için:

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

Linux ve Ubuntu için:

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

Hesap oluştur

POST /v1/account

Örnek İstek:

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

Hesabı al

GET /v1/account

Örnek İstek:

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

Hesabı güncelle

PUT /v1/account

Örnek İstek:

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

Kişileri listele

GET /v1/contacts

Yakında geliyor

Kişi oluştur

POST /v1/contacts

Yakında geliyor

Kişiyi getir

GET /v1/contacts/:id

Yakında geliyor

Kişiyi güncelle

PUT /v1/contacts/:id

Yakında geliyor

Kişiyi sil

DELETE /v1/contacts/:id

Yakında geliyor

Takvimleri listele

GET /v1/calendars

Yakında geliyor

Takvim oluştur

POST /v1/calendars

Yakında geliyor

Takvimi getir

GET /v1/calendars/:id

Yakında geliyor

Takvimi güncelle

PUT /v1/calendars/:id

Yakında geliyor

Takvimi sil

DELETE /v1/calendars/:id

Yakında geliyor

Lütfen alan adınız için kurulum talimatlarını takip ettiğinizden emin olun.

Bu talimatlar SSS bölümümüzde IMAP ile e-posta almayı destekliyor musunuz? başlığı altında bulunabilir.

Mesajları listele ve ara

GET /v1/messages

Yakında geliyor

Mesaj oluştur

POST /v1/messages

Yakında geliyor

Mesajı getir

GET /v1/messages/:id

Yakında geliyor

Mesajı güncelle

PUT /v1/messages/:id

Yakında geliyor

Mesajı sil

DELETE /v1/messages:id

Yakında geliyor

Klasörleri listele

GET /v1/folders

Yakında geliyor

Klasör oluştur

POST /v1/folders

Yakında geliyor

Klasörü getir

GET /v1/folders/:id

Yakında geliyor

Klasörü güncelle

PUT /v1/folders/:id

Yakında geliyor

Klasörü sil

DELETE /v1/folders/:id

Yakında geliyor

Klasörü kopyala

POST /v1/folders/:id/copy

Yakında geliyor

Lütfen alan adınız için kurulum talimatlarını takip ettiğinizden emin olun.

Bu talimatlar Hesabım → Alan Adları → Ayarlar → Giden SMTP Yapılandırması bölümünde bulunabilir. Giden SMTP ile alan adınızdan e-posta göndermek için DKIM, Return-Path ve DMARC yapılandırmalarını sağlamanız gerekmektedir.

Giden SMTP e-posta limiti al

Bu, günlük SMTP giden mesaj sayısı için hesap bazında count ve limit içeren bir JSON nesnesi döndüren basit bir uç noktadır.

GET /v1/emails/limit

Örnek İstek:

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

Giden SMTP e-postalarını listele

Bu uç noktanın bir e-postanın message, headers veya rejectedErrors özellik değerlerini döndürmediğine dikkat edin.

Bu özellikleri ve değerlerini döndürmek için lütfen bir e-posta ID'si ile E-postayı al uç noktasını kullanın.

GET /v1/emails

Örnek İstek:

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

Giden SMTP e-postası oluştur

E-posta oluşturma API'miz Nodemailer'ın mesaj seçenek yapılandırmasından esinlenmiş ve onu kullanmaktadır. Aşağıdaki tüm gövde parametreleri için lütfen Nodemailer mesaj yapılandırması bölümüne bakınız.

envelope ve dkim dışında (bunları sizin için otomatik ayarladığımız için) tüm Nodemailer seçeneklerini desteklediğimizi unutmayın. Güvenlik amacıyla disableFileAccess ve disableUrlAccess seçeneklerini otomatik olarak true olarak ayarlıyoruz.

Ya başlıklar dahil tam ham e-postanızı içeren tek bir raw seçeneğini geçmelisiniz veya aşağıdaki bireysel gövde parametre seçeneklerini kullanmalısınız.

Bu API uç noktası, başlıklarda emoji bulunursa bunları otomatik olarak kodlar (örneğin Subject: 🤓 Hello konusu otomatik olarak Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello olarak dönüştürülür). Amacımız son derece geliştirici dostu ve hata yapmaya karşı dayanıklı bir e-posta API'si sağlamaktı.

Kimlik Doğrulama: Bu uç nokta hem API token kimlik doğrulamasını hem de takma ad kimlik bilgileri kimlik doğrulamasını destekler. Detaylar için yukarıdaki Kimlik Doğrulama bölümüne bakınız.

POST /v1/emails

Örnek İstek (API Token):

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"

Örnek İstek (Alias Kimlik Bilgileri):

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"

Örnek İstek (Ham E-posta):

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

Giden SMTP e-postasını al

GET /v1/emails/:id

Örnek İstek:

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

Giden SMTP e-postasını sil

E-posta silme işlemi, mevcut durum yalnızca "pending", "queued" veya "deferred" ise durumu "rejected" olarak ayarlayacak (ve böylece kuyruğa işlemeyecektir). E-postalar oluşturulduktan ve/veya gönderildikten sonra 30 gün içinde otomatik olarak temizlenebilir – bu nedenle giden SMTP e-postalarının bir kopyasını istemcinizde, veritabanınızda veya uygulamanızda saklamalısınız. İsterseniz veritabanınızda e-posta ID değerimize referans verebilirsiniz – bu değer hem E-posta oluştur hem de E-postayı al uç noktalarından döndürülür.

DELETE /v1/emails/:id

Örnek İstek:

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

Alan adlarını listele

GET /v1/domains

Örnek İstek:

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

Alan adı oluştur

POST /v1/domains

Örnek İstek:

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

Alan adını al

GET /v1/domains/example.com

Örnek İstek:

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

Alan adı kayıtlarını doğrula

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

Örnek İstek:

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

Alan adı SMTP kayıtlarını doğrula

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

Örnek İstek:

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

Alan genelindeki catch-all şifrelerini listele

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

Örnek İstek:

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

Alan genelinde catch-all şifresi oluştur

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

Örnek İstek:

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

Alan genelindeki catch-all şifresini kaldır

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

Örnek İstek:

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

Alan adını güncelle

PUT /v1/domains/example.com

Örnek İstek:

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

Alan adını sil

DELETE /v1/domains/:domain_name

Örnek İstek:

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

Alan adı davetini kabul et

GET /v1/domains/:domain_name/invites

Örnek İstek:

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

Alan adı daveti oluştur

POST /v1/domains/example.com/invites

Örnek İstek:

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

Alan adı davetini kaldır

DELETE /v1/domains/:domain_name/invites

Örnek İstek:

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

Alan adı üyesini güncelle

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

Örnek İstek:

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

Alan adı üyesini kaldır

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

Örnek İstek:

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

Takma ad parolası oluştur

Eğer talimatları e-posta ile göndermezseniz, kullanıcı adı ve parola başarılı bir isteğin JSON yanıt gövdesinde { username: 'alias@yourdomain.com', password: 'some-generated-password' } formatında olacaktır.

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

Örnek İstek:

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

Alan adı takma adlarını listele

GET /v1/domains/example.com/aliases

Örnek İstek:

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

Yeni alan adı takma adı oluştur

POST /v1/domains/example.com/aliases

Örnek İstek:

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

Alan adı takma adını al

Bir alan adı takma adını ya id ya da name değeri ile alabilirsiniz.

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

Örnek İstek:

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

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

Örnek İstek:

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

Alan adı takma adını güncelle

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

Örnek İstek:

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

Alan adı takma adını sil

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

Örnek İstek:

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

Kayıtları ücretsiz planda bile ücretsiz olarak şifrelemenize izin veriyoruz. Gizlilik bir özellik olmamalı, ürünün tüm yönlerine doğrudan entegre edilmiş olmalıdır. Privacy Guides tartışmasında ve GitHub sorunlarımızda yoğun talep üzerine bunu ekledik.

TXT Kaydını Şifrele

POST /v1/encrypt

Örnek İstek:

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