aerc/doc/aerc-smtp.5.scd

73 lines
1.9 KiB
Plaintext
Raw Permalink Normal View History

2019-05-17 17:45:20 +00:00
aerc-smtp(5)
# NAME
aerc-smtp - SMTP configuration for *aerc*(1)
# SYNOPSIS
aerc implements the SMTP protocol as specified by RFC 5321.
# CONFIGURATION
SMTP configuration may be done interactively with the :new-account command.
In accounts.conf (see *aerc-config*(5)), the following SMTP-specific options are
available:
*outgoing*
smtp[s][+plain|+login|+none|+oauthbearer]://username[:password]@hostname[:port]?[:oauth2_params]
2019-05-17 17:45:20 +00:00
Remember that all fields must be URL encoded. The "@" symbol, when URL
encoded, is *%40*.
The meaning of the scheme component is:
*smtp://*:
Unencrypted SMTP
*smtps://*:
SMTP with TLS/SSL
2020-05-20 00:48:23 +00:00
Additionally, you can specify an authentication mechanism like so:
2019-05-17 17:45:20 +00:00
*+none*:
No authentication is required to use this SMTP server. You may omit the
username and password in this case.
*+plain*:
Authenticate with a username and password using AUTH PLAIN. This is the
default behavior.
*+login*:
Authenticate with a username and password using AUTH LOGIN. This is an obsolete
protocol, but is required for some common webmail providers.
*+oauthbearer*:
SMTP with TLS/SSL using OAUTHBEARER Authentication. See documentation in
*aerc-imap*(5) for usage.
2019-05-23 11:29:20 +00:00
*outgoing-cred-cmd*
2019-05-18 19:34:16 +00:00
Specifies the command to run to get the password for the SMTP
account. This command will be run using `sh -c [command]`. If a
password is specified in the *outgoing* option, the password will
take precedence over this command.
2019-05-18 19:34:16 +00:00
Example:
2019-05-18 19:34:16 +00:00
pass hostname/username
2020-03-02 09:10:35 +00:00
*smtp-starttls*
Set this to `yes` if the server uses STARTTLS. In that case you should also
use *smtp* instead of *smtps*.
2019-05-17 17:45:20 +00:00
# SEE ALSO
2019-07-27 15:19:49 +00:00
*aerc*(1) *aerc-config*(5)
2019-05-17 17:45:20 +00:00
# AUTHORS
Originally created by Drew DeVault <sir@cmpwn.com> and maintained by Robin
Jarry <robin@jarry.cc> who is assisted by other open source contributors. For
more information about aerc development, see https://sr.ht/~rjarry/aerc/.