Skip to content

Commit 5b49701

Browse files
author
Jose Kahan
committed
JK: doc update, spelling fixes
1 parent 5c8d11d commit 5b49701

File tree

4 files changed

+180
-10
lines changed

4 files changed

+180
-10
lines changed

‎Changelog

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
Version Changes for Hypermail
22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
Jose Kahan (Oct 23, 2009)
4+
- Updated hmrc.4 and hmrc.html to descrbie the new features.
5+
- Fixed some self-introduced spelling errors in setup.c
6+
37
Jose Kahan (Oct 23, 2009)
48
Various fixes / enhancements developed at W3C by Fumihiro Kato,
59
Daigo Matsubara and myself:
610
- Markup changes for deleted messages that are kept.
711
- New directive: htmlmessage_deleted for setting a custom HTML
812
message for the body of deleted messages.
9-
- New directives: delete_incremental to disable deleting of existing
13+
- New directive: delete_incremental to disable deleting of existing
1014
messages in the archive when doing an incremental add of a new
1115
message. In some setups, if this feature is enabled, replies to
1216
deleted messages will cause uncontrolled markup escape and

‎docs/hmrc.4

Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,41 @@ to accept messages without a Message-ID header. Set this to
306306
to discard messages without a Message-ID header. By default such
307307
messages are discarded.
308308
.TP
309+
.B fragment_prefix = "string"
310+
Put this string before the message number in each URI fragment. The defaul
311+
prefix is
312+
.B msg.
313+
.TP
314+
.B email_address_obfuscation = boolean_number
315+
Set to
316+
.B 1
317+
to enable email address obfuscation using numeric character references.
318+
Option
319+
.B disabled
320+
by default.
321+
.TP
322+
.B i18n = boolean_number
323+
Enable I18N features, hypermail must be linked with
324+
.B libiconv.
325+
Option
326+
.B disabled
327+
by default.
328+
.TP
329+
.B i18n_body = boolean_number
330+
Translate message body into UTF-8. The
331+
.B i18n
332+
configuration option must be
333+
.B enabled.
334+
Option
335+
.B disabled
336+
by default.
337+
.TP
338+
.B htmlmessage_deleted = "string"
339+
Set this to HTML markup you want to appear in the body of deleted
340+
messages. Option
341+
.B disabled
342+
by default.
343+
.TP
309344
.B spamprotect = boolean_number
310345
Set this to
311346
.B 1
@@ -459,6 +494,18 @@ html archive. The mbox is not changed.
459494
Deleted and expired messages are removed from the index files
460495
regardless of the delete_level selection. The default is 1.
461496
.TP
497+
.B delete_incremental = boolean_number
498+
If this option is enabled, hypermail will perform deletions on old
499+
messages when run in incremental mode (according to the other delete
500+
configuration options). Note that depending on your hypermail setup,
501+
the size of the archive, and the complexity of the markup,
502+
there may be memory and parsing issues, specifically when there are
503+
non-deleted replies to a deleted message.
504+
If this option is disabled, deleted messages will only be removed
505+
when rebuilding the whole archive. Option
506+
.B enabled
507+
by default.
508+
.TP
462509
.B txtsuffix = "suffix"
463510
If you want the original mail messages archived in individual files,
464511
set this to the extension that you want these messages to have
@@ -659,7 +706,42 @@ statement.
659706
Set this to the list's submission address. When enabled, this can be
660707
used to submit a new message to the list served by the hypermail archive.
661708
.B "NONE"
662-
means don't use it.
709+
means don't use it.
710+
.TP
711+
.B newmsg_command = "mailto:$TO"
712+
This specifies the mail command to use when converting the
713+
.B set_hmail
714+
address to links in replies. The variables
715+
.B $TO,
716+
.B $SUBJECT,
717+
and
718+
.B $ID
719+
can be used in constructing the command string.
720+
.TP
721+
.B replymsg_command = "mailto:$TO"
722+
This specifies the mail command to use when converting the
723+
set_hmail address to links in replies. The variables
724+
.B $TO,
725+
.B $SUBJECT,
726+
and
727+
.B $ID
728+
can be used in constructing the command string. The value
729+
from mailcommand will be used if this option is not specified.
730+
.TP
731+
.B inreplyto_command = "URL"
732+
This gives a URI template to a script that hypermail will link to
733+
if it's unable to find in the archive's messages the MID corresponding
734+
to an
735+
.B In-Reply-To
736+
header. The variable
737+
.B $ID
738+
is used to specify where the
739+
.B Message-Identifier value
740+
will appear in the link. A possible command one could use is
741+
.B http://example.org/mid-resolver/$ID.
742+
This option is
743+
.B disabled
744+
by default.
663745
.TP
664746
.B icss_url = "URL"
665747
This will link an external stylesheet found at the given URL to
@@ -712,6 +794,14 @@ This is the list of MIME types that you want inlined as opposed to
712794
simply linked into the message. They can be listed individually on
713795
multiple lines or comma or space separated on a single line.
714796
.TP
797+
.B inline_addlink = boolean_number
798+
Enable add inline links to content that is stored in the
799+
attachments subdirectory. Option
800+
.B inline_types
801+
must also be enabled. This option is
802+
.B enabled
803+
by default.
804+
.TP
715805
.B ignore_types = types_of_MIME_attachments_to_ignore
716806
This is the list of MIME attachment types that you do not want to
717807
do anything with. They are quietly ignored. They can be listed

