E-posta API'sı

Şu anda henüz herhangi bir API sarmalayıcı yayınlamadık, ancak bunu yakın gelecekte yapmayı planlıyoruz. e-posta gönder api@forwardemail.net belirli bir programlama dilinin API sarmalayıcısı yayınlandığında bilgilendirilmek istiyorsanız. Bu arada, uygulamanızda bu önerilen HTTP istek kitaplıklarını kullanabilir veya sadece bukle aşağıdaki örneklerde olduğu gibi.

Geçerli HTTP temel URI yolu: https://api.forwardemail.net.

Tüm uç noktalar için API anahtarı isteğin "kullanıcı adı" değeri olarak ayarlanacak Temel Yetkilendirme başlık (istisnalar hariç) Takma Adlı Kişiler, Takma Adlı Takvimler, ve Takma Adlı Posta Kutuları hangisini kullanır oluşturulan takma ad kullanıcı adı ve şifre)..

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

Herhangi bir hata meydana gelirse, API isteğinin yanıt gövdesi ayrıntılı bir hata mesajı içerir.

[!TIP] 5xx durum kodunu alırsanız (ki bu olmamalı), lütfen bizimle şu adresten iletişime geçin: api@forwardemail.net ve sorununuzu hemen çözmenize yardımcı olacağız.

Hizmetimiz 25'in üzerinde farklı dile çevrilmiştir. Tüm API yanıt mesajları, API isteğinde bulunan kullanıcının tespit edilen son yerel ayarına çevrilir. Bir özel ileterek bunu geçersiz kılabilirsiniz Accept-Language başlık. Bu sayfanın altındaki dil açılır menüsünü kullanarak bunu denemekten çekinmeyin.

[!NOT] 1 Kasım 2024 itibarıyla API uç noktaları Alan adlarını listele ve Alan takma adlarını listeleyin varsayılan olarak 1000 sayfa başına maksimum sonuç. Bu davranışı erken kabul etmek isterseniz, geçebilirsiniz ?paginate=true uç nokta sorgusu için URL'ye ek bir sorgu dizesi parametresi olarak.

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

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

Özellik page şu değerden büyük veya ona eşit bir sayı olmalıdır 1. Eğer sağlarsanız limit (aynı zamanda bir sayı), minimum değer şu olur: 10 ve maksimum değer 50 (aksi belirtilmedikçe).

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

Örnek İstek:

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

Günlükleri al

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

Bu, arka plan işleri oluşturmanıza olanak tanır. Cron işi veya bizim kullanımımızı kullanarak Node.js iş planlama yazılımı Bree İstediğiniz zaman günlükleri almak için. Bu uç noktanın aşağıdakilerle sınırlı olduğunu unutmayın 10 günlük talepler.

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

GET /v1/logs/download

Örnek İstek:

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

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

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

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 İstek:

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

Hesabı kurtar

GET /v1/account

Örnek İstek:

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

Hesabı güncelle

PUT /v1/account

Örnek İstek:

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

[!NOTE] Diğer API uç noktalarından farklı olarak, bunlar şunları gerektirir: Kimlik Doğrulama "kullanıcı adı" takma ad kullanıcı adına, "şifre" ise takma ad tarafından oluşturulan parolaya eşit olarak Temel Yetkilendirme başlıklarıyla verilmelidir.

[!UYARI] Bu uç nokta bölümü devam eden bir çalışmadır ve (umarız) 2024'te yayınlanacaktır. Bu arada lütfen web sitemizin gezinme bölümündeki "Uygulamalar" açılır menüsünden bir IMAP istemcisi kullanın.

Kişileri listele

GET /v1/contacts

Çok yakında

İletişim oluştur

POST /v1/contacts

Çok yakında

İletişimi al

GET /v1/contacts/:id

Çok yakında

İletişim bilgilerini güncelle

PUT /v1/contacts/:id

Çok yakında

Kişiyi sil

DELETE /v1/contacts/:id

Çok yakında

[!NOTE] Diğer API uç noktalarından farklı olarak, bunlar şunları gerektirir: Kimlik Doğrulama "kullanıcı adı" takma ad kullanıcı adına, "şifre" ise takma ad tarafından oluşturulan parolaya eşit olarak Temel Yetkilendirme başlıklarıyla verilmelidir.

[!UYARI] Bu uç nokta bölümü devam eden bir çalışmadır ve (umarız) 2024'te yayınlanacaktır. Bu arada lütfen web sitemizin gezinme bölümündeki "Uygulamalar" açılır menüsünden bir IMAP istemcisi kullanın.

Takvimleri listele

GET /v1/calendars

Çok yakında

Takvim oluştur

POST /v1/calendars

Çok yakında

Takvimi al

GET /v1/calendars/:id

Çok yakında

Takvimi güncelle

PUT /v1/calendars/:id

Çok yakında

Takvimi sil

DELETE /v1/calendars/:id

Çok yakında

[!NOTE] Diğer API uç noktalarından farklı olarak, bunlar şunları gerektirir: Kimlik Doğrulama "kullanıcı adı" takma ad kullanıcı adına, "şifre" ise takma ad tarafından oluşturulan parolaya eşit olarak Temel Yetkilendirme başlıklarıyla verilmelidir.

[!UYARI] Bu uç nokta bölümü devam eden bir çalışmadır ve (umarız) 2024'te yayınlanacaktır. Bu arada lütfen web sitemizin gezinme bölümündeki "Uygulamalar" açılır menüsünden bir IMAP istemcisi kullanın.

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

Bu talimatlar SSS bölümümüzde bulunabilir IMAP ile e-posta alımını destekliyor musunuz?.

Mesajları listele ve ara

GET /v1/messages

Çok yakında

Mesaj oluştur

[!NOT] Bu, NOT bir e-posta göndermez – yalnızca mesajı posta kutusu klasörünüze ekler (örneğin, IMAP'teki APPEND komutuna benzer). E-posta göndermek istiyorsanız, bkz. Giden SMTP e-postası oluştur aşağıda. Giden SMTP e-postasını oluşturduktan sonra, bu uç noktayı kullanarak bir kopyasını takma adınızın posta kutusuna ekleyebilirsiniz.

POST /v1/messages

Çok yakında

Mesajı al

GET /v1/messages/:id

Çok yakında

Mesajı güncelle

PUT /v1/messages/:id

Çok yakında

Mesajı sil

DELETE /v1/messages:id

Çok yakında

[!TIP] Klasörün yolu olan klasör uç noktaları /v1/folders/:path uç noktaları bir klasör kimliği ile değiştirilebilir :idBu, klasöre şu şekilde başvurabileceğiniz anlamına gelir: path veya id değer.

[!UYARI] Bu uç nokta bölümü devam eden bir çalışmadır ve (umarız) 2024'te yayınlanacaktır. Bu arada lütfen web sitemizin gezinme bölümündeki "Uygulamalar" açılır menüsünden bir IMAP istemcisi kullanın.

Klasörleri listele

GET /v1/folders

Çok yakında

Klasör oluştur

POST /v1/folders

Çok yakında

Klasörü al

GET /v1/folders/:id

Çok yakında

Klasörü güncelle

PUT /v1/folders/:id

Çok yakında

Klasörü sil

DELETE /v1/folders/:id

Çok yakında

Klasörü kopyala

POST /v1/folders/:id/copy

Çok yakında

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

Bu talimatlar şu adreste bulunabilir: Hesabım → Etki Alanları → Ayarlar → Giden SMTP Yapılandırması. Alanınızla giden SMTP göndermek için DKIM, Dönüş Yolu ve DMARC kurulumunu sağlamanız gerekir.

Giden SMTP e-posta limitini al

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

GET /v1/emails/limit

Örnek İstek:

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 özellik değerlerini döndürmediğini unutmayın message, headersne de rejectedErrors.

Bu özellikleri ve değerlerini döndürmek için lütfen e-posta al bir e-posta kimliği ile uç nokta.

GET /v1/emails

Örnek İstek:

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

Giden SMTP e-postası oluştur

Bir e-posta oluşturmaya yönelik API'miz, Nodemailer'ın mesaj seçeneği yapılandırmasından ilham alır ve ondan yararlanır. lütfen erteleyin Nodemailer mesaj yapılandırması Aşağıdaki tüm vücut parametreleri için.

Şunlar dışında envelope ve dkim (bunları sizin için otomatik olarak ayarladığımız için), tüm Nodemailer seçeneklerini destekliyoruz. Otomatik olarak ayarladık disableFileAccess ve disableUrlAccess seçenekleri true güvenlik amaçlı.

Ya tek seçeneğini geçmelisiniz raw başlıklar dahil ham tam e-postanızla veya aşağıdaki bireysel gövde parametresi seçeneklerini iletin.

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

POST /v1/emails

Örnek İstek:

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 İstek:

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 İstek:

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

Giden SMTP e-postasını sil

E-posta silme, durumu şu şekilde ayarlayacaktır: "rejected" (ve daha sonra onu kuyrukta işlemeyin) ancak ve ancak mevcut durum şunlardan biriyse "pending", "queued", veya "deferred". 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ı müşterinizde, veritabanınızda veya uygulamanızda tutmalısınız. İsterseniz veritabanınızdaki e-posta kimliği değerimize başvurabilirsiniz - bu değer her ikisinden de döndürülür e-posta oluştur ve e-posta al uç noktalar.

DELETE /v1/emails/:id

Örnek İstek:

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

[!TIP] Bir alan adına sahip alan uç noktaları /v1/domains/:domain_name uç noktaları bir alan kimliğiyle değiştirilebilir :domain_id. Bu, etki alanına şu şekilde başvurabileceğiniz anlamına gelir: name veya id değer.

Alan adlarını listele

[!NOT] 1 Kasım 2024 itibarıyla API uç noktaları Alan adlarını listele ve Alan takma adlarını listeleyin varsayılan olarak 1000 sayfa başına maksimum sonuç. Bu davranışı erken kabul etmek isterseniz, geçebilirsiniz ?paginate=true uç nokta sorgusu için URL'ye ek bir sorgu dizesi parametresi olarak. Bkz. sayfalara numara koyma daha fazla bilgi için.

GET /v1/domains

Örnek İstek:

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

Alan adı oluştur

POST /v1/domains

Örnek İstek:

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

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

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

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

Örnek İstek:

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 İstek:

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

Alan genelinde kapsayıcı parola oluşturun

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

Örnek İstek:

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

Alan adı genelinde geçerli olan genel parolayı kaldırın

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

Örnek İstek:

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

Alan adını güncelleyin

PUT /v1/domains/example.com

Örnek İstek:

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

Alan adını sil

DELETE /v1/domains/:domain_name

Örnek İstek:

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

Alan adı davetini kabul et

GET /v1/domains/:domain_name/invites

Örnek İstek:

curl https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

[!ÖNEMLİ] Davet edilen kullanıcı, davet eden yöneticinin üyesi olduğu başka bir etki alanının kabul edilmiş bir üyesiyse, daveti otomatik olarak kabul edecek ve e-posta göndermeyecektir.

Alan adı davetini kaldır

DELETE /v1/domains/:domain_name/invites

Örnek İstek:

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

Alan adını güncelleyin

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

Örnek İstek:

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 İstek:

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

Takma ad şifresi oluşturun

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

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

Örnek İstek:

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

Alan takma adlarını listeleyin

[!NOT] 1 Kasım 2024 itibarıyla API uç noktaları Alan adlarını listele ve Alan takma adlarını listeleyin varsayılan olarak 1000 sayfa başına maksimum sonuç. Bu davranışı erken kabul etmek isterseniz, geçebilirsiniz ?paginate=true uç nokta sorgusu için URL'ye ek bir sorgu dizesi parametresi olarak. Bkz. sayfalara numara koyma daha fazla bilgi için.

GET /v1/domains/example.com/aliases

Örnek İstek:

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

Yeni alan takma adı oluştur

POST /v1/domains/example.com/aliases

Örnek İstek:

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

Alan takma adını al

Bir alan takma adını aşağıdakilerden biri ile alabilirsiniz: id veya onun name değer.

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

Örnek İstek:

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

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

Örnek İstek:

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

Alan takma adını güncelleme

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

Örnek İstek:

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

Alan takma adını sil

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

Örnek İstek:

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

Kayıtları ücretsiz planda bile ücretsiz olarak şifrelemenize izin veriyoruz. Gizlilik bir özellik olmamalıdır; bir ürünün tüm yönlerine doğası gereği yerleşik olmalıdır. Çok talep edildiği gibi Gizlilik Kılavuzları tartışması ve üzerinde GitHub sorunlarımız bunu ekledik.

TXT Kaydını Şifrele

POST /v1/encrypt

Örnek İstek:

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