summaryrefslogtreecommitdiffstats
path: root/doc/wiki/Plugins.Welcome.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 09:51:24 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 09:51:24 +0000
commitf7548d6d28c313cf80e6f3ef89aed16a19815df1 (patch)
treea3f6f2a3f247293bee59ecd28e8cd8ceb6ca064a /doc/wiki/Plugins.Welcome.txt
parentInitial commit. (diff)
downloaddovecot-upstream.tar.xz
dovecot-upstream.zip
Adding upstream version 1:2.3.19.1+dfsg1.upstream/1%2.3.19.1+dfsg1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/wiki/Plugins.Welcome.txt')
-rw-r--r--doc/wiki/Plugins.Welcome.txt27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/wiki/Plugins.Welcome.txt b/doc/wiki/Plugins.Welcome.txt
new file mode 100644
index 0000000..e5da2f6
--- /dev/null
+++ b/doc/wiki/Plugins.Welcome.txt
@@ -0,0 +1,27 @@
+Welcome plugin
+==============
+
+Requires v2.2.25+. Call a script when the user logs in for the first time. This
+is specifically done when the INBOX is (auto)created. The scripts are called
+similarly to <quota warning scripts> [Quota.Configuration.txt].
+
+---%<-------------------------------------------------------------------------
+plugin {
+ welcome_script = welcome %u
+ # By default we run the script asynchronously, but with this option we
+ # wait for the script to finish.
+ #welcome_wait = yes
+}
+
+service welcome {
+ executable = script /usr/local/bin/welcome.sh
+ user = dovecot
+ unix_listener welcome {
+ user = vmail
+ }
+}
+
+mail_plugins = $mail_plugins welcome
+---%<-------------------------------------------------------------------------
+
+(This file was created from the wiki on 2019-06-19 12:42)