Skip to content

Commit

Permalink
Update welcome plugin settings
Browse files Browse the repository at this point in the history
  • Loading branch information
sirainen committed Sep 12, 2024
1 parent e5a8c16 commit 9ea8d36
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 12 deletions.
26 changes: 18 additions & 8 deletions data/settings.js
Original file line number Diff line number Diff line change
Expand Up @@ -3233,19 +3233,29 @@ proceeds from there.`

welcome_script: {
plugin: 'welcome',
values: setting_types.STRING,
values: setting_types.NAMED_FILTER,
seealso: [ '[[link,welcome]]' ],
text: `
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.
Named filter for configuring the welcome [[setting,execute]] script.
\`\`\`
plugin {
welcome_script = welcome %u
}
\`\`\`[dovecot.conf]
welcome {
execute welcome {
args = %{user}
}
\`\`\``
},

welcome_wait: {
plugin: 'welcome',
values: setting_types.BOOLEAN,
default: 'no',
seealso: [ '[[link,welcome]]' ],
text: `
Should the welcome plugin wait for the script execution to finish before
continuing.`
},

welcome_wait: {
plugin: 'welcome',
values: setting_types.BOOLEAN,
Expand Down
11 changes: 7 additions & 4 deletions docs/core/plugins/welcome.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: doc
title: welcome
dovecotlinks:
welcome: welcome
---

# Welcome Plugin (`welcome`)
Expand All @@ -19,10 +21,11 @@ done when the INBOX is (auto)created. The scripts are called similarly to
mail_plugins {
welcome = yes
}
plugin {
welcome_script = welcome %u
welcome_wait = no
welcome {
execute welcome {
args = %{user}
}
wait = yes
}
service welcome {
Expand Down

0 comments on commit 9ea8d36

Please sign in to comment.