‎docs/hmrc.html

Lines changed: 77 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ <h1 align=center><img src="hypermail.png" width="60" align="middle" height="60"
2828
<ul>
2929
<li><a href="#language">language</a> English, German, French, etc.
3030
<li><a href="#iso2022jp">iso2022jp</a> Japanese characters
31+
<li><a href="#i18n">i18n</a> enable Internationalization (i18n) features
3132
<li><a href="#eurodate">eurodate</a> format
3233
<li><a href="#dateformat">dateformat</a> strftime-style format string
3334
<li><a href="#isodate">isodate</a> standard YYYY-MM-DD HH:MM:SS format
@@ -39,6 +40,7 @@ <h1 align=center><img src="hypermail.png" width="60" align="middle" height="60"
3940
<li><a href="#hmail">hmail</a> list submission address
4041
<li><a href="#newmsg_command">newmsg_command</a> new list message mailto
4142
<li><a href="#replymsg_command">replymsg_command</a> reply mailto
43+
<li><a href="#inreplyto_command">inreplyto_command</a> resolver for messages found outside the archive
4244
</ul>
4345
<li><a href="#misc_pages">Miscellaneous</a>
4446
<ul>
@@ -47,6 +49,8 @@ <h1 align=center><img src="hypermail.png" width="60" align="middle" height="60"
4749
<li><a href="#mailto">mailto</a> for &lt;link rev=made href=mailto:
4850
<li><a href="#domainaddr">domainaddr</a> to append to incomplete addresses
4951
<li><a href="#use_sender_date">use_sender_date</a> which date to trust more
52+
<li><a href="#fragment_prefix">fragment_prefix</a> how to prefix each URI fragment
53+
<li><a href="#email_address_obfuscation">email_address_obfuscation</a> simple obfuscation of email addresses
5054
</ul>
5155
</ul>
5256
<li><a href="#index">Index page options</a>
@@ -91,6 +95,7 @@ <h1 align=center><img src="hypermail.png" width="60" align="middle" height="60"
9195
<li><a href="#href_detection">href_detection</a> how to handle URLs
9296
<li><a href="#showbr">showbr</a> line wrapping for body
9397
<li><a href="#iquotes">iquotes</a> italicize quotes
98+
<li><a href="#i18n_body">i18n_body</a> translate message body into UTF-8
9499
<li><a href="#mcss_url">mcss_url</a> stylesheet
95100
<li><a href="#quote_hide_threshold">quote_hide_threshold</a> cut excessive quoting
96101
<li><a href="#files_by_thread">files_by_thread</a> add file with all messages in 1 thread
@@ -123,6 +128,7 @@ <h1 align=center><img src="hypermail.png" width="60" align="middle" height="60"
123128
<li><a href="#usemeta">usemeta</a> save Content-Type in meta file
124129
<li><a href="#text_types">text_types</a> what types are like text/plain?
125130
<li><a href="#inline_types">inline_types</a> list what should go on main page
131+
<li><a href="#inline_addlink">inline_addlink</a> add in-line links to attachments
126132
<li><a href="#prefered_types">prefered_types</a> choose from multipart/mixed
127133
<li><a href="#ignore_types">ignore_types</a> discard text/x-vcard, etc
128134
<li><a href="#attachmentlink">attachmentlink</a> control filenames
@@ -173,6 +179,8 @@ <h1 align=center><img src="hypermail.png" width="60" align="middle" height="60"
173179
<li><a href="#delete_newer">delete_newer</a> delete messages after a date
174180
<li><a href="#delete_msgnum">delete_msgnum</a> delete these messages
175181
<li><a href="#delete_level">delete_level</a> what to do with deleted messages
182+
<li><a href="#delete_incremental">delete_incremental</a> remove previous deleted messages on-the-fly
183+
<li><a href="#htmlmessage_deleted">htmlmessage_deleted</a> custom markup body for deleted messages
176184
<li><a href="#progress">progress</a> verbosity
177185
<li><a href="#warn_surpressions">warn_surpressions</a> warn about ignored messages
178186
<li><a href="#uselock">uselock</a> serialize
@@ -183,11 +191,11 @@ <h1 align=center><img src="hypermail.png" width="60" align="middle" height="60"
183191
</ul>
184192
</ul>
185193
</ul>
186-
</p>
194+
187195
<h2><a name="allpages">Options affecting both messages and index pages</a></h2>
188196
<h3><a name="locale">Locale</a></h3>
189197
<dl>
190-
<a name="language"></a>
198+
<a id="language" name="language"></a>
191199
<dt><strong>language = [ two-or-more-letter-language-id ]</strong></dt><dd>
192200
This is a two-letter string specifying the default
193201
language to use, or a longer string specifying a language
@@ -223,6 +231,14 @@ <h3><a name="locale">Locale</a></h3>
223231
<br>
224232
<br><i>iso2022jp = 0</i>
225233
</dd>
234+
<a name="i18n"></a>
235+
<dt><strong>i18n = [ 0 | 1 ]</strong></dt><dd>
236+
Enable I18N features, hypermail must be linked with
237+
<a href="http://www.gnu.org/software/libiconv/">libiconv</a>.
238+
<br>
239+
<br><i>i18n = 1</i> (disabled by default)
240+
</dd>
241+
226242
<a name="eurodate"></a>
227243
<dt><strong>eurodate = [ 0 | 1 ]</strong></dt><dd>
228244
Set this to reflect how you want dates displayed in the index files.
@@ -296,6 +312,17 @@ <h3><a name="headers">Header options</a></h3>
296312
<br><i>replymsg_command=mailto:$TO?Subject=$SUBJECT</i>
297313
</dd>
298314

