Differences

This shows you the differences between two versions of the page.

--- subscription [2013-05-29 21:01] – [Email Subscriptions] 69.41.164.170
+++ subscription [2023-09-25 20:15] (current) – Klap-in
@@ Line 1: / Line 1: @@
 ====== Email Subscriptions ======
-FIXME
+DokuWiki allows individual users to "subscribe" to page changes. When a page is changed by a user all //other// users who have subscribed to that page will receive an email describing the changes. The user changing the page will not receive an email.
-DokuWiki allows individual users to "subscribe" to page changes. When a page is changed by a user all other users who have subscribed to that page will receive an email describing the changes. The email shows the changes in [[wp>Diff#Unified_format|unified diff format]], a sample email is shown at the bottom of this page.
-The subscription facility is controlled using the [[config:subscribers|subscribers setting]].  It is turned off by default. The sender address is set by [[config:mailfrom|mailfrom setting]].
+Only [[: login |logged in]] users have access to the "Manage Subscriptions" [[:main_window#page_tools |page tool]] (see screenshot below), it is not possible for anonymous / not [[:user registration |registered]] users to subscribe. Note that DokuWiki's email subscriptions are meant as a [[wp>collaboration tool]], not as newsletter - for anonymous / newsletter-like change information supply DokuWiki offers an RSS feed, see [[:syndication |XML Syndication]].
-**Note for wiki admins**
+===== Enabling Subscriptions =====
+The subscription facility is controlled using the [[config:subscribers|subscribers setting]].  It is turned **off by default**. You can turn it on in the configuration page of your wiki. Also, make sure to uncheck 'Subscribe/Unsubscribe' of disableactions in the authentication section of the configuration. The sender address is set by [[config:mailfrom|mailfrom setting]].
 Be careful in switching this facility on.  In a busy wiki, with both frequent changes and many subscribers, emailing the changes to those subscribers can put a heavy strain on the webserver.  In a public wiki it may also provide unscrupulous people with a way to send spam to your wiki's users.
+Please also note that the subscribe feature is different from the [[config:notify|notify]] setting. The latter works even when subscriptions are turned off.
 [[syndication|RSS Feeds]] provide an alternative (and lighter) mechanism for receiving details of updates to the wiki.
@@ Line 15: / Line 18: @@
 ===== Manage Subscriptions=====
-You can display the Subscription Management for the current page via the ''Manage Subscriptions'' button of the pagetool, right to your wikipage.
-To subscribe you choose between two kind of subscriptions:
+You can display the Subscription Management for the current page via the ''Manage Subscriptions'' button of the pagetool.
+To subscribe you choose between two kind of subscriptions:{{ :subcriptionmanagement.png?400|}}
   * The **current page**\\ Where you can set notification frequency to:
     * email on every change
@@ Line 26: / Line 30: @@
     * list of changed pages since last email (every 1.00 days)
-When you are subcribed to the page or namespace it will show up in the overview of current subscriptions. A namespace subcription appears on the management page of all pages within it.
+When you are subscribed to the page or namespace it will show up in the overview of current subscriptions. A namespace subscription appears on the management page of all pages within it.
-The current subscriptions overview has a ''Unsubscribe'' button.
+The frequency of digest and list mails can be set through the [[config:subscribe_time|subscribe_time]] setting.
-{{:subcriptionmanagement.png?500 |}}
+==== Unsubscribing ====
+To unsubscribe you have to go the subscribed page or namespace, open the Subscription Management as described above and click on unsubscribe next to the subscription you want to remove.
-===== Subscription emails =====
+To ease finding the correct entry point for unsubscribing you will find the link at the bottom of every subscription mail you receive.
-The subscriptions emails are in the folder ''inc/lang/en'' with names beginning with ''subscr_''. When you like to modify them, please copy first to ''conf/lang/en'' to prevent overwriting at upgrading. See [[localization#changing_localized_texts_in_your_installation|changing localized texts]] for more information.
+===== Customizing =====
+==== Subscription emails ====
-=== Example email ===
+The subscriptions emails are in the folder ''inc/lang/en'' with names beginning with ''subscr_''. When you like to modify them, please copy first to ''conf/lang/en'' to prevent overwriting at upgrading. See [[localization#changing_localized_texts_in_your_installation|changing localized texts]] for more information.
-Below an example email for the mail on every change.
-<file>
-Hello!
-The page sample_page in the Wiki Name wiki changed.
-Here are the changes:
---------------------------------------------------------
-@@ -3,18 +3,18 @@
-  ===== Section Title =====
-- (This is some example text)
-+ (This is some different example text.)
---------------------------------------------------------
-Date        : 2009/12/25 11:19
-User        : sampleuser
-Edit Summary: sample edit summary
-Old Revision: http://www.example.com/doku.php?id=sample_page?rev=1246611477
-New Revision: http://www.example.com/doku.php?id=sample_page
-To cancel the page notifications, log into the wiki at
-http://www.example.com/ then visit
-http://www.example.com/doku.php?id=sample_page
-and unsubscribe page and/or namespace changes.
---
-This mail was generated by DokuWiki at
-http://www.example.com/
-</file>
-===== .mlist files =====
+==== .mlist files ====
 Using the Subscriptions will create files with the extension .mlist in the ~/data/meta/ folders and subfolders. In each .mlist file are the subscribed usernames.
@@ Line 82: / Line 54: @@
   findstr /s "." *.mlist
-You can likewise use the following command on a Linux system:
+You can likewise use the following commands on a Linux system:
-  grep -rH ".*" *.mlist
+  grep -r ".*\.mlist$"
+  find . -name "*.mlist"
+  ls *.mlist
 On a Mac (but I presume on a Linux system as well) the following statement works much better:
@@ Line 92: / Line 68: @@
 (every=notify on any change, digest=digest changes, list=list of pages)
-In either case, be sure to change to your data/meta directory first.
+Searching for all subscriptions of a particular user on [[https://openbsd.org|OpenBSD]] or similar UNIX platforms, where grep does not support the ''%%--include%%'' option, can be done like this (for the user with the short name ''//user//''):
+  find . -name '*.mlist' -exec egrep -n '^user ' {} +
+In any case, be sure to change to your ''[wiki directory]/data/meta'' directory first.
-===== Issues =====
-  * It would be useful if the SuperUser could add arbitrary additional email addresses to a subscription. This would be useful in a situation where LDAP is being used for authentication and the superuser would like to subscribe a distribution group to page changes, rather than an individual user.
-  * It would be useful for the SuperUser to be able to select the default behavior of subscription. this way there would be one configuration when subscribers receive an email **Unless** the editor marks the change as trivial, versus another when the subscriptions receive an email **only** when the editor marks it as important.
-  * It would also be useful if there is a page that shows ALL current subscriptions from all pages within one list.
-  * [BUG]: Manipulationg the .mlist files manually causes DokuWiki to reset all subscriptions (Release 2012-01-25b "Angua", IIS7)