aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aerc-smtp.5.scd
diff options
context:
space:
mode:
Diffstat (limited to 'doc/aerc-smtp.5.scd')
-rw-r--r--doc/aerc-smtp.5.scd50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/aerc-smtp.5.scd b/doc/aerc-smtp.5.scd
new file mode 100644
index 00000000..7d071258
--- /dev/null
+++ b/doc/aerc-smtp.5.scd
@@ -0,0 +1,50 @@
+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|+none]://username[:password]@hostname[:port]
+
+ 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 mechansim 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.
+
+# SEE ALSO
+
+*aerc*(1) *aerc-config*(5) *aerc-smtp*(5)
+
+# AUTHORS
+
+Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
+source contributors. For more information about aerc development, see
+https://git.sr.ht/~sircmpwn/aerc.