submission: Add submission flow diagram

Author: slusarz

.github/actions/spelling/expect.txt

@@ -8,7 +8,6 @@ ADDRESULT
 ADH
 Adleman
 Aildir
-allbackups
 alloconly
 altmove
 altpath
@@ -156,7 +155,6 @@ dnpassword
 DOI
 domainless
 domainname
-dontlognull
 Dorner
 dotlock
 dotlocking
@@ -193,6 +191,7 @@ Eing
 ekh
 emaillookup
 endscript
+enduml
 ENHANCEDSTATUSCODES
 enotify
 entra
@@ -209,8 +208,8 @@ euid
 examplescripts
 execv
 exim
-extlists
 exportkeytab
+extlists
 extprograms
 extracttext
 exttextcat
@@ -234,9 +233,7 @@ foofilename
 foop
 foos
 foreverypart
-forwardfor
 fpdb
-Frontends
 FROP
 fscache
 fsgid
@@ -283,8 +280,6 @@ hostip
 howto
 htdigest
 htpasswd
-httpchk
-httplog
 iana
 idfield
 IES
@@ -363,7 +358,6 @@ ldapmodify
 ldaps
 LDFLAGS
 ldif
-leastconn
 lenumber
 letsencrypt
 LFs
@@ -400,7 +394,6 @@ listfile
 listname
 listscripts
 LISTSERV
-lkas
 lmtp
 lmtponly
 lmtptest
@@ -453,7 +446,6 @@ masteradmin
 masterpass
 masteruser
 matadata
-maxconn
 maxproc
 maxretry
 mboxcl
@@ -671,7 +663,6 @@ rfcs
 Rivest
 Roskakori
 roundcube
-roundrobin
 rport
 rquota
 rsaprivkey
@@ -692,7 +683,6 @@ savedbefore
 SAVEDON
 savedsince
 SAVEONLY
-scality
 scontext
 scriptname
 sdbox
@@ -755,6 +745,7 @@ sqluser
 SSHA
 ssldir
 stackbuf
+startuml
 STATEDIR
 staticbuf
 staticdb
@@ -868,6 +859,7 @@ urandom
 Urg
 urlauth
 URLFETCH
+usecase
 usecs
 userdata
 userdb

docs/core/config/include/submission_flow.inc

@@ -0,0 +1,27 @@
+@startuml
+top to bottom direction
+
+actor MUA [
+  MUA (Mail Client)
+]
+
+package "DOVECOT" {
+  usecase "submission-login\n(Handles TLS & Auth)" as SubLogin
+  component "Dovecot Auth" as Auth
+  usecase "submission\n(Validates SMTP; proxies mail)" as Submission
+  database "Mail Storage" as Storage
+}
+
+node "Backend MTA\n(e.g., Postfix/Exim)" as MTA
+
+cloud "Remote Delivery" as Net
+
+' Define the connections based on the flow
+MUA -down-> SubLogin : " Connect (SMTP: Port 465/587)"
+SubLogin -down-> Auth
+Auth -down-> Submission
+Submission ..> Storage : "(Optional) Handles BURL"
+Submission -down-> MTA : "Relays message (SMTP)"
+MTA -down-> Net
+
+@enduml

docs/core/config/submission.md

@@ -16,6 +16,7 @@ It is currently implemented as a proxy that acts as a front-end for any
 [[link,mta]], adding the necessary functionality required for a submission
 service: it adds the required AUTH ([[rfc,4954]]) support, avoiding
 the need to configure the MTA for [[link,sasl]].
+:::
 
 ::: danger
 Dovecot's submission server is NOT a full-featured SMTP server. It REQUIRES
@@ -81,6 +82,10 @@ service:
 * **VRFY** ([[rfc,5321]])
 * **XCLIENT**: See https://www.postfix.org/XCLIENT_README.html
 
+## Flow Diagram
+
+<!-- @include: @docs/core/config/include/submission_flow.inc -->
+
 ## Configuration
 
 ### Submission Service

lib/markdown.js

@@ -1,6 +1,7 @@
 import containerPlugin from 'markdown-it-container'
 import fg from 'fast-glob'
 import deflistPlugin from 'markdown-it-deflist'
+import { plantuml } from "@mdit/plugin-plantuml";
 import path from 'path'
 import { createMarkdownRenderer } from 'vitepress'
 import { dovecotSetting, frontmatterIter, loadData } from './utility.js'
@@ -17,6 +18,7 @@ export function dovecotMdExtend(md) {
 	})
 	md.use(deflistPlugin)
 	md.use(dovecot_markdown)
+	md.use(plantuml)
 
 	return md
 }

package-lock.json

@@ -1,6 +1,7 @@
 {
   "name": "dovecot-ce-documentation",
   "devDependencies": {
+    "@mdit/plugin-plantuml": "^0.22.3",
     "@sindresorhus/slugify": "^2.2.1",
     "camelcase": "^8.0.0",
     "commander": "^13.1.0",