aboutsummaryrefslogtreecommitdiff
path: root/doc/aerc-imap.5.scd
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2019-05-17 13:45:20 -0400
committerDrew DeVault <sir@cmpwn.com>2019-05-17 13:46:26 -0400
commitfc719e47c452564b56d2ed0b7828fc74e72fcef8 (patch)
treef392219dbc10ce7690142927d4215ab88e71275d /doc/aerc-imap.5.scd
parentfcdcd32de7118e1de1f8d94c380a0e80a64265ec (diff)
Add man pages
Diffstat (limited to 'doc/aerc-imap.5.scd')
-rw-r--r--doc/aerc-imap.5.scd46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd
new file mode 100644
index 0000000..5899a34
--- /dev/null
+++ b/doc/aerc-imap.5.scd
@@ -0,0 +1,46 @@
+aerc-imap(5)
+
+# NAME
+
+aerc-imap - IMAP configuration for *aerc*(1)
+
+# SYNOPSIS
+
+aerc implements the IMAP protocol as specified by RFC 3501, with the following
+IMAP extensions:
+
+- IDLE (RFC 2177)
+
+# CONFIGURATION
+
+IMAP configuration may be done interactively with the :new-account command.
+
+In accounts.conf (see *aerc-config*(5)), the following IMAP-specific options are
+available:
+
+*source*
+ imap[s][+insecure]://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:
+
+ *imap://*:
+ IMAP with STARTTLS
+
+ *imap+insecure://*:
+ IMAP without STARTTLS
+
+ *imaps*:
+ IMAP with TLS/SSL
+
+# 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.