Mail API

Mail API, Alaf Server'ın self-hosted e-posta özelliğini yönetir: SSH üzerinden sunucularınızdan birine bir iRedMail yığını kurar, kurulum sihirbazının ilerlemesini takip eder, ardından çalışan sunucu için bir admin paneli sunar — alan adları, posta kutuları, istatistikler, yedeklemeler, DNS sağlığı ve bileşen bazında kontrol — artı tek tıklamayla bir webmail deploy'u. Dashboard'da bu, E-postalar sayfasıdır.

Endpoints

Kurulum sihirbazı

Kurulum sonrası

Admin — alan adları

Admin — posta kutuları

Admin — istatistikler, yedeklemeler, DNS, bileşenler

Webmail

Kurulumu Başlat (veya Devam Ettir)

Bir sunucuya karşı iRedMail kurulum sihirbazını başlatır ve ilerlemeyi Server-Sent Events olarak stream eder. Sihirbaz idempotenttir: önceki bir çalıştırmanın durduğu (veya engellendiği) yerden devam etmek için startStep ile yeniden POST edin. Her instance'ta aynı anda yalnızca bir kurulum çalışabilir.

POST /api/mail/setup

config isteğe bağlı bir IRedMailConfig'dir:

curl -N -X POST https://your-host/api/mail/setup \
  -H "Authorization: Bearer $ALAFSERVER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"serverId":"srv_123","domain":"example.com"}'

Stream, her adım için step_start, log ve step_done olaylarını, ayrıca bu kontrol olaylarını yayar:

• dns_records / dns_pending — DKIM adımı eklemeniz gereken kayıtları yayınlar, ardından bekler. Kayıtları DNS sağlayıcınıza ekleyin ve POST /api/mail/setup/dns-ack çağrısını yapın, ardından olaydan gelen resumeStep ile /setup adresine yeniden POST edin.
• ptr_pending — DNS onaylandıktan sonra, sihirbaz reverse-DNS (PTR) için tekrar bekler. PTR kaydını VPS sağlayıcınızda ayarlayın, POST /api/mail/setup/ptr-ack çağrısını yapın ve devam edin.
• complete — domain, webmailUrl ve adminUrl taşır.
• error — message ve (devam ettirilebilir olduğunda) resumeStep taşır.

DNS / PTR Onayla

Her ikisi de sunucu üzerindeki durum dosyasında tek bir bayrağı değiştirir, böylece sihirbaz bir sonraki /setup POST'unda kapısını geçebilir. Her ikisi de aynı body'yi alır.

POST /api/mail/setup/dns-ack
POST /api/mail/setup/ptr-ack

Aynı { serverId } body'si POST /api/mail/scan, POST /api/mail/adopt, POST /api/mail/setup/cancel ve POST /api/mail/setup/reset için geçerlidir.

Mevcut bir kurulumu benimse

Alaf Server bir posta sunucusunun kaydını kaybettiyse (yeniden oluşturulmuş masaüstü, silinmiş DB), sunucuyu tarayın, ardından benimseyin — yeniden kurulum yok, kutuda hiçbir şey değişmez.

POST /api/mail/scan
POST /api/mail/adopt

# 1. iRedMail + sunucu üzerindeki durumunu araştır
curl -X POST https://your-host/api/mail/scan \
  -H "Authorization: Bearer $ALAFSERVER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"serverId":"srv_123"}'

# 2. Yeniden benimse (idempotent)
curl -X POST https://your-host/api/mail/adopt \
  -H "Authorization: Bearer $ALAFSERVER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"serverId":"srv_123"}'

Postmaster parolasını değiştir

POST /api/mail/credentials/postmaster

Bir posta alan adı ekle

POST /api/mail/admin/:serverId/domains

PATCH /api/mail/admin/:serverId/domains/:domain aynı alanları (hepsi isteğe bağlı) artı active (boolean) kabul eder.

curl -X POST https://your-host/api/mail/admin/srv_123/domains \
  -H "Authorization: Bearer $ALAFSERVER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain":"example.com","defaultQuotaMB":2048}'

Bir posta kutusu oluştur

POST /api/mail/admin/:serverId/mailboxes

PATCH /api/mail/admin/:serverId/mailboxes/:email name, password, quotaMB ve active (hepsi isteğe bağlı) kabul eder. DELETE varsayılan olarak soft delete yapar; maildir'i temizlemek için ?hard=true ekleyin.

curl -X POST https://your-host/api/mail/admin/srv_123/mailboxes \
  -H "Authorization: Bearer $ALAFSERVER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"localPart":"alice","domain":"example.com","password":"a-strong-password"}'

Yedeklemeleri Yapılandır

Posta sunucusunu genel yedekleme sistemine bağlar — bir hedef ve neyin yakalanacağını seçin. Kuruluşunuzda mevcut bir yedekleme hedefi gerektirir.

POST /api/mail/admin/:serverId/backup-policy

Bir test e-postası gönder

POST /api/mail/admin/:serverId/test-email

Webmail deploy et

Bir webmail-<serverId> projesi oluşturur (veya yeniden kullanır), bir deployment'ı sıraya alır ve build'i başlatır. Dashboard'ın /build/[deploymentId] adresine yönlendirebilmesi için { deploymentId, projectId } döndürür.

POST /api/mail/webmail/deploy-project

target şunlardan biridir:

• { "kind": "self", "serverId": "srv_123" } — Alaf Server sunucularınızdan birinde self-hosted.
• { "kind": "cloud" } — Alaf Server Cloud tarafından yönetilir.

curl -X POST https://your-host/api/mail/webmail/deploy-project \
  -H "Authorization: Bearer $ALAFSERVER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mailServerId":"srv_123","hostname":"mail.example.com","target":{"kind":"self","serverId":"srv_123"}}'

Görebileceğiniz Hatalar