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. Endişelenmeyin – bunun ne olduğundan emin değilseniz aşağıda örnekler verilmiştir.

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

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.

Sayfalandırma kullanılabilir olduğunda bilgilendirilmek istiyorsanız, lütfen e-posta gönderin api@forwardemail.net.

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"

Lütfen alan adınız için kurulum talimatlarını uyguladığınızdan 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.

E-postaları listele

Bu uç noktanın önceden oluşturulmuş bir e-postayı döndürmediğini unutmayın. message, headers, acceptedne de rejectedErrors özellikler.

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

Bu uç nokta en fazla geri dönecek 50 bir anda sonuçlar. Birden fazla sayfayı sorgulamak istiyorsanız şunu ekleyin: ?page=NUMBER Neresi NUMBER bir tamsayıdır, ör. ?page=1.

GET /v1/emails

Örnek İstek:

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

e-posta 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.

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`"

e-posta al

GET /v1/emails/:id

Örnek İstek:

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

E-postayı 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:

Alan adlarını listele

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ı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

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:

Alan takma adlarını listeleyin

GET /v1/domains/example.com/aliases

Örnek İstek:

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -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: