Mail modülü (mail)

src/cluster_erp/modules/mail/ içindeki mail modülü, kullanıcının dış bir mail hesabını bağlamasına ve ürün içinde mail okuyup yazmasına izin verir. Bağlı hesapları, mesajların ve eklerin yerel önbelleğini, yöneticinin tanımladığı mail alan adlarını ve OAuth ile oturum açan sağlayıcılar için OAuth uygulamalarını tutar. Ayrıca diğer her modülün sistem e-postası göndermek için kullandığı SendTransactionalEmail sözleşmesini yanıtlar. Bu sayfa taşıma ve oturum açmayı yalnızca mekanizma düzeyinde anlatır.

Bir bakışta¶

Modül ne yapar¶

• Oturum açan kullanıcı için google, microsoft veya imap türünde bir mail hesabı bağlar. Google ve Microsoft hesapları OAuth yetkilendirme kodu akışıyla bağlanır; IMAP hesapları bir adres ve uygulama parolasıyla bağlanır ve hesap kaydedilmeden önce gerçek bir oturum açmayla doğrulanır (src/cluster_erp/modules/mail/oauth.py:1-15, src/cluster_erp/modules/mail/imap_verify.py:1-8).
• Bir hesabın gelen kutusunu yerel bir önbelleğe eşitler ve ekleri depoda tutar (src/cluster_erp/modules/mail/messages/sync.py:1-3, src/cluster_erp/modules/mail/messages/sync.py:126-203).
• Mail gönderir, taslakları eklerle saklar, mesajları okundu işaretler, çöp kutusuna taşır ve konuları gösterir (src/cluster_erp/modules/mail/messages/routes.py:43-252).
• Yöneticinin sunucu koordinatlarıyla mail alan adları tanımlamasına ve sağlayıcı başına OAuth uygulamaları kaydetmesine izin verir (src/cluster_erp/modules/mail/domains/models.py:9-30, src/cluster_erp/modules/mail/providers/models.py:9-35).
• Diğer modüller için platform SMTP ayarları üzerinden sistem e-postası gönderir (src/cluster_erp/modules/mail/module.py:72-103).

Alt modüller¶

Veri modeli¶

Sağlayıcı gizli değerleri, OAuth belirteçleri ve IMAP uygulama parolaları, bir sunucu ayarından anahtarlanan geri çözülebilir bir şifreyle saklanır ve yalnızca sağlayıcıyla konuşmak için çözülür (src/cluster_erp/modules/mail/crypto.py:1-49, src/cluster_erp/modules/mail/transport.py:1-12). Ayarlar ayarlar başvurusunda listelenir; gizli değer saklama ikinci faktör ve gizli değer saklama sayfasında anlatılır.

Hesap, sağlayıcı ve mesaj yolu¶

flowchart TD
 A["yönetici: sağlayıcı başına MailProviderConfig"] --> B["POST /accounts/oauth/provider/start"]
 D["yönetici: sunucu koordinatlı MailDomain"] --> I["POST /accounts/imap"]
 B --> C["sağlayıcı onayı, POST /accounts/oauth/callback"]
 C --> ACC["MailAccount: google veya microsoft"]
 I --> V["verify_imap_login"]
 V --> ACC2["MailAccount: imap"]
 ACC --> S["MailSyncService.sync_account"]
 ACC2 --> S
 S --> T["transport.fetch_inbox"]
 T --> M["MailMessage ve MailAttachment önbelleği"]
 M --> SEND["transport.send_message ile MailSyncService.send"]

Düz anlatımla:

1. Yönetici bir sağlayıcının OAuth uygulamasını /oauth-apps altında kaydeder ve /domains altında mail alan adları tanımlayabilir (src/cluster_erp/modules/mail/providers/routes.py:27-66, src/cluster_erp/modules/mail/domains/routes.py:21-86).
2. Google veya Microsoft için kullanıcı akışı başlatır, sağlayıcıda onay verir ve geri dönüş ucuna döner. İmzalı, kısa ömürlü bir durum değeri akışı kullanıcıya ve sağlayıcıya bağlar. Ürün belirteçleri alır, kullanıcının sağlayıcı parolasını hiçbir zaman görmez (src/cluster_erp/modules/mail/oauth.py:1-15, src/cluster_erp/modules/mail/accounts/routes.py:66-164).
3. IMAP için kullanıcı adresi ve bir uygulama parolasını gönderir; modül kaydetmeden önce gerçek bir oturum açma yapar (src/cluster_erp/modules/mail/accounts/routes.py:166-183, src/cluster_erp/modules/mail/accounts/services.py:83-160).
4. POST /messages/sync, gelen kutusunu sağlayıcı taşıması üzerinden alır ve önbelleğe ekler ya da günceller. Taşıma hatası hesap durumunu ayrıntıyla birlikte error yapar; başarı connected ve last_sync_at değerlerini yazar (src/cluster_erp/modules/mail/messages/sync.py:126-203).
5. Süresi dolan erişim belirteçleri saklanan yenileme belirteciyle yenilenir ve şifreli olarak geri yazılır (src/cluster_erp/modules/mail/messages/sync.py:83-124).
6. Gönderim bir mesaj kurar ve onu sağlayıcı taşımasına verir: IMAP hesapları SMTP ile, Google ve Microsoft kendi mail API'leriyle gönderir (src/cluster_erp/modules/mail/transport.py:1-12, src/cluster_erp/modules/mail/messages/sync.py:205-286).

Ekranlar ve metadata¶

get_metadata, tek bir ayar bölümü olan Mail Ayarları ile bir Mail kenar çubuğu grubu tanımlar; bölümün tek sekmesi mail_domain olur (src/cluster_erp/modules/mail/module.py:119-142). Üç varlık mail_domain, mail_account ve mail_message şeklindedir (src/cluster_erp/modules/mail/module.py:143-147). Mail uygulaması ekranı web uygulamasının özel bir ekranıdır; bkz. mail ve profil ekranları.

Durum ve aksiyonlar¶

Modül hiçbir ActionMeta tanımlamaz. Hesap status (varsayılan connected) ve status_detail taşır (src/cluster_erp/modules/mail/accounts/models.py:48-49). Mesaj bir folder içinde durur, varsayılan inbox; taslaklar drafts, çöp kutusu trash kullanır (src/cluster_erp/modules/mail/messages/models.py:22, src/cluster_erp/modules/mail/messages/sync.py:331-348, src/cluster_erp/modules/mail/messages/sync.py:470-488).

İş kuralları¶

• Her mesaj ve hesap okuması oturum açan kullanıcıyla sınırlıdır (src/cluster_erp/modules/mail/messages/sync.py:52-81, src/cluster_erp/modules/mail/accounts/services.py:169-184).
• Taslağı atmak, taslakta ve eklerinde deleted_at, deleted_by ve draft_discarded nedenini doldurur (src/cluster_erp/modules/mail/messages/sync.py:331-347).
• Çöpe atma, mesajı sağlayıcının çöp kutusuna ve yerel trash klasörüne taşır (src/cluster_erp/modules/mail/messages/sync.py:470-488).
• Hesabın bağlantısını kesmek, alan adı silmek veya OAuth uygulaması silmek deleted_at alanını doldurur (src/cluster_erp/modules/mail/accounts/services.py:185-191, src/cluster_erp/modules/mail/domains/services.py:55-61, src/cluster_erp/modules/mail/providers/services.py:79-87).
• Sistem posta kutusu SMTP yapılandırılmamışsa not_configured, alıcı yoksa no_recipient nedeniyle sent=False bildirir. sent=True, SMTP sunucusunun mesajı kabul ettiği anlamına gelir; teslim edildiği anlamına gelmez (src/cluster_erp/modules/mail/module.py:72-103).

Olaylar ve sorgular¶

Modül 3 sözleşme tüketir ve hiç üretmez; sayım fleet modülü sayfasındaki gibi yapılmıştır. Tam liste sözleşmeler başvurusunda yer alır.

İntranet bildirim dağıtımı SendTransactionalEmail sözleşmesini çağıranlardan biridir (src/cluster_erp/modules/intranet/notify.py:91-99). Sistem postasının platform tarafı PDF ve sistem postası sayfasındadır.

İzinler¶

Gizlilik, saklama ve geçmiş¶

privacy_handlers.py, bir kişinin adreslerini taşıyan mesajları sayar. Anonimleştirme bir operatör kararıdır (include_correspondence); dahil edildiğinde kişinin adı ve adresi gönderen ve alıcı alanlarında, konu, özet ve gövdeler içinde değiştirilir (src/cluster_erp/modules/mail/privacy_handlers.py:1-11). Bkz. gizlilik ve ilgili kişi talepleri. Modülde retention_handlers.py yoktur. Değişiklikleri değişiklik geçmişi yakalar.

Analitik olgular¶

Bu modülde analytics_facts.py yoktur.

Ayarlar ve referans verileri¶

Mail alan adları ve OAuth uygulamaları, yöneticilerin tuttuğu modül referans verileridir (src/cluster_erp/modules/mail/domains/routes.py:21-86, src/cluster_erp/modules/mail/providers/routes.py:27-66). Gizli değerler hiç gösterilmez: GET /oauth-apps/ gizli değeri değil, gizli değerin girilip girilmediğini (has_secret) döndürür (src/cluster_erp/modules/mail/providers/models.py:9-16, src/cluster_erp/modules/mail/providers/schemas.py:6-15).

Testler¶

Ada göre (web-client/_e2e_mail*.mjs) ve tests/ içinde modules.mail için grep ile bulundu.

Tanıtılan terimler¶

İlgili sayfalar¶

• Modüller dizini
• Mail ve profil ekranları
• PDF ve sistem postası
• İntranet bildirimleri ve tebligat
• Bu modülün API başvurusu

92f8051 numaralı commit ile 2026-11-13 tarihinde doğrulandı.