annotate README.footers @ 919:e371a935a0cd default tip master

Added tag RELEASE_1_3_0 for changeset 570dd6d4942b
author Ben Schmidt
date Thu, 25 May 2017 09:08:47 +1000
parents b68213ccb9d2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
900
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
1 README.footers
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
2
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
3 Footers in Mlmmj
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
4 ================
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
5
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
6 Mlmmj's built-in footer support is very rudimentary. It will work for plain
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
7 text emails, and that's about it. It doesn't understand HTML or MIME or
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
8 anything like that.
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
9
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
10 There are a few solutions to this. They all involve piping incoming mail
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
11 through a filter before it reaches Mlmmj. A script to do this, called
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
12 mlmmj-amime-receive, is included in amime-receive in the contrib directory.
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
13
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
14 It can be used with a number of different pre-processors. One day we also hope
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
15 to improve the integration of these external filters with Mlmmj, e.g. so only
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
16 list posts are processed. However, the piping solution has worked for a number
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
17 of people over the years quite satisfactorily, so this is not a high priority.
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
18
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
19 Here are some pre-processors you can use.
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
20
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
21 alterMIME
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
22 ---------
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
23
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
24 The mlmmj-amime-receive script is designed to work with a program called
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
25 alterMIME. The script itself (in amime-receive in the contrib directory)
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
26 contains links to that software, and instructions.
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
27
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
28 Foot Filter
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
29 -----------
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
30
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
31 alterMIME didn't allow me to reach my particular goals, so I wrote an
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
32 alternative called Foot Filter. It is a single source-file C program; the code
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
33 and a very simple Makefile can be found in foot_filter in the contrib
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
34 directory, along with an altered version of mlmmj-amime-receive, called
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
35 mlmmj-recieve-ff.
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
36
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
37 Foot Filter will output documentation if you run it without arguments, and
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
38 again, instructions for the script that handles the piping are found within it.
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
39
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
40 Py-MIME
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
41 -------
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
42
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
43 A third option is Py-MIME. It was developed for use at The Document Foundation
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
44 (LibreOffice) and is included in pymime in the contrib directory.
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
45
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
46
b68213ccb9d2 Add README.footers and footer-related resources.
Ben Schmidt
parents:
diff changeset
47