315+
<a name="inreplyto_command"></a>
316+
<dt><strong>inreplyto_command = [ string ]</strong></dt><dd>
317+
This specifies a URI template to a script that hypermail will link to
318+
if it's unable to find in the archive's messages the MID corresponding
319+
to an <em>In-Reply-To</em> header. The variable <em>$ID</em>
320+
is used to specify where the <em>Message-Identifier value</em>
321+
will appear in the link.
322+
<br />
323+
<br><em>inreplyto_command = http://example.org/mid-resolver/$ID.</em> (disabled by default)
324+
</dd>
325+
299326
<h3><a name="misc_pages">Miscellaneous</a></h3>
300327

301328
<a name="stripsubject"></a>
@@ -356,6 +383,18 @@ <h3><a name="misc_pages">Miscellaneous</a></h3>
356383
<br>
357384
<br><i>use_sender_date = 0</i>
358385
</dd>
386+
<a name="fragment_prefix"></a>
387+
<dt><strong>fragment_prefix = [ preifx ]</strong></dt><dd>
388+
Put this string before the message number in each URI fragment.
389+
<br>
390+
<br><i>fragment_prefix = id</i> (default is <em>msg</em>)
391+
</dd>
392+
<a name="email_address_obfuscationx"></a>
393+
<dt><strong>email_address_obfuscation = [ 0 | 1 ]</strong></dt><dd>
394+
Set to 1 to enable email address obfuscation using numeric character references.
395+
<br>
396+
<br><i>mail_address_obfuscationx = 1</i> (disabled by default)
397+
</dd>
359398

360399
<h2><a name="index">Index page options</a></h2>
361400
<h3><a name="index_avail">Index availability</a></h3>
@@ -626,6 +665,13 @@ <h3><a name="msg_body">Body style</a></h3>
626665
<br>
627666
<br><i>iquotes = 1</i>
628667
</dd>
668+
<a name="i18n_body"></a>
669+
<dt><strong>i18n_body = [ 0 | 1 ]</strong></dt><dd>
670+
Translate message body into UTF-8. The
671+
<i>i18n</i> configuration option must be enabled.
672+
<br>
673+
<br><i>i18n_body = 1</i> (disabled by default)
674+
</dd>
629675

630676
<a name="mcss_url"></a>
631677
<dt><strong>mcss_url= [ URL | NONE ]</strong></dt><dd>
@@ -856,6 +902,14 @@ <h2><a name="attachments">Attachments</a></h2>
856902
<br><i>inline_types = image/gif image/jpeg</i>
857903
</dd>
858904

