aerc/doc/aerc-smtp.5.scd
Julian Pidancet 9217dbeea4 imap,smtp: add XOAUTH2 support
Add XOAUTH2 authentication support for IMAP and SMTP. Although XOAUTH2
is now deprecated in favor of OAuthBearer, it is the only way to connect
to Office365 since Basic Auth is now completely removed.

Since XOAUTH2 is very similar to OAuthBearer and uses the same
configuration parameters, this is basically a copy-paste of the existing
OAuthBearer code.

However, XOAUTH2 support was removed from go-sasl library, so this
change reimports the code that was removed from go-sasl and offers it
a new home in lib/xoauth2.go. Hopefully it shouldn't be too hard to
maintain, being less than 50 SLOC.

Link: https://github.com/emersion/go-sasl/commit/7bfe0ed36a21
Implements: https://todo.sr.ht/~rjarry/aerc/78
Signed-off-by: Julian Pidancet <julian.pidancet@oracle.com>
Tested-by: Inwit <inwit@sindominio.net>
Acked-by: Tim Culverhouse <tim@timculverhouse.com>
2022-10-01 15:47:33 +02:00

77 lines
2 KiB
Markdown

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|+xoauth2]://username[:password]@hostname[:port]?[:oauth2_params]
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
Additionally, you can specify an authentication mechanism like so:
*+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.
*+xoauth2*:
SMTP with TLS/SSL using XOAUTH2 Authentication. See documentation in
*aerc-imap*(5) for usage.
*outgoing-cred-cmd*
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.
Example:
pass hostname/username
*smtp-starttls*
Set this to `yes` if the server uses STARTTLS. In that case you should also
use *smtp* instead of *smtps*.
# SEE ALSO
*aerc*(1) *aerc-config*(5)
# 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/.