E-posta API'si

Şu anda herhangi bir API sarmalayıcısı yayınlamadık, ancak yakın gelecekte yayınlamayı planlıyoruz. Belirli bir programlama dilinin API sarmalayıcısı yayınlandığında bildirim almak isterseniz api@forwardemail.net adresine e-posta gönderin. Bu arada, uygulamanızda bu önerilen HTTP istek kitaplıklarını kullanabilir veya aşağıdaki örneklerde olduğu gibi bukle kullanabilirsiniz.

Mevcut HTTP taban URI yolu: https://api.forwardemail.net.

Tüm uç noktalar, API anahtarı'ınızın isteğin Temel Yetkilendirme başlığının "kullanıcı adı" değeri olarak ayarlanmasını gerektirir (oluşturulan takma ad kullanıcı adı ve şifresi kullanan Takma Ad Kişileri, Takma Adlı Takvimler ve Takma Adlı Posta Kutuları hariç).

Endişelenmeyin, eğer bunun ne olduğunu bilmiyorsanız aşağıda sizin için örnekler verilmiştir.

Herhangi bir hata oluşursa, API isteğinin yanıt gövdesi ayrıntılı bir hata mesajı içerecektir.

Hizmetimiz 25'ten fazla farklı dile çevrilmiştir. Tüm API yanıt mesajları, API isteğinde bulunan kullanıcının algıladığı son yerel ayara çevrilir. Özel bir Accept-Language başlığı geçirerek bunu geçersiz kılabilirsiniz. Bu sayfanın alt kısmındaki dil açılır menüsünü kullanarak deneyebilirsiniz.

Sayfalandırma, 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'den büyük veya ona eşit bir sayı olmalıdır. limit (aynı zamanda bir sayı) sağlarsanız, minimum değer 10, maksimum değer ise 50 olur (aksi belirtilmedikçe).

Daha fazla sonucun mevcut olup olmadığını belirlemek için, şu HTTP yanıt başlıklarını sağlıyoruz (bunları programatik olarak sayfalandırmak için ayrıştırabilirsiniz):

Örnek Talep:

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

Günlükleri al

API'miz, hesabınız için günlükleri programatik olarak indirmenize olanak tanır. Bu uç noktaya bir istek gönderdiğinizde, hesabınızdaki tüm günlükler işlenir ve tamamlandığında ek olarak (Gzip sıkıştırılmış CSV elektronik tablo dosyası) size e-posta ile gönderilir.

Bu, Cron işi ile arka plan işleri oluşturmanıza veya istediğiniz zaman günlükleri almak için Node.js iş planlama yazılımı Bree'imizi kullanmanıza olanak tanır. Bu uç noktanın günde 10 istekle sınırlı olduğunu unutmayın.

Ek, email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz dosyasının küçük harfli halidir ve e-postanın kendisi, alınan günlüklerin kısa bir özetini içerir. Ayrıca, günlükleri istediğiniz zaman Hesabım → Günlükler adresinden indirebilirsiniz.

GET /v1/logs/download

Örnek Talep:

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

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

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

Cron iş ifadesi sözdizimini doğrulamak için Crontab.guru gibi servisleri kullanabileceğinizi unutmayın.

Örnek Cron işi (her gün gece yarısı ve bir önceki güne ait kayıtlarla):

MacOS için:

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

Linux ve Ubuntu için:

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

Hesap oluştur

POST /v1/account

Örnek Talep:

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

