Verbose variant of 'target' in config

1 files changed, 18 insertions, 8 deletions

diff --git a/config.yml.example b/config.yml.example
index 14f413e..0e0e304 100644
--- a/config.yml.example
+++ b/config.yml.example
@@ -1,14 +1,24 @@
 # Example configuration. Each configuration option presented shows its default, so sensible.
 
 ## Target
-# The IMAP URI where to put emails, including credentials. Should start with imap:// for IMAP and imaps:// for IMAPS.
-# URI must be properly escaped, thus '@' as part of the user must be written as %40.
-# NB: This also applies for the password!
-# Format: scheme://user:password@host/PATH
-# Host can include a port; PATH denotes the root of the hierarchy for all feeds. Probably should start with INBOX.
-# Allowed delimiters in PATH are '/' -- they will be replaced by the correct delimiter. If you know yours, you can
-# also use that.
-target: imap://test%40example.com:passw0rd@mail.example.com:143/INBOX/Feeds
+target:
+  # scheme: either imap or imaps; if omitted, it is deduced from the port
+  scheme: imap
+  # user
+  user: test@example.com
+  # password
+  password: passw0rd
+  # host, without the port
+  host: mail.example.com
+  # port; optional if scheme is given
+  port: 143
+  # root denotes the root of the hierarchy for all feeds. Probably should start with INBOX.
+  # Allowed delimiters in PATH are '/' -- they will be replaced by the correct delimiter. If you know yours, you can
+  # also use that.
+  root: INBOX/Feeds
+# Instead of the verbose target, specifiying a URI is also legitimate. Be sure to properly url-encode user and password.
+# The example from above would read:
+# target: imap://test%40example.com:passw0rd@mail.example.com:143/INBOX/Feeds
 
 ## Global Options
 # Timeout in seconds for fetching feeds.