Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 131 additions & 37 deletions data/settings.js
Original file line number Diff line number Diff line change
Expand Up @@ -10189,15 +10189,6 @@
See [[setting,rejection_reason]] for the list of variables that can be used.`
},

sendmail_path: {
default: '/usr/sbin/sendmail',
values: setting_types.STRING,
text: `
The binary to use for sending email.

Used only if [[setting,submission_host]] is not set.`
},

service: {
tags: [ 'service' ],
values: setting_types.NAMED_LIST_FILTER,
Expand Down Expand Up @@ -10925,15 +10916,145 @@
between 'RCPT TO:' and path.`
},

sendmail_path: {
tags: [ 'outgoing_mail' ],
default: '/usr/sbin/sendmail',
values: setting_types.STRING,
text: `
The binary to use for sending email.

Used only if [[setting,submission_host]] is not set.`
},

submission_host: {
tags: [ 'submission' ],
tags: [ 'outgoing_mail' ],
seealso: [ 'submission_ssl', 'submission_sasl_mechanisms'],
values: setting_types.URL,
text: `
Use this SMTP submission host to send messages.

Overrides [[setting,sendmail_path]] value, if set.`
},

submission_ssl: {
tags: [ 'outgoing_mail' ],
default: 'no',
seealso: [ 'submission_host' ],
values: setting_types.STRING,
values_enum: [ 'no', 'smtps', 'starttls' ],
text: `
If enabled, use SSL/TLS to connect to [[setting,submission_host]].

Available values:

\`no\`
: No SSL connection is used.

\`smtps\`
: An SMTPS connection (immediate SSL) is used.

\`starttls\`
: The STARTTLS command is used to establish the TLS layer.

Used only if [[setting,submission_host]] is set.`
},

submission_timeout: {
tags: [ 'outgoing_mail' ],
default: '30secs',
seealso: [ 'submission_host' ],
values: setting_types.TIME,
text: `Timeout for submitting outgoing messages.`
},

submission_master_user: {
tags: [ 'outgoing_mail' ],
seealso: [ 'submission_host', 'submission_password', 'submission_user', 'submission_sasl_mechanisms' ],
values: setting_types.STRING,
text: `
The master username to authenticate as on the remote SMTP host used to send
messages.

To authenticate as a master user but use a separate login user, the
following configuration should be employed, where the credentials are
represented by masteruser and masteruser-secret:

\`\`\`
submission_user = %{user}
submission_master_user = masteruser
submission_password = masteruser-secret
\`\`\`

[[variable,mail-user]] can be used.

Used only if [[setting,submission_host]] is set.
Authentication is skipped if this setting is left unconfigured.`

Check failure on line 10991 in data/settings.js

View workflow job for this annotation

GitHub Actions / Spell checking

`unconfigured` is not a recognized word. (unrecognized-spelling)
},

submission_password: {
tags: [ 'outgoing_mail' ],
seealso: [ 'submission_host', 'submission_master_user', 'submission_user', 'submission_sasl_mechanisms' ],
values: setting_types.STRING,
text: `
The authentication password forthe remote SMTP host used to send messages

Check failure on line 10999 in data/settings.js

View workflow job for this annotation

GitHub Actions / Spell checking

`forthe` is not a recognized word. (unrecognized-spelling)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix spelling issues


If using master users, this setting will be the password of the master user.

Used only if [[setting,submission_host]] is set.`
},

submission_sasl_mechanisms: {
default: 'plain',
tags: [ 'outgoing_mail' ],
seealso: [ 'submission_host', 'submission_password', 'submission_user', 'submission_master_user' ],
values: setting_types.BOOLLIST,
text: `
The [[link,sasl]] mechanisms to use for authentication when connection to the
remote SMTP host used to send messages

The first one advertised by the remote SMTP server is used.

\`\`\`[dovecot.conf]
submission_sasl_mechanisms {
external = yes
plain = yes
login = yes
}
\`\`\`

Supported mechanisms are:

* ANONYMOUS
* EXTERNAL
* LOGIN
* OAUTHBEARER
* PLAIN
* SCRAM-SHA-1
* SCRAM-SHA-1-PLUS
* SCRAM-SHA-256
* SCRAM-SHA-256-PLUS
* XOAUTH2

Note that [[setting,submission_password]] is ignored for \`ANONYMOUS\` and \`EXTERNAL\` mechanisms.
For \`OAUTHBEARER\` and \`XOAUTH2\` [[setting,submission_password]] should be bearer token.

Used only if [[setting,submission_host]] is set.`
},

submission_user: {
tags: [ 'outgoing_mail' ],
seealso: [ 'submission_host', 'submission_master_user', 'submission_password', 'submission_sasl_mechanisms' ],
values: setting_types.STRING,
default: '%{owner_user}',
text: `
The user identity to be used for performing a regular IMAP LOGIN to the
source IMAP server.

[[variable,mail-user]] can be used.

Used only if [[setting,submission_host]] is set.`
},

submission_logout_format: {
default: 'in=%{input} out=%{output}',
tags: [ 'submission' ],
Expand Down Expand Up @@ -11086,33 +11207,6 @@
User name for authentication to the relay MTA if authentication is required.`
},

submission_ssl: {
default: 'no',
seealso: [ 'submission_host' ],
values: setting_types.STRING,
values_enum: [ 'no', 'smtps', 'starttls' ],
text: `
If enabled, use SSL/TLS to connect to [[setting,submission_host]].

Available values:

\`no\`
: No SSL connection is used.

\`smtps\`
: An SMTPS connection (immediate SSL) is used.

\`starttls\`
: The STARTTLS command is used to establish the TLS layer.`
},

submission_timeout: {
default: '30secs',
seealso: [ 'submission_host' ],
values: setting_types.TIME,
text: `Timeout for submitting outgoing messages.`
},

syslog_facility: {
default: 'mail',
values: setting_types.STRING,
Expand Down
14 changes: 9 additions & 5 deletions docs/core/config/sieve/submission.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,16 @@ passdb sql {
}
```

## `submission_host`
## Outgoing Mail

`submission_host = smtp-out.example.com:25`

SMTP server which is used for sending email rejects, Sieve forwards,
vacations, etc.
The `submission_host` setting configures the SMTP server used for sending email
rejects, Sieve forwards, vacation notifications, etc.

Alternatively, `sendmail_path` setting can be used to send mails using the
sendmail binary.
Alternatively, the `sendmail_path` setting can be used to send mails using the
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[[setting,sendmail_path]]

local sendmail binary.

The following settings apply to outgoing mail submitted from Sieve:

<SettingsComponent tag="outgoing_mail" />
Loading