aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRené 'Necoro' Neumann <necoro@necoro.eu>2021-10-17 13:36:48 +0200
committerRené 'Necoro' Neumann <necoro@necoro.eu>2021-10-17 13:36:48 +0200
commita3dc93cabc6303777673a12b4a69f3ed7d7480d8 (patch)
tree96e4d232c4e258dc88997ea44c6cfd4e186f0dcc
parent50a50d736b5d5f1e9e2ef3c6afa6b4c0d3e50677 (diff)
downloadfeed2imap-go-a3dc93cabc6303777673a12b4a69f3ed7d7480d8.tar.gz
feed2imap-go-a3dc93cabc6303777673a12b4a69f3ed7d7480d8.tar.bz2
feed2imap-go-a3dc93cabc6303777673a12b4a69f3ed7d7480d8.zip
Improve documentation in configuration
-rw-r--r--config.yml.example6
1 files changed, 3 insertions, 3 deletions
diff --git a/config.yml.example b/config.yml.example
index 1f2c159..cc2c5da 100644
--- a/config.yml.example
+++ b/config.yml.example
@@ -12,9 +12,9 @@ target:
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 denotes the root of the hierarchy for all feeds. Probably should start with INBOX, but may also be empty.
+ # The allowed delimiter in the path is either '/' as a default, or the one used by your mailserver, if so known (for
+ # example: '.').
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: