summaryrefslogtreecommitdiffstats
path: root/doc/wiki/Plugins.Welcome.txt
blob: e5da2f66949f81d448fb1930741e442d1bb68bc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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)