--- name: "hmrc" section: "5" platform: "linux" package: "hypermail" version: "2.2.0.dfsg-2" release: "Debian 5.0 (Lenny)" platforms: ["linux"] url: "https://new.carta.tech/hmrc" --- # hmrc(5) Hypermail configuration file ## NAME hmrc - Hypermail configuration file ## DESCRIPTION **Hypermail** can use a configuration file to allow you to customize the individual aspects of a list. In past versions of hypermail it was necessary for all hmrc variables to begin with 'hm\_'. While still supported, it is not necessary to use the 'hm\_' prefix any longer and this document reflects that. \[This page may be out of date. See the hmrc.html file for complete and up to date info.\] In the configuration file, blank lines and lines beginning with a hash mark (**#**) are considered comments and are ignored. The format of the "options" need to be in lowercase and separated with an equals (**=**) sign, such as: **option = value** **mbox = /home/john/my\_mailbox** **filemode = 0600** You can specify which configuration file to use on the command line or, if not specified, Hypermail will use the one specified as **CONFIGFILE** in options.h. If the first character is "~", Hypermail will look for the file under the current user's home directory. ## CONFIGURATION OPTIONS - Below is a list of variables that Hypermail understands. Boolean numbers can have the value of **0** or **1.** - **language = two letter language specification** This is a two-letter string specifying the default language to use, or a longer string specifying a language and locale. Set this the value of the language table you wish to use when running and generating archives. **Current supported languages:** de (de\_DE) - German\ en (en\_US) - English\ es (es\_ES) - Spanish\ fi (fi\_FI) - Finnish\ fr (fr\_FR) - French\ el (el) - Greek\ gr (el\_GR) - Greek\ is (is\_IS) - Icelandic\ no (no\_NO) - Norwegian\ pl (pl\_PL) - Polish\ pt (pt\_BR) - Brazilian Portuguese\ ru (ru\_RU) - Russian\ sv (sv\_SE) - Swedish The directory /usr/share/i18n/locales on many systems has the locale codes that are available on that system. - **mbox = filename** This is the mailbox to read messages in from. Set this with a value of **NONE** to read from standard input. - **ietf\_mbox = boolean\_number** Setting this variable to **1** will tell hypermail that the mbox is formatted according to the IETF mbox convention: all lines, except for the envelope, are prefixed with a **\>** char. - **linkquotes = \[ 0 \| 1 \]** Set this to On to create fine-grained links from quoted text to the text where the quote originated. It also improves the threads index file by more accurately matching messages with replies. Note that this may be rather cpu intensive (see the searchbackmsgnum option to alter the performance). - **eurodate = boolean\_number** Set this to **1** to display article received dates with days before months instead of months before days. - **folder\_by\_date = strftime date format** This string causes the messages to be put in subdirectories by date. The string will be passed to [strftime(3)](/strftime/3.md) to generate subdirectory names based on message dates. Suggested values are "%y%m" or "%b%y" for monthly subdirectories, "%Y" for yearly, "%G/%V" for weekly. Do not alter this for an existing archive without removing the old html files. If you use this and update the archive incrementally (e.g. with -u), you must use the usegdbm option. - **msgsperfolder = number** Put messages in subdirectories with this many messages per directory. Do not use this and folder\_by\_date on the same archive. Do not alter this for an existing archive without removing the old html files. Deleted/expired messages ARE COUNTED for the purpose of deciding how many messages to put in a subdirectory. - **increment = \[ 0 \| 1 \| -1 \]** Define as **1** to append all input messages to the end of existing archives.\ Define as **0** for it to read a mailbox that corresponds to the entire archive. (See the mbox\_shortened option for an exception to the requirement that it be the entire archive). If there are any existing html messages, it will figure out which ones at the end of the mailbox are new, and add only those that haven't been converted yet.\ Define as **-1** to have hypermail figure out whether the input is entirely new messages to be appended or whether it contains messages that are already in the archive. A value of -1 cannot be used with the mbox\_shortened option or with the -i command line option or with mbox = NONE. - **label = label name** Define this as the label to put in archives. - **dir = directory** This is the directory that Hypermail will look for when creating and updating archives. If defined as **NONE** the directory will have the same name as the input mailbox. Using date substitution cookies, you can tell Hypermail to archive messages in directories by the date they were received. **Substitution cookies supported** %d - two digit day of month (1-28/30/31)\ %D - three letter day of the week\ %m - two digit month of year (1-12)\ %M - three letter month of year (Jan, ..., Dec)\ %y - four digit year (1990,..2001) For example, if you wished to have Hypermail archive files by year and month, you might use **dir = /lists/somelist/%y/%M** When a message was processed it would be put into a directory **/lists/somelist/1998/Jun** (if the message is processed in June of 1998). If the message arrives and there is no storage directory, Hypermail will automatically create it and store the message in the new directory.\ Note that the date that Hypermail was run will be used, not a date from the message (use the folder\_by\_date option to have Hypermail use dates from messages). - **dateformat = strftime date format** Format used in **[strftime(3)](/strftime/3.md)** call for displaying dates. See **[strftime(3)](/strftime/3.md)** for the valid conversion specifications. - **stripsubject = string** A string to be stripped from all subject lines. Helps unclutter mailing lists which add tags to subject lines. - **archives = URL** This will create a link in the archived index pages labeled *Other mail archives* to the specified URL. Set this to **NONE** to omit such a link. - **custom\_archives = HTML text** If this variable is defined, a navigation entry will be created below the sorted\_by\_x list entry, with the text *Other mail archives:* followed by the value of this variable. Set it to **NONE** to ommit such an entry. - **about = URL** This will create a link in the archived index pages labeled *About this archive* to the specified URL. Set this to **NONE** to omit such a link. - **usemeta = boolean\_number** This option allows you to use metadata to store the content type of a MIME attachment and, later on, when a user browses the attachment, send back this information in the HTTP Content-Type header. When set to **1,** the Content-Type header of a MIME attachment will be stored in a metadata file. Let us say that the MIME attachments for a message are stored in directory **att-num.** The metadata for those attachments will then be stored in directory **att-num/.meta.** If a MIME attachment is stored in file **att-file,** its metadata will be stored in file **att-file.meta.** This convention is directly compatible with the Apache server handling of metada. - **indextable = boolean\_number** Setting this variable to **1** will tell Hypermail to generate an message index Subject/Author/Date listings using a table format. Set to **0** if you want the standard Hypermail index page look and feel. - **reverse = boolean\_number** Setting this variable to **1** will reverse-sort the article entries in the date and thread index files by the date they were received. That is, the most recent messages will appear at the top of the index rather than the other way around. - **showheaders = boolean\_number** Set this to **1** to show the article header lines in the archived HTML files. These lines typically include the **To: , From: ,** and **Subject:** information found in most email messages. - **showhtml = \[ 0 \| 1 \| 2 \]** Set this to **1** to show the articles in a proportionally-spaced font rather than a fixed-width (monospace) font. Set this to **2** for more complex conversion to html similar to that in **txt2html.pl.** Showhtml = 2 will normally produce nicer looking results than showhtml = 1, and showhtml = 0 will look pretty dull, but 1 and 2 run risks of altering the appearance in undesired ways. - **showbr = boolean\_number** Set this to **1** to place **\** tags at the end of article lines. Otherwise, all non-quoted article lines will word wrap. This only takes effect if **showhtml** is enabled. - **iquotes = boolean\_number** Set this to **1** to italicize quoted lines. - **show\_msg\_links = boolean\_number** Set this to **1** to put the individual message links at the top of the individual message pages. Set this to **0** to produce pages without the Next, Previous, Reply, In-Reply-To, etc. links. - **showreplies = boolean\_number** Set this to **1** to show all replies to a message as links in article files. - **discard\_dup\_msgids = boolean\_number** Set this to **0** to accept messages with a Message-ID matching that of a message already in this archive. By default such messages are discarded. - **require\_msgids = boolean\_number** Set this to **0** to accept messages without a Message-ID header. Set this to **1** to discard messages without a Message-ID header. By default such messages are discarded. - **spamprotect = boolean\_number** Set this to **1** to make hypermail not output real email addresses in the output HTML, but instead obfuscate them a little. By default email addresses are obfuscated. - **antispam\_at = string** Set this to **1** make hypermail use something like "\_at\_" instead of the RFC 2822 @ address separator. - **spamprotect\_id = boolean\_number** Set this to **1** to make hypermail not output real email message ids in HTML comments (sometimes used internally by hypermail) but instead it will obfuscate them a little so they don't look like email addresses to spammers. - **attachmentsindex = boolean\_number** Set this to **0** to make hypermail not output an index of articles with attachments. By default hypermail outputs this index. - **mailto = address** The address of the contact point that is put in the HTML header line \ \\ Setting this to **NONE** disables \ header generation. - **mailcommand = command** This specifies the mail command to use when converting email addresses to links. The variables **$TO, $SUBJECT,** and **$ID** can be used in constructing the command string. **$TO** represents the address to send mail to, **$SUBJECT** represents the subject that is being replied to, and **$ID** represents the message ID of the article that is being replied to. If defined as **NONE ,** email addresses will not be converted to links in articles. A possible command one could use is **mailto:$TO?subject=$SUBJECT** and the Subject: would also be filled in. This can be changed to specify a CGI program such as **/cgi-bin/mail?to=$TO .** A CGI mail program is included with the source which can be used for this purpose. - **domainaddr = domainname** Set this to the domainname you want added to a mail address appearing in the RFC822 field which lack a hostname. When the list resides on the same host as the user sending the message, it is often not required of the MTA to domain-ize these addresses for delivery. In such cases, Hypermail will add the DOMAINADDR to the email address. If defined as **NONE ,** this feature is turned off. - **htmlsuffix = suffix** Use this to specify the html file suffix to be used when Hypermail generates the html files. This is dependent on local needs. Do not put a '.' in the value. It would result in "file..html", probably not what you want. - **describe\_folder = string describing folder** Controls the labels used in folders.html to describe the directories created by the folder\_by\_date or msgsperfolder options. For folder\_by\_date labels, the describe\_folder string will be passed to [strftime(3)](/strftime/3.md) the same as the folder\_by\_date string. For msgsperfolder: %d for the directory number (starts with 0)\ %D for the directory number (starts with 1)\ %m for the number of the first message in the directory\ %M for the number of the last message that can be put in the directory. - **latest\_folder = string** If folder\_by\_date or msgsperfolder are in use, create a symbolic link by this name to the most recently created subdirectory. Note that many web servers are configured to not follow symbolic links for security reasons. The link will be created in the directory specified by the "dir" or "-d" option. - **base\_url = url** The url of the archive's main directory. This is needed when the latest\_folder option is used and the folder\_by\_date makes directories more than one level deep (e.g. with '%y/%m'). - **iso2022jp = boolean\_number** Set this to On to support ISO-2022-JP messages. - **uselock = boolean\_number** Controls whether to use hypermail's built-in locking mechanism. By default, this option is set to **1.** Set it to **0** if you have an external locking mechanism, like, for example, when using procmail or smartlist. - **locktime = number-of-seconds** Set this to the number of seconds that a lock should be honored when processing inbound messages. Defaults to 3600 seconds. - **deleted = list of headers** This is the list of headers that indicate the message should not be displayed if the value of this header is 'yes'. The default is "X-Hypermail-Deleted X-No-Archive". - **expires = list of headers** This is the list of headers that indicate the message should not be displayed if the value of this header is a date in the past. The default value is "Expires". - **delete\_older = date** Any message older than this date should not be displayed. Example: delete\_older = "Wed, 14 Mar 2001 12:59:51 +0200" - **delete\_newer = date** Any message newer than this date should not be displayed. - **delete\_msgnum = list of message numbers** This is the list of message numbers that should be deleted from the html archive. The mbox is not changed. - **delete\_level = \[ 0 \| 1 \| 2 \| 3 \]** 0 - remove deleted and expired files. Note that with this choice threading may be screwed up if there are replies to deleted or expired options and the archive is updated incrementally\ 1 - remove message body\ 2 - remove message body for deleted messages, leave expired messages\ 3 - leave all messages Deleted and expired messages are removed from the index files regardless of the delete\_level selection. The default is 1. - **txtsuffix = suffix** If you want the original mail messages archived in individual files, set this to the extension that you want these messages to have (recommended value: txt). - **filter\_out = list of patterns** Delete from the html archives any message having a header line which matches any of these expressions. Uses the same rules for deletion as the expires option. The expressions use the same syntax as Perl regular expressions. - **filter\_require = list of patterns** Delete from the html archives any message not having header lines which match each of these expressions. Uses the same rules for deletion as the expires option. The expressions use the same syntax as Perl regular expressions. - **filter\_out\_full\_body = list of patterns** Delete from the html archives any message having a line which matches any of these expressions. Uses the same rules for deletion as the expires option. The expressions use the same syntax as Perl regular expressions. - **filter\_require\_full\_body = list of patterns** Delete from the html archives any message not having lines which match each of these expressions. Uses the same rules for deletion as the expires option. The expressions use the same syntax as Perl regular expressions. - **save\_alts = \[ 0 \| 1 \| 2 \]** This controls what happens to alternatives (other than the prefered alternative) for multipart/alternative messages.\ 0 - discard non-prefered alternatives\ 1 - show all alternatives inline\ 2 - put non-prefered alternatives in a separate file. - **alts\_text = string** If save\_alts is 1, this text is put between the alternatives. If save\_alts is 2, this text is used to describe the link to each alternative file. - **warn\_surpressions = boolean\_number** Set this to On to get warnings (on stdout) about messages that are not converted because of they are missing a msgid (if require\_msgids is On) or because one of the following options surpressed it: deleted expires delete\_msgnum filter\_out filter\_require filter\_out\_full\_body filter\_require\_full\_body. - **unsafe\_chars = characters** Any characters listed in this string are removed from user-specified attachment filenames. Those characters will be replaced by a "\_" (which means that specifying "\_" here won't have any effect). Note that many characters (including / and ) are removed by the safe\_filename in parse.c regardless of what this option says. There might be some security problems that can be prevented if you specify "." here (e.g. if a web server is configured to enable server side includes on filenames ending in something other than .shtml), but that will prevent browsers from recognizing many file types. - **files\_by\_thread = boolean\_number** Set this to On to generate (in addition to the usual files), a file for each thread that contains all the messages in that thread. - **href\_detection = boolean\_number** Set this to On to assume that any string on the body of the message that says \