905+
<a name="inline_addlink"></a>
906+
<dt><strong>inline_addlink = [ 0 | 1 ]</strong></dt><dd>
907+
Set to On to add inline links to content that is stored in the\
908+
attachments subdirectory. <strong>inline_types</strong> must be enabled.
909+
<br />
910+
<br / ><i>inline_addlink = 1</i> (enabled by default)
911+
</dd>
912+
859913
<a name="prefered_types"></a>
860914
<dt><strong>prefered_types = multipart/mixed types to present</strong></dt><dd>
861915
When mails using multipart/mixed or multipart/alternative types are scanned,
@@ -1227,6 +1281,27 @@ <h3><a name="sysmisc">System miscellaneous</a></h3>
12271281
<br>
12281282
<br><i>delete_level = 1</i>
12291283
</dd>
1284+
<a name="delete_incremental"></a>
1285+
<dt><strong>delete_incremental = [ 0 | 1 ]</strong></dt><dd>
1286+
<br>If this option is enabled, hypermail will perform deletions on old
1287+
messages when run in incremental mode (according to the other delete
1288+
configuration options). Note that depending on your hypermail setup,
1289+
the size of the archive, and the complexity of the markup,
1290+
there may be memory and parsing issues, specifically when there are
1291+
non-deleted replies to a deleted message.
1292+
If this option is disabled, deleted messages will only be removed
1293+
when rebuilding the whole archive.
1294+
<br />
1295+
<br><i>delete_incremental = 0</i> (enabled by default)
1296+
</dd>
1297+
<a name="htmlmessage_deleted"></a>
1298+
<dt><strong>htmlmessage_deleted = [HTML markup string]</strong></dt><dd>
1299+
<br> Custom markup to use in the body of deleted messages when <em>delete_level</em>
1300+
is equal or superior to 2.
1301+
<br>
1302+
<br><i>htmlmessage_deleted = &lt;div class="spam"&gt;&lt;img src="http://example.org/Mail/noUCE.png" alt="unsolicited bulk email removed" /&gt; &lt;p class="spammes"&gt;This message was determined to be unsolicited bulk email and has been removed from our archives.&lt;/p&gt;&lt;p class="spamfooter"&gt;The removal of this email is consistent with &lt;a href="http://example.org/Mail/"&gt;example.org's Mailing List and Archive Usage Policy.&lt;/a&gt;&lt;/p&gt;&lt;/div&gt;</i> (disabled by default)
1303+
</dd>
1304+
12301305
<a name="progress"></a>
12311306
<dt><strong>progress = [ 0 | 1 | 2 ]</strong></dt><dd>
12321307
Set to 1 or 2 to show progress as Hypermail works. Set to 0 for silent

‎src/setup.c

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ struct Config cfg[] = {
159159
"# put this string before the message number in each URI fragment.\n", FALSE},
160160

161161
{"email_address_obfuscation", &set_email_address_obfuscation, BFALSE, CFG_SWITCH,
162-
"# set On to enable email address obfuscation using numeric character reference.\n",FALSE},
162+
"# set to On to enable email address obfuscation using numeric character references.\n",FALSE},
163163

164164
{"i18n", &set_i18n, BTRUE, CFG_SWITCH,
165165
"# Enable I18N features, hypermail must be linked with libiconv.\n",FALSE},
@@ -168,7 +168,8 @@ struct Config cfg[] = {
168168
"# Translate message body into UTF-8. \"i18n\" must be enabled.\n",FALSE},
169169

170170
{"htmlmessage_deleted", &set_htmlmessage_deleted, NULL, CFG_STRING,
171-
"# markup message for deleted messages.\n",FALSE},
171+
"# Set this to HTML markup you want to appear in the body of deleted\n"
172+
"# messages.\n",FALSE},
172173

173174
{"antispam_at", &set_antispam_at, ANTISPAM_AT, CFG_STRING,
174175
"# replace any @ sign with this string, if spam flags enabled.\n", FALSE},
@@ -438,8 +439,8 @@ struct Config cfg[] = {
438439
{"inreplyto_command", &set_inreplyto_command, NULL, CFG_STRING,
439440
"# This gives a URI template to a script that hypermail will link to\n"
440441
"# if it's unable to find in the archive's messages the MID corresponding\n"
441-
"# to an In-Reply-To header. The variable $ID is used to say how the\n"
442-
"# MID will appear in the link.\n", FALSE},
442+
"# to an In-Reply-To header. The variable $ID is used to specify where the\n"
443+
"# Message-Identifier value will appear in the link.\n", FALSE},
443444

444445
{"domainaddr", &set_domainaddr, DOMAINADDR, CFG_STRING,
445446
"# Set this to the domainname you want added to a mail address\n"
@@ -467,8 +468,8 @@ struct Config cfg[] = {
467468
"# opposed to simply <a href> to from the message.\n", FALSE},
468469

469470
{"inline_addlink", &set_inline_addlink, BTRUE, CFG_SWITCH,
470-
"# Define to On to add inline links to content that is stored in the\n"
471-
"# attachments subdirectory. 'inline_types' must also be enabled.\n", FALSE},
471+
"# Set to On to add inline links to content that is stored in the\n"
472+
"# attachments subdirectory. 'inline_types' must be enabled.\n", FALSE},
472473

473474
{"prefered_types", &set_prefered_types, NULL, CFG_LIST,
474475
"# When mails using multipart/mixed types are scanned, this list of\n"

0 commit comments

Comments
 (0)