"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/msmtp.texi" between
msmtp-1.8.19.tar.xz and msmtp-1.8.20.tar.xz

About: msmtp is an SMTP client with a sendmail compatible interface. It can be used with Mutt and other mail user agents.

msmtp.texi  (msmtp-1.8.19.tar.xz):msmtp.texi  (msmtp-1.8.20.tar.xz)
skipping to change at line 374 skipping to change at line 374
Set the envelope-from address. The following substitution patterns are supported : Set the envelope-from address. The following substitution patterns are supported :
@itemize @itemize
@item @code{%U} will be replaced by @code{$USER}, or if that fails by @code{$LOG NAME}, or if that fails by @item @code{%U} will be replaced by @code{$USER}, or if that fails by @code{$LOG NAME}, or if that fails by
the login name of the user running msmtp. the login name of the user running msmtp.
@item @code{%H} will be replaced by @code{$HOSTNAME}, or if that fails by the ho st name of the system. @item @code{%H} will be replaced by @code{$HOSTNAME}, or if that fails by the ho st name of the system.
@item @code{%C} will be replaced by the canonical name of @code{%H}. @item @code{%C} will be replaced by the canonical name of @code{%H}.
@item @code{%M} will be replaced by the contents of @code{/etc/mailname} (potent ially a different @item @code{%M} will be replaced by the contents of @code{/etc/mailname} (potent ially a different
directory is used depending on the build configuration; see the output of directory is used depending on the build configuration; see the output of
@samp{msmtp --version} and look for the location of the system configuration fil e). @samp{msmtp --version} and look for the location of the system configuration fil e).
@end itemize @end itemize
Note that the obsolete @samp{auto_from} command replaces this envelope-from addr Note that the obsolete @samp{auto_from} command replaces this envelope-from addr
ess. ess.@*
To enforce the use of this envelope-from address and ignore the @samp{-f} / @sam
p{--from} option,
see @ref{allow_from_override}.@*
@xref{Envelope-from address}.@* @xref{Envelope-from address}.@*
Furthermore, the envelope-from address may be a wildcard pattern as used for fil e name matching Furthermore, the envelope-from address may be a wildcard pattern as used for fil e name matching
in the shell. This is the case if it contains one of the characters @code{?}, @c ode{*} or @code{[}. in the shell. This is the case if it contains one of the characters @code{?}, @c ode{*} or @code{[}.
This allows a variety of envelope-from addresses given with the @samp{--from} op tion to match a single account. This allows a variety of envelope-from addresses given with the @samp{--from} op tion to match a single account.
@anchor{allow_from_override}
@item allow_from_override (on|off)
By default, the @ref{--from} option overrides the @ref{from} command.
Set to @samp{off} to disable this.
@anchor{dsn_notify} @anchor{dsn_notify}
@item dsn_notify (off|@var{condition}) @item dsn_notify (off|@var{condition})
@cmindex dsn_notify @cmindex dsn_notify
Set the condition(s) under which the mail system should send DSN (Delivery Set the condition(s) under which the mail system should send DSN (Delivery
Status Notification) messages. The argument @samp{off} disables explicit DSN Status Notification) messages. The argument @samp{off} disables explicit DSN
requests, which means the mail system decides when to send DSN messages. This requests, which means the mail system decides when to send DSN messages. This
is the default. is the default.
The @var{condition} must be @samp{never}, to never request notification, or a The @var{condition} must be @samp{never}, to never request notification, or a
comma separated list (no spaces!) of one or more of the following: comma separated list (no spaces!) of one or more of the following:
@samp{failure}, to request notification on transmission failure, @samp{delay}, @samp{failure}, to request notification on transmission failure, @samp{delay},
skipping to change at line 412 skipping to change at line 418
@xref{Delivery Status Notifications}. @xref{Delivery Status Notifications}.
@anchor{set_from_header} @anchor{set_from_header}
@item set_from_header [(auto|on|off)] @item set_from_header [(auto|on|off)]
@cmindex set_from_header @cmindex set_from_header
When to set a From header: @samp{auto} adds a From header if the mail does not When to set a From header: @samp{auto} adds a From header if the mail does not
have one (this is the default), @samp{on\} always sets a From header and overrid es have one (this is the default), @samp{on\} always sets a From header and overrid es
any existing one, and @samp{off} never sets a From header.@* any existing one, and @samp{off} never sets a From header.@*
If the mail server rejects the mail because its From header does not match the If the mail server rejects the mail because its From header does not match the
envelope from address (a common anti-spam measure), then you might want to set envelope from address (a common anti-spam measure), then you might want to set
this option to @samp{on}.@* this option to @samp{on}.@*
The From header is created based on the envelope-from address. Disable
@ref{allow_from_override} to prevent programs from setting their own
envelope-from address.@*
For compatibility with older versions, @samp{add_missing_from_header [(on|off)]} For compatibility with older versions, @samp{add_missing_from_header [(on|off)]}
is still supported and corresponds to the @samp{auto} and @samp{off} settings.@* is still supported and corresponds to the @samp{auto} and @samp{off} settings.@*
@xref{Header handling}. @xref{Header handling}.
@anchor{set_date_header} @anchor{set_date_header}
@item set_date_header [(auto|off)] @item set_date_header [(auto|off)]
@cmindex set_date_header @cmindex set_date_header
When to set a Date header: @samp{auto} adds a Date header if the mail does not When to set a Date header: @samp{auto} adds a Date header if the mail does not
have one (this is the default), and @samp{off} never sets a Date header.@* have one (this is the default), and @samp{off} never sets a Date header.@*
For compatibility with older versions, @samp{add_missing_date_header [(on|off)]} For compatibility with older versions, @samp{add_missing_date_header [(on|off)]}
is still supported and corresponds to the @samp{auto} and @samp{off} settings.@* is still supported and corresponds to the @samp{auto} and @samp{off} settings.@*
skipping to change at line 679 skipping to change at line 688
@xref{tls_min_dh_prime_bits}. @xref{tls_min_dh_prime_bits}.
@end table @end table
@subsection Options specific to sendmail mode @subsection Options specific to sendmail mode
@table @samp @table @samp
@anchor{--from} @anchor{--from}
@item -f @var{address} @item -f @var{address}
@itemx --from=@var{address} @itemx --from=@var{address}
@opindex -f @opindex -f
@opindex --from @opindex --from
Set the envelope-from address. @xref{from}.@* Set the envelope-from address. See @ref{from} and @ref{allow_from_override}.@*
If no account was chosen yet (with @option{--account} or @option{--host}), this If no account was chosen yet (with @option{--account} or @option{--host}), this
option will choose the first account that has the given envelope-from address option will choose the first account that has the given envelope-from address
(set with the @samp{from} command). If no such account is found, "default" is (set with the @samp{from} command). If no such account is found, "default" is
used. @xref{Choosing an account}.@* used. @xref{Choosing an account}.@*
See the @samp{from} command for substitution patterns supported in @var{address} .
@anchor{--dsn-notify} @anchor{--dsn-notify}
@item -N (off|@var{condition}) @item -N (off|@var{condition})
@itemx --dsn-notify=(off|@var{condition}) @itemx --dsn-notify=(off|@var{condition})
@opindex -N @opindex -N
@opindex --dsn-notify @opindex --dsn-notify
Set or unset DSN notification conditions. @xref{dsn_notify}. Set or unset DSN notification conditions. @xref{dsn_notify}.
@anchor{--dsn-return} @anchor{--dsn-return}
@item -R (off|@var{amount}) @item -R (off|@var{amount})
@itemx --dsn-return=(off|@var{amount}) @itemx --dsn-return=(off|@var{amount})
@opindex -R @opindex -R
skipping to change at line 1052 skipping to change at line 1060
@node Envelope-from address @node Envelope-from address
@section Envelope-from address @section Envelope-from address
The SMTP server expects a sender mail address for each mail. This is the The SMTP server expects a sender mail address for each mail. This is the
envelope-from address. It is independent of the From header (because it is envelope-from address. It is independent of the From header (because it is
part of the mail @emph{envelope}, not of the mail itself), but in most cases part of the mail @emph{envelope}, not of the mail itself), but in most cases
both addresses are the same. both addresses are the same.
Envelope-from addresses are set with the @ref{from} command or @ref{--from} opti on. Envelope-from addresses are set with the @ref{from} command or @ref{--from} opti on.
The latter can be disabled with the @ref{allow_from_override} command.
@node Logging @node Logging
@section Logging @section Logging
When logging is enabled, msmtp will generate one log line for each mail it When logging is enabled, msmtp will generate one log line for each mail it
tries to send. tries to send.
The line will include the following information: The line will include the following information:
@itemize @itemize
@item Host name of the SMTP server: @code{host=hostname} @item Host name of the SMTP server: @code{host=hostname}
skipping to change at line 1446 skipping to change at line 1455
Print help. Print help.
@item --inetd @item --inetd
Start single SMTP session on stdin/stdout Start single SMTP session on stdin/stdout
@item --interface=@var{ip} @item --interface=@var{ip}
Listen on the given IPv6 or IPv4 address instead of 127.0.0.1 Listen on the given IPv6 or IPv4 address instead of 127.0.0.1
@item --port=@var{number} @item --port=@var{number}
Listen on the given port number instead of 25 Listen on the given port number instead of 25
@item --log=@var{none}|@var{syslog}|@var{filename} @item --log=@var{none}|@var{syslog}|@var{filename}
Set logging: none (default), syslog, or logging to the given file. Set logging: none (default), syslog, or logging to the given file.
@item --command=@var{cmd} @item --command=@var{cmd}
Pipe mails to @var{cmd} instead of msmtp Pipe mails to @var{cmd} instead of msmtp.
Make sure to end this command with @samp{--} to separate options from arguments. Make sure to end this command with @samp{--} to separate options from arguments.
@item --auth=@var{user}[,@var{passwordeval}] @item --auth=@var{user}[,@var{passwordeval}]
Require authentication with this user name. The password will be Require authentication with this user name. The password will be
retrieved from the given @var{passwordeval} command (this works retrieved from the given @var{passwordeval} command (this works
just like @ref{passwordeval} in msmtp) or, if none is given, just like @ref{passwordeval} in msmtp) or, if none is given,
from the key ring or, if that fails, from a prompt. from the key ring or, if that fails, from a prompt.
@end table @end table
@node Example using msmtpd as a system service @node Example using msmtpd as a system service
@section Example: using msmtpd as a system service @section Example: using msmtpd as a system service
Only use a local interface to listen on. Run msmtpd with correct user rights Only use a local interface to listen on. Run msmtpd with correct user rights
and permissions (e.g. use @samp{CAP_NET_BIND_SERVICE} to bind to port 25 and permissions (e.g. use @samp{CAP_NET_BIND_SERVICE} to bind to port 25
instead of running as root, or use systemd with inetd service capabilities). Be instead of running as root, or use systemd with inetd service capabilities). Be
aware that the pipe command will be run as the same user that msmtpd runs as. aware that the pipe command will be run as the same user that msmtpd runs as.
Enable logging to syslog with @samp{--log=syslog}. Enable logging to syslog with @samp{--log=syslog}.
Example for managing msmtpd with @samp{start-stop-daemon}: Example for managing msmtpd with @samp{start-stop-daemon}:
@example @example
# start msmtpd # start msmtpd
start-stop-daemon --start --pidfile /var/run/msmtpd.pid --make-pidfile --chuid m smtpd --background --exec /usr/local/bin/msmtpd -- --command '/usr/local/bin/msm tp -f %F' start-stop-daemon --start --pidfile /var/run/msmtpd.pid --make-pidfile --chuid m smtpd --background --exec /usr/local/bin/msmtpd -- --command '/usr/local/bin/msm tp -f %F --'
# stop msmtpd # stop msmtpd
start-stop-daemon --stop --pidfile /var/run/msmtpd.pid --remove-pidfile --quiet --signal TERM start-stop-daemon --stop --pidfile /var/run/msmtpd.pid --remove-pidfile --quiet --signal TERM
@end example @end example
@node Example using msmtpd to handle outgoing mail for an SMTP-based mail client @node Example using msmtpd to handle outgoing mail for an SMTP-based mail client
@section Example: using msmtpd to handle outgoing mail for an SMTP-based mail cl ient @section Example: using msmtpd to handle outgoing mail for an SMTP-based mail cl ient
Some mail clients cannot send outgoing mail with a program like msmtp and Some mail clients cannot send outgoing mail with a program like msmtp and
instead insist on using an SMTP server. You can configure msmtpd to be that instead insist on using an SMTP server. You can configure msmtpd to be that
SMTP server and hand your outgoing mail over to msmtp. SMTP server and hand your outgoing mail over to msmtp.
skipping to change at line 1506 skipping to change at line 1515
In this case, use the msmtpd option @samp{--auth=msmtpd-user}. In this case, use the msmtpd option @samp{--auth=msmtpd-user}.
@item Store the password in an encrypted file and use the passwordeval @item Store the password in an encrypted file and use the passwordeval
mechanism. Example for gpg: mechanism. Example for gpg:
@example @example
msmtpd ... --auth=msmtpd-user,'gpg -q -d ~/.msmtpd-password.gpg' msmtpd ... --auth=msmtpd-user,'gpg -q -d ~/.msmtpd-password.gpg'
@end example @end example
@end enumerate @end enumerate
The complete command then is (using the keyring): The complete command then is (using the keyring):
@example @example
msmtpd --port=2500 --auth=msmtpd-user --command='/path/to/your/msmtp -f %F' msmtpd --port=2500 --auth=msmtpd-user --command='/path/to/your/msmtp -f %F --'
@end example @end example
The mail client software must then be configured to use @samp{localhost} at The mail client software must then be configured to use @samp{localhost} at
port @samp{2500} for outgoing mail via SMTP, and to use authentication with port @samp{2500} for outgoing mail via SMTP, and to use authentication with
user @samp{msmtpd-user} and the password you chose. The mail client will user @samp{msmtpd-user} and the password you chose. The mail client will
probably complain that the SMTP server does not support TLS, but in this probably complain that the SMTP server does not support TLS, but in this
special case that is ok since all communication between your mail client and special case that is ok since all communication between your mail client and
msmtpd will stay on the local machine. msmtpd will stay on the local machine.
This setup also works with multiple mail accounts. Msmtp will pick the correct This setup also works with multiple mail accounts. Msmtp will pick the correct
 End of changes. 9 change blocks. 
7 lines changed or deleted 17 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)