summaryrefslogtreecommitdiffstats
path: root/userconfig/listtext/help
diff options
context:
space:
mode:
authorMalfurious <m@lfurio.us>2024-06-13 23:06:48 -0400
committerMalfurious <m@lfurio.us>2024-06-15 17:41:53 -0400
commitfea6ee9debbb5d46e756953afcd3383eb0c23f73 (patch)
tree72099ccf022c419529622f5fe413965d1b5f3157 /userconfig/listtext/help
parent7d2158a75b6ff294146444a6e1b51170d3f43010 (diff)
downloadmailnode-fea6ee9debbb5d46e756953afcd3383eb0c23f73.tar.gz
mailnode-fea6ee9debbb5d46e756953afcd3383eb0c23f73.zip
mlmmj: Add user configuration directories
Configuration variables for individual mailing lists should go in subdirectories under `userconfig/lists/`. The directory name is the list name and files/directories beginning with a '.' are ignored. The contents within these list directories should be the list's "tunable" settings which usually reside in the lists's "control" directory. See https://mlmmj.org/TUNABLES.html for more information. Files under `userconfig/listtext/` are the auto-response messages sent out by the lists. The files we store here are shared by all lists, and much of their contents are parameterized. This commit adds the default versions of these files. Signed-off-by: Malfurious <m@lfurio.us>
Diffstat (limited to 'userconfig/listtext/help')
-rw-r--r--userconfig/listtext/help88
1 files changed, 88 insertions, 0 deletions
diff --git a/userconfig/listtext/help b/userconfig/listtext/help
new file mode 100644
index 0000000..3b104bc
--- /dev/null
+++ b/userconfig/listtext/help
@@ -0,0 +1,88 @@
+Subject: Information for $list$@$domain$
+
+%text prologue%
+
+Here is some information about the list.
+
+You can subscribe to the following versions:
+
+- %wrap%The normal version: Every time a post is sent to the list,
+subscribers receive a copy of it.
+%ifcontrol closedlist closedlistsub%
+ Subscribe by contacting a list administrator.
+%else%
+ Subscribe by emailing <$list+$subscribe@$domain$>.
+%endif%
+
+%ifncontrol nodigestsub%
+ %^%- %wrap%The digest version: Subscribers receive multiple posts in a
+ single mail message, at regular intervals, or when a lot of posts have
+ accumulated.
+ %ifcontrol closedlist closedlistsub%
+ Subscribe by contacting a list administrator.
+ %else%
+ Subscribe by emailing <$list+$subscribe-digest@$domain$>.
+ %endif%
+%endif%
+
+%ifncontrol nonomailsub%
+ %^%- %wrap%The no-mail version: Subscribers do not receive any posts to
+ the list. This means, though, they are able to post to a list which only
+ subscribers may post to, while they follow the list using a web archive or
+ another subscribed email address.
+ %ifcontrol closedlist closedlistsub%
+ Subscribe by contacting a list administrator.
+ %else%
+ Subscribe by emailing <$list+$subscribe-nomail@$domain$>.
+ %endif%
+%endif%
+
+%ifcontrol submod%
+ %^%%wrap%The list has gatekeepers who will review subscription requests
+ before permitting new members.
+%endif%
+
+%ifcontrol closedlist%
+ %^%%wrap%Unsubscribe by contacting a list administrator.
+%else%
+ %^%%wrap%Unsubscribe by emailing <$list+$unsubscribe@$domain$>.
+%endif%
+
+%wrap%Posts are made by emailing <$list$@$domain$>.
+
+%ifcontrol subonlypost%%ifncontrol modnonsubposts%
+ %^%%wrap%However, only subscribers may post to the list.
+%endif%%endif%
+
+%ifcontrol moderated%
+ %^%%wrap%The list has moderators who will review all posts before
+ releasing them to the list.
+%else%
+ %ifcontrol subonlypost%%ifcontrol modnonsubposts%
+ %^%%wrap%The list has moderators who will review posts from
+ non-subscribers before releasing them to the list.
+ %endif%%endif%
+%endif%
+
+%ifcontrol access%
+ %^%%wrap%The list also has access rules which may affect who can post and
+ which posts are moderated.
+%endif%
+
+%ifncontrol noget%%ifncontrol noarchive%
+ %^%%wrap%
+ %ifcontrol subonlyget%
+ Anyone
+ %else%
+ Subscribers
+ %endif%
+ can retrieve message number N from the list's archive by sending a message
+ to <$list+$get-N@$domain$> (change the N to the number of the desired
+ message).
+%endif%%endif%
+
+%wrap%You can retrieve the frequently asked questions document for the list
+by sending a message to <$list+$faq@$domain$>.
+
+%wrap%To contact the list owner, send a message to <$list+$owner@$domain$>.
+