Debian Codegraph @

doc/html/_sources/imap/download/installation/http/rss.rst.txt

raw
1 .. _rss:
2
3 =========
4 RSS Feeds
5 =========
6
7 About RSS Feeds
8 ===============
9
10 Use the RSS module to allow read-only access to some mailboxes over RSS.
11
12 An authenticated user can see the list of available mailboxes at the `/rss/`
13 URL on the Cyrus server. The mailbox list for RSS is limited to only the
14 mailboxes the RSS module has been configured to expose **and** the mailboxes
15 the authenticated user has permission to see, according to the normal mailbox
16 :ref:`ACLs <imap-admin-access-control-lists>`.
17
18 Configuration
19 =============
20
21 List of mailboxes: rss_feeds
22 ----------------------------
23
24 .. sidebar:: rss_feeds
25
26 |change-default-config|
27
28 .. include:: /imap/reference/manpages/configs/imapd.conf.rst
29 :start-after: startblob rss_feeds
30 :end-before: endblob rss_feeds
31
32 The list of available RSS feeds can be obtained by clients by accessing the
33 ``/rss/`` URL on the Cyrus server.
34
35 The rss_feeds option uses the "wildmat" (:rfc:`3977#section-4`) format to specify
36 which mailboxes/folders will be made available via RSS. This list is further
37 limited to only those mailboxes and folders that the authenticated user has
38 permissions to see.
39
40 The rss_feeds option uses the
41 :ref:`internal namespace <mailbox-namespaces>`, which uses "." as a hierarchy
42 separator, regardless of what ``unixhierarchysep`` is set to.
43
44 Examples:
45
46 * ``user.bob`` - will serve only user "Bob"'s inbox.
47 * ``rss.*`` - will serve all folders under the shared mailbox called "rss".
48 * ``rss*`` - will serve all content under mailboxes that start with "rss":
49 rss-cool and rss-important will be included, for example.
50 * ``*,!user`` - will serve all shared mailboxes, but no personal mailboxes.
51 * ``*`` - will serve all shared and personal mailboxes.
52
53 Display of mailbox list: rss_feedlist_template
54 ----------------------------------------------
55
56 .. sidebar:: rss_feedlist_template
57
58 |change-default-config|
59
60 .. include:: /imap/reference/manpages/configs/imapd.conf.rst
61 :start-after: startblob rss_feedlist_template
62 :end-before: endblob rss_feedlist_template
63
64
65 By default, the server will present the list as a
66 simple unordered list in an HTML document. To customize the look and feel of the
67 feed list, the ``rss_feedlist_template`` option can be used to point to a HTML
68 template file. This file can use Cascading Style Sheets, JavaScript, etc.
69 All content that the template uses **must** reside under the
70 ``httpdocroot``. Consult :cyrusman:`imapd.conf(5)` for specifics on the
71 required contents of this custom file.
72
73 Note that for sites running Cyrus Murder, ``rss_feedlist_template`` only needs
74 to be set on frontend servers, since only those servers have the complete
75 mailbox list.