Welcome (welcome) Plugin

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.

Settings

welcome_script

Default	[None]
Value	string

The script to run when the user logs in for the first time (that is, when this user's INBOX is created). This must be set or else the plugin will not be active.

plugin {
  welcome_script = welcome %u
}

welcome_wait

Default	no
Value	boolean

If enabled, wait for the script to finish. By default, the welcome script is run asynchronously.

Example Configuration

mail_plugins = $mail_plugins welcome

plugin {
  welcome_script = welcome %u
  welcome_wait = no
}

service welcome {
  executable = script /usr/local/bin/welcome.sh
  user = dovecot
  unix_listener welcome {
    user = vmail
  }
}