Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 114 lines (93 sloc) 5.297 kb
633270a @mhagander Add a quick README file
authored
1 Mailinglist Moderator
2 =====================
3
4 This is just a small program to make moderating mailinglists while on the road
5 a bit easier. If you're like me and don't like them to clutter up your mailbox,
6 at least.
7
8 The program will simply enumerate all pending moderation requests and let you
9 approve or reject them.
10
11 At this point, only posts are moderated, not subscription requests.
12
87df535 @mhagander Add README notice about downloading from market
authored
13 Installing
14 ----------
15 Note! You are advised to install the program from the Android Market where
16 it's available for free. There are some APKs available for download from
17 the github page, but all updates are not always published there. The source
18 always is, of course, just not the prebuilt APKs.
633270a @mhagander Add a quick README file
authored
19
20 Setting up a list
21 -----------------
22 To add a new mailinglist, hit the *Menu* key and select *Servers...*. Hit
23 *Menu* again, and select *New server*. In the window that shows up, enter the
24 *name of the mailinglist*. (Yes, there is some confusion of terms here, but this
25 is the name of the list, not the server).
26
27 When you've done this, you will be sent back to the main screen, and your list
28 will show up as unconfigured (in a future improved version, you should end up
29 directly at the list configuration page here). To configure the details, hit
30 the *Menu* key, and select *Servers* (again). Now click on the new server to
31 go into the configuration page for it, where you can enter the base URL and
32 the password.
33
34 If you have one or more existing servers, you can easily duplicate them by
35 clicking and holding on the name of the server and choose copy. This will copy
36 the base url and password, but give you a chance to enter a new name for the
37 list. This is particularly useful if you have a "site-wide" administration
38 password that will grant you access to all lists.
39
40 Base URLs
f911acc @mhagander Update README with the newest functions
authored
41 ~~~~~~~~~
633270a @mhagander Add a quick README file
authored
42 The *base url* should be set to the root of the list server management URL.
43 It will be different depending on which list manager is used. Note that the
44 base url does *not* include the name of the list.
45
46 Mailman
47 +++++++
48 For mailman, the base url is typically ``http://lists.domain.com/mailman/admindb``.
49
50 Majordomo2
51 ++++++++++
52 For majordomo2, the base url is typically ``http://lists.domain.com/mj/mj_wwwadm``.
53
f911acc @mhagander Update README with the newest functions
authored
54 Importing and exporting
55 ~~~~~~~~~~~~~~~~~~~~~~~
56 You can import and export your list of servers to a XML file from the menu. This
57 file will be placed in the `/sdcard/` folder, so you can use any program to edit
58 or transfer it. Note that there is no real validation done when importing, so if
59 the XML file has an invalid format or content, the program is likely to just
60 crash instead of giving an error message.
61
62 SSL
63 ~~~
64 In it's default mode, Mailinglist Moderator will rely on the Android system to
65 validate the certificate of the server connected to, if the URL starts with
66 `https`. There are two settings to override this (per server), if you are using
67 a certificate that doesn't validate properly:
68
69 Non-standard SSL hostname
70 This setting is used if the certificate has a different hostname than the
71 URL, but otherwise validates fine. A typical example of this is overloading
72 hostnames, so the certificate is for `www.domain.com`, but the list server
73 is responding to `lists.domain.com`. In this case, put `www.domain.com` in
74 settings as *Non-standard SSL hostname*.
75 Accept invalid certificate
76 This setting is used when the certificate on the server simply does not
77 validate. This could be because it's a self signed certificate, because the
78 CA signing it is not known, because it has expired, or any other reasons.
79 The configuration is set to the *SHA-1 fingerprint* of the certificate, and
80 any server that presents this fingerprint will be accepted. When you enter
81 this setting, the current certificate will automatically be downloaded and
82 presented, and you can press a button to copy the fingerprint to the setting,
83 once you have verified that it's correct. *Note* that you will have to
84 set the *Non-standard SSL hostname* setting as well as this one, in case the
85 name on the certificate doesn't match.
86
633270a @mhagander Add a quick README file
authored
87 Moderating
88 ----------
89 When the application starts it will enumerate all unmoderated emails on all the
90 lists, and the main view will show how many unmoderated messages there are on the
91 list. The entries will be sorted so that the list with the largest amount of
92 pending moderation requests is listed on top.
93
94 To moderate the entries on a list, just click the list from the main view. This
95 will give a list of all the emails pending on this list, the sender of them
96 and the subject. To view the contents of the mail, just click the mail.
97
98 To moderate an individual email, click-hold on it and choose to reject or approve
99 it. You can also hit the *Menu* key and from the popup menu choose to reject
100 or approve all messages at once.
101
102 Once you're satisfied with the status of the messages, hit the *Menu* key and
103 select *Apply moderation*. This will call out to the server and make the actual
104 moderation changes.
105
106 Depending on mailinglist manager this will be a single operation (for mailman)
107 or a sequence of one operation for each message (majordomo2), and may in the
108 majordomo2 case take a while if it's a lot of emails to be moderated.
ce48572 @mhagander Add note about localization of the listserver software
authored
109
110 Common issues
111 -------------
112
113 * The mailinglist software to be in English - localized versions don't work.
Something went wrong with that request. Please try again.