aboutsummaryrefslogtreecommitdiff
path: root/config.yml.example
diff options
context:
space:
mode:
authorRené 'Necoro' Neumann <necoro@necoro.eu>2020-08-22 16:05:29 +0200
committerRené 'Necoro' Neumann <necoro@necoro.eu>2020-08-22 16:05:29 +0200
commit89746a2a3b719a6836587497af90dc548d2192ba (patch)
tree8414c8bee2a6b64eccfbdf717de329ece81e240d /config.yml.example
parentaf957a67eb34430d5788bf1d2cb8e1aa1e46f3ff (diff)
downloadfeed2imap-go-89746a2a3b719a6836587497af90dc548d2192ba.tar.gz
feed2imap-go-89746a2a3b719a6836587497af90dc548d2192ba.tar.bz2
feed2imap-go-89746a2a3b719a6836587497af90dc548d2192ba.zip
#26 Update config.yml.example
Diffstat (limited to 'config.yml.example')
-rw-r--r--config.yml.example11
1 files changed, 11 insertions, 0 deletions
diff --git a/config.yml.example b/config.yml.example
index 1213189..747ccc2 100644
--- a/config.yml.example
+++ b/config.yml.example
@@ -32,6 +32,10 @@ parts: ["text", "html"]
# Email-Address to use in 'From' and 'To' when not specified in feed.
# Default uses 'current user'@hostname
default-email: username@hostname
+# Whether the target folder determination for each feed shall fallback on the feed's/group's name.
+# When `true`, omitting a target is identical to specifying the name as the target.
+# When `false`, omitting a target is identical to specifying `null` or `""` as the target.
+auto-target: true
## Per-Feed Options
# Defaults for options per feed, overridable in each feed and group
@@ -77,12 +81,19 @@ options:
## Feeds
# Each feed must have a name, and a URL or Exec argument. The name must be unique.
# The name also determines the folder to use for that feed, which can be overwritten with an explicit target.
+# This behavior can be changed by toggling the global option `auto-target` (see above).
# Groups can be used to build a hierarchy, with arbitrary nesting.
feeds:
- name: XKCD
url: http://xkcd.com/rss.xml
# specify any per feed option to overwrite it for this feed
min-frequency: 12
+ # No target has been defined, so it falls back onto the feed's name.
+ # Combined with the global `target`, the final folder will be:
+ # INBOX/Feeds/XKCD
+ # Would the global option `auto-target` been set to `false`, this fallback would not occur,
+ # and the final folder would be:
+ # INBOX/Feeds
# Groups can be used for, well, grouping.
- group: Linux
# You can specify options on group level that are then used for all feeds contained