Skip to content

Document new settings for authentication of outgoing mail #1491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stephanbosch wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document new settings for authentication of outgoing mail #1491

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75b9dc1
Clean up documentation for outgoing mail
stephanbosch Apr 1, 2026
09fdf17
Document new settings for authentication of outgoing mail
stephanbosch Apr 1, 2026
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
80 changes: 43 additions & 37 deletions data/settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10189,15 +10189,6 @@ The Subject: header to use for bounce messages.
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,57 @@ Supported workaround identifiers are:
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'],
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_logout_format: {
default: 'in=%{input} out=%{output}',
tags: [ 'submission' ],
Expand Down Expand Up @@ -11086,33 +11119,6 @@ relay server (only if enabled).`
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
View file
Open in desktop
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

@sirainen sirainen Apr 2, 2026

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" />