Skip to content

Commit fda5b9f

Browse files
authored
Add warning to set SENDMAIL_ARGS to -- (#19102)
Even with #17688 email addresses that contain an initial `-` may still be present in the db and it may in future still be possible to imagine a situation whereby initial `-` are repermitted. This PR simply updates the documentation to warn users to set their SENDMAIL_ARGS with a terminal `--` to prevent this possibility email addresses being interpreted as options. Signed-off-by: Andrew Thornton <[email protected]>
1 parent 7fc5fd6 commit fda5b9f

File tree

3 files changed

+3
-1
lines changed

3 files changed

+3
-1
lines changed

custom/conf/app.example.ini

+1
Original file line numberDiff line numberDiff line change
@@ -1533,6 +1533,7 @@ PATH =
15331533
;SENDMAIL_PATH = sendmail
15341534
;;
15351535
;; Specify any extra sendmail arguments
1536+
;; WARNING: if your sendmail program interprets options you should set this to "--" or terminate these args with "--"
15361537
;SENDMAIL_ARGS =
15371538
;;
15381539
;; Timeout for Sendmail

docs/content/doc/advanced/config-cheat-sheet.en-us.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -666,7 +666,7 @@ Define allowed algorithms and their minimum key length (use -1 to disable a type
666666
- Enabling dummy will ignore all settings except `ENABLED`, `SUBJECT_PREFIX` and `FROM`.
667667
- `SENDMAIL_PATH`: **sendmail**: The location of sendmail on the operating system (can be
668668
command or full path).
669-
- `SENDMAIL_ARGS`: **_empty_**: Specify any extra sendmail arguments.
669+
- `SENDMAIL_ARGS`: **_empty_**: Specify any extra sendmail arguments. (NOTE: you should be aware that email addresses can look like options - if your `sendmail` command takes options you must set the option terminator `--`)
670670
- `SENDMAIL_TIMEOUT`: **5m**: default timeout for sending email through sendmail
671671
- `SENDMAIL_CONVERT_CRLF`: **true**: Most versions of sendmail prefer LF line endings rather than CRLF line endings. Set this to false if your version of sendmail requires CRLF line endings.
672672
- `SEND_BUFFER_LEN`: **100**: Buffer length of mailing queue. **DEPRECATED** use `LENGTH` in `[queue.mailer]`

docs/content/doc/usage/email-setup.en-us.md

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ ENABLED = true
3535
3636
MAILER_TYPE = sendmail
3737
SENDMAIL_PATH = /usr/sbin/sendmail
38+
SENDMAIL_ARGS = "--" ; most "sendmail" programs take options, "--" will prevent an email address being interpreted as an option.
3839
```
3940

4041
## Using SMTP

0 commit comments

Comments
 (0)