{#retrieve-account} hesabını al

GET /v1/account

Örnek Talep:

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

{#update-account} hesabını güncelle

PUT /v1/account

Örnek Talep:

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

Kişileri listele

GET /v1/contacts

Yakında gelecek

Kişiyi oluştur

POST /v1/contacts

Yakında gelecek

{#retrieve-contact} kişisini al

GET /v1/contacts/:id

Yakında gelecek

Kişiyi güncelle

PUT /v1/contacts/:id

Yakında gelecek

Kişiyi sil

DELETE /v1/contacts/:id

Yakında gelecek

Takvimleri listele

GET /v1/calendars

Yakında gelecek

Takvimi oluştur

POST /v1/calendars

Yakında gelecek

Takvimi al

GET /v1/calendars/:id

Yakında gelecek

Takvimi güncelle

PUT /v1/calendars/:id

Yakında gelecek

Takvimi sil

DELETE /v1/calendars/:id

Yakında gelecek

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

Bu talimatlara SSS bölümümüzden ulaşabilirsiniz E-postaların IMAP ile alınmasını destekliyor musunuz?.

Mesajları listele ve ara

GET /v1/messages

Yakında gelecek

{#create-message} mesajını oluştur

POST /v1/messages

Yakında gelecek

{#retrieve-message} mesajını al

GET /v1/messages/:id

Yakında gelecek

Güncelleme mesajı

PUT /v1/messages/:id

Yakında gelecek

Mesajı sil

DELETE /v1/messages:id

Yakında gelecek

Klasörleri listele

GET /v1/folders

Yakında gelecek

{#create-folder} klasörünü oluştur

POST /v1/folders

Yakında gelecek

{#retrieve-folder} klasörünü al

GET /v1/folders/:id

Yakında gelecek

{#update-folder} klasörünü güncelle

PUT /v1/folders/:id

Yakında gelecek

{#delete-folder} klasörünü sil

DELETE /v1/folders/:id

Yakında gelecek

{#copy-folder} klasörünü kopyala

POST /v1/folders/:id/copy

Yakında gelecek

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

Bu talimatlar Hesabım → Alan Adları → Ayarlar → Giden SMTP Yapılandırması adresinde bulunabilir. Alan adınızla giden SMTP göndermek için DKIM, Return-Path ve DMARC ayarlarının doğru olduğundan emin olmanız gerekir.

Giden SMTP e-posta sınırını al

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

GET /v1/emails/limit

Örnek Talep:

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

Giden SMTP e-postalarını listele

Bu uç noktanın bir e-postanın message, headers veya rejectedErrors için özellik değerlerini döndürmediğini unutmayın.

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

GET /v1/emails

Örnek Talep:

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

Giden SMTP e-postası oluştur

E-posta oluşturma API'miz, Nodemailer'ın mesaj seçeneği yapılandırmasından esinlenmiştir ve bu yapılandırmayı kullanır. Lütfen aşağıdaki tüm gövde parametreleri için Nodemailer mesaj yapılandırması parametresini kullanın.

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

raw seçeneğini, başlıklar dahil olmak üzere ham tam e-postanızla birlikte iletmelisiniz veya aşağıdaki bireysel gövde parametre seçeneklerini iletmelisiniz.

Bu API uç noktası, başlıklarda bulunan emojileri sizin için otomatik olarak kodlayacaktır (örneğin, Subject: 🤓 Hello konu satırı otomatik olarak Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello'e dönüştürülür). Amacımız, son derece geliştirici dostu ve sahte metinlere karşı dayanıklı bir e-posta API'si oluşturmaktı.

POST /v1/emails

Örnek Talep:

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"

Örnek Talep:

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

Giden SMTP e-postasını al

GET /v1/emails/:id

Örnek Talep:

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

Giden SMTP e-postasını sil

E-posta silme işlemi, yalnızca geçerli durum "pending", "queued" veya "deferred"'ten biriyse durumu "rejected" olarak ayarlar (ve daha sonra kuyrukta işlemez). E-postaları oluşturulduktan ve/veya gönderildikten 30 gün sonra otomatik olarak temizleyebiliriz; 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 kimliği değerimize başvurabilirsiniz; 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 Talep:

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

Alan adlarını listele

GET /v1/domains

Örnek Talep:

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

{#create-domain} etki alanını oluştur

POST /v1/domains

Örnek Talep:

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

{#retrieve-domain} etki alanını al

GET /v1/domains/example.com

Örnek Talep:

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

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

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

Örnek Talep:

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

Etki alanı SMTP kayıtlarını doğrulayın

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

Örnek Talep:

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

Alan adı genelindeki tüm parolaları listele

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

Örnek Talep:

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

Alan adı genelinde geçerli parolayı oluştur

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

Örnek Talep:

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

Alan adı genelindeki tüm parolayı kaldır

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

Örnek Talep:

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

Etki alanını güncelle

PUT /v1/domains/example.com

Örnek Talep:

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

{#delete-domain} etki alanını sil

DELETE /v1/domains/:domain_name

Örnek Talep:

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

Alan davetini kabul et

GET /v1/domains/:domain_name/invites

Örnek Talep:

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

Etki alanı daveti oluştur

POST /v1/domains/example.com/invites

Örnek Talep:

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

Alan davetini kaldır

DELETE /v1/domains/:domain_name/invites

Örnek Talep:

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

Etki alanı üyesini güncelle

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

Örnek Talep:

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

Etki alanı üyesini kaldır

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

Örnek Talep:

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

Bir takma ad parolası oluşturun

Talimatları e-postayla göndermezseniz, kullanıcı adı ve parolanın başarılı bir isteğin JSON yanıt gövdesinde { username: 'alias@yourdomain.com', password: 'some-generated-password' } biçiminde olacağını unutmayın.

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

Örnek Talep:

curl -X POST https://api.forwardemail.net/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 Talep:

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

Yeni alan adı takma adı {#create-new-domain-alias} oluşturun

POST /v1/domains/example.com/aliases

Örnek Talep:

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

Alan adı takma adını al

Bir alan takma adını id veya name değeriyle alabilirsiniz.

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

Örnek Talep:

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

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

Örnek Talep:

curl https://api.forwardemail.net/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 Talep:

curl -X PUT https://api.forwardemail.net/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 Talep:

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

Ücretsiz planda bile kayıtlarınızı ücretsiz olarak şifrelemenize olanak tanıyoruz. Gizlilik bir özellik olmamalı, ürünün tüm yönlerine entegre edilmelidir. Gizlilik Kılavuzları tartışması ve GitHub sorunlarımız'de yoğun talep üzerine bunu ekledik.

TXT Kaydını Şifrele

POST /v1/encrypt

Örnek Talep:

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