Welcome Plugin (welcome)

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	Named Filter
See Also	welcome

Named filter for configuring the welcome execute script.

welcome {
  execute welcome {
    args = %{user}
  }

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 {
  welcome = yes
}
welcome {
  execute welcome {
    args = %{user}
  }
  wait = yes
}

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