#
# hmrc.example:
#
# This is a sample Hypermail configuration file. If you wish
# to use it, copy it to a new filename and edit as appropriate
# for you list needs.
#
# language = [ en | de | es | fi | fr | is | pl | pt | sv | no | el | gr | ru | it ]
#
# This is a two-letter string specifying the default language to use.
# Set this the value of the language table you wish to use when running
# and generating archives.
language = en
# htmlsuffix = html
#
# Use this to specify the html file suffix to be used when Hypermail
# generates the HTML files. This is dependent on local needs.
#
# NOTE: Do not put a '.' in the value. It would result in \"file..html\
htmlsuffix = html
# mbox = [ filename | NONE ]
#
# This is the default mailbox to read messages in from. Set this
# with a value of NONE to read from standard input as the default.
mbox = NONE
# ietf_mbox = [ 0 | 1 ]
#
# Set this to On to read mboxes using the IETF convention.
ietf_mbox = 0
# label = [ Title | NONE ]
#
# This is the default title you want to call your archives.
# Set this to NONE to use the name of the input mailbox.
label = Hypermail Development List
# archives = [ URL | NONE ]
#
# 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
archives = NONE
# custom_archives = [ text | NONE ]
#
# 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.
#custom_archives =
# about = [ URL | NONE ]
#
# This creates a link in the archived index pages labeled
# "About this archive". Set this to NONE to omit such a link.
about = NONE
# dir = [ directory path | NONE ]
#
# This is the default directory that Hypermail uses when creating
# and updating archives. If set to NONE, the directory will have the
# same name as the input mailbox.
dir = NONE
# defaultindex = [ thread | date | subject | author | attachment ]
#
# This indicates the default type of main index hypermail will generate.
# Users see this type of index when the archive is first accessed.
# Valid types are date, thread, author, subject, and attachment. When
# using the folder_by_date or msgsperfolder options, this option applies
# to subdirectories.
defaultindex = thread
# default_top_index = [ thread | date | subject | author | folders | attachment ]
#
# This specifies the default index that users can view when
# entering the top level of an archive that uses the folder_by_date
# or msgsperfolder option. Valid types are date, thread, author,
# subject, attachment, and folders.
default_top_index = folders
# avoid_indices = [ thread | date | subject | author | folders | attachment ]
#
# This is a list of index files to not generate. Valid types are
# date, thread, author, and subject. When using the folder_by_date or
# msgsperfolder options, this option applies to subdirectories.
#avoid_indices =
# avoid_top_indices = [ thread | date | subject | author | folders | attachment ]
#
# This is a list of index files to not generate for the top
# directory of an archive using the folder_by_date or
# msgsperfolder option. Valid types are date, thread, author,
# subject, folders, and attachment.
avoid_top_indices = date thread author subject
# inlinehtml [ 0 | 1 ]
#
# This is used to make text/html parts to get inlined within the
# mail messages. If not set on, HTML-parts will be stored as separate
# files.
inlinehtml = 1
# reverse = [ 0 | 1 ]
#
# 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.
# Set to 0 if you want latest message on the bottom for date and
# thread indexes.
reverse = 0
# usetable = [ 0 | 1 ]
#
# Setting this variable to 1 will tell Hypermail to generate an
# index menu at the top and bottom of each page in a table format.
# Set to 0 if you want the standard Hypermail page look and feel.
usetable = 0
# indextable [ 0 | 1 ]
#
# Setting this variable to 1 will tell Hypermail to generate
# message index Subject/Author/Date listings using a nice table
# format. Set to 0 if you want the original Hypermail index look.
indextable = 0
# progress = [ 0 | 1 | 2 ]
#
# Set this to 1 or 2 to always show a progress report as Hypermail
# works. With a setting of 1, hypermail overwrites the progress
# information relating to attachment creation. With a setting of 2,
# attachment creation information is listed individually with the
# number of the message the attachments relate to. Set to 0 for
# silent operation. Output goes to standard output.
progress = 0
# show_msg_links = [ 0 | 1 | 3 | 4 ]
#
# Set this to 1 if you want links to Next, Prev, Next thread, Reply to,
# etc, displayed on the article pages. Setting this to 0 disables these
# links from appearing on the generated pages.
# Set it to 3 to show the links only at the top of the message
# pages, or 4 to produce those links only at the bottom of the
# message.
show_msg_links = 1
# showheaders = [ 0 | 1 ]
#
# 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. Set to 0 if you want to
# hide mail headers in articles.
showheaders = 0
# showreplies = [ 0 | 1 ]
#
# Set to 1 to show all replies to a message as links in article files.
# If this is set to 0 no reply links are generated.
showreplies = 1
# 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.
showhtml = 1
# showbr = [ 0 | 1 ]
#
# Set this to 1 if you want article lines to end with the tag.
# Else set to 0 to have non-quoted lines word-wrap. Only takes effect
# if showhtml is set to 1.
showbr = 1
# iquotes = [ 0 | 1 ]
#
# Set this to 1 if you want quoted lines to be shown in italics. Only
# take effect if showhtml is set to 1.
iquotes = 1
# showhr = [ 0 | 1 ]
#
# Set to 1 if you want horizontal rules
before and after
# the articles. Set to 0 if you don't.
showhr = 1
# overwrite = [ 0 | 1 ]
#
# Set to 1 to make Hypermail rewrite all messages.
# Set to 0 to rewrite as few messages as possible.
# Rewriting all messages is slower, but if you change the options
# that control the appearance of the messages you may want to rewrite
# all the messages to make the appearance consistent throughout the archive.
overwrite = 0
# increment = [ -1 | 0 | 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.
increment = 0
# readone [ 0 | 1 ]
#
# Set this to On to specify there is only one message in the input.
readone = 0
# thrdlevels = number
#
# This specifies the number of thread levels to outline in the thread
# index. For instance, if thrdlevels is 2, replies to messages will
# be indented once in the index, but replies to replies, etc., will only
# be indented once as well. The normal value is 4.
thrdlevels = 4
# eurodate = [ 0 | 1 ]
#
# Set this to reflect how you want dates displayed in the index files.
# Set as 1 to to use European date format "DD MM YYYY".
# Define as 0 to to use American date format "MM DD YYYY".
eurodate = 0
# isodate = [ 0 | 1 ]
#
# Set this to On to display article received dates in
# YYYY-MM-DD HH:MM:SS format. If used with the gmtime option, a
# Z will be inserted between the DD and HH.
#isodate = 0
# gmtime = [ 0 | 1 ]
#
# Set this to On to display article received dates using
# Greenwich Mean Time (UTC) rather than local time.
#gmtime = 0
# dateformat = strftime() date format
#
# Format used in strftime(3) call for displaying dates.
# See strftime(3)) for the valid conversion specifications.
dateformat = %c
# attachmentlink = attachment link format
#
# Format of the attachment links.
# %p for the full path to the attachment
# %f for the file name part only
# %d for the directory name only
# %n for the message number
# %c for the content type string
attachmentlink = %p
# discard_dup_msgids = [ 0 | 1 ]
#
# Set this to Off to accept messages with a Message-ID matching
# that of a message already in this archive.
# By default such messages are discarded.
discard_dup_msgids = 1
# require_msgids = [ 0 | 1 ]
#
# 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.
require_msgids = 1
# usemeta = [ 0 | 1 ]
#
# Set this to 1 to store the content type of a MIME attachment in
# a metadata file.
usemeta = 1
# uselock = [ 0 | 1 ]
#
# Set this to 1 to use Hypermail's internal locking mechanism.
#
uselock = 1
# locktime = number-of-seconds
#
# The number of seconds that a lock should be honored when processing
# inbound messages.
locktime = 3600
# dirmode = octal number
#
# This is an octal number representing the permissions (rwx modes) that new
# directories are set to when they are created. If the archives will be made
# publically available, it's a good idea to define this as 0755. This must
# be an octal number.
dirmode = 0755
# filemode = octal number
#
# This is an octal number representing the permissions that new files
# are set to when they are created. If the archives will be made publically
# available, it's a good idea to define this as 0644. This must be an octal
# number.
filemode = 0644
# mailcommand = [ direct mailto | cgi-bin script path | NONE ]
#
# This is the mail command that email links go to, for instance
# "mailto:$TO" or "/cgi-bin/mail?to=$TO&replyto=$ID&subject=$SUBJECT"
#
# In constructing this command, you can specify variables:
#
# $TO : the email address of the person you're sending mail to.
# $ID : the ID of the message you're replying to.
# $SUBJECT: the subject you're replying to.
#
# NONE disables mailcommand usage.
mailcommand = mailto:$TO?subject=$SUBJECT&replyto=$ID
# mailto = [ email-address | NONE ]
#
# The address of the contact point that is put in the HTML header line
#
#
# The header can be disabled by default by setting
# mailto to NONE.
mailto = webmaster@hypermail.org
# domainaddr = [ domainname | NONE ]
#
# Domain-ize Addresses -- addresses appearing in the RFC822 field
# which lack hostname can't be made into proper HREFs. Because the
# MTA resides on the same host as the list, it is often not required
# to domain-ize these addresses for delivery. In such cases, hypermail
# will add the DOMAINADDR to the email address.
domainaddr = hypermail.org
# hmail = [ Mailing List Submission Address | NONE ]
#
# Set this to the list's submission address. When enabled, this can be
# used to submit a new message to the list served by the hypermail archive.
# "NONE" means don't use it.
hmail = hypermail@hypermail.org
# ihtmlheaderfile = [ path to index header template file | NONE ]
#
# Set this to the path to the Index header template file containing
# valid HTML statements and substitution cookies for runtime expansion.
# This will be included at the top of every index page.
ihtmlheaderfile = /lists/hypermail-idxheader.hyp
# ihtmlfooterfile = [ path to index footer template file | NONE ]
#
# Set this to the path to the Index footer template file containing
# valid HTML statements and substitution cookies for runtime expansion.
# This will be included at the bottom of every index page.
ihtmlfooterfile = /lists/hypermail-idxfooter.hyp
# mhtmlheaderfile = [ path to message header template file | NONE ]
#
# Set this to the path to the Message header template file containing
# valid HTML statements and substitution cookies for runtime expansion.
# This will be included at the top of every message page.
mhtmlheaderfile = /lists/hypermail-msgheader.hyp
# mhtmlfooterfile = [ path to message footer template file | NONE ]
#
# Set this to the path to the Message footer template file containing
# valid HTML statements and substitution cookies for runtime expansion.
# This will be included at the bottom of every message page.
mhtmlfooterfile = /lists/hypermail-msgfooter.hyp
######################
# Multiline variables
######################
# show_headers = list of RFC 822 Headers to display if hm_showheaders
# is set to 1 (TRUE)
#
# This is the list of headers to be displayed. They can be listed
# comma or space separated all on a single line such as
# show_headers = From,Subject,Date,Message-ID
# or they can be listed individually or any combination of.
# show_headers = From
# show_headers = Subject
# show_headers = Date
# show_headers = Message-ID
show_headers = From,Subject,Date,Message-ID
# inline_types = indicate which types of data should be inlined
#
# This is the list of MIME types that you want inlined with tags
# as opposed to simply linked into the message with a . They
# can be listed individually on multiple lines or comma or space
# separated on a single line.
# inline_types = image/gif image/jpeg
# or
# inline_types = image/gif
# inline_types = image/jpeg
inline_types = image/gif image/jpeg image/png
# ignore_types = indicate which types of attachments to ignore and
# not process.
#
# This is the list of MIME attachment types that you do not want to
# do anything with. They are quietly ignored. They can be listed
# individually on multiple lines or comma or space separated on a
# single line.
# ignore_types = text/x-vcard application/x-msdownload
# or
# ignore_types = text/x-vcard
# ignore_types = application/x-msdownload
ignore_types = text/x-vcard
ignore_types = application/x-msdownload
# prefered_types = indicate which of the alternative types to use
#
# When mails using multipart/mixed types are scanned, this is the
# list of alternative MIME types that you want used. This can be
# listed individually on multiple lines or comma or space separated
# on a single line.
# prefered_types = text/plain text/html
# or
# prefered_types = text/plain
# prefered_types = text/html
# Order is important.
#
# NOTE: This option is not fully implemented at present.
prefered_types = text/plain text/html
# text_types = indicate the MIME types to be treated as text/plain.
#
# This is a list of MIME types that you want hypermail to treat
# exactly as if they were text/plain. This can be listed
# individually on multiple lines or comma or space separated
# on a single line.
text_types = text/x-vcard
# usegdbm = [ 0 | 1 ]
#
# Set this to On to use gdbm to implement a header cache.
#This will speed up hypermail, especially if your filesystem is slow.
#It will not provide any speedup with the linkquotes option.
#usegdbm = Off
# append = [ 0 | 1 ]
#
# Set this to On to maintain a parallel mbox archive. The file
#name defaults to mbox in the directory specified by -d or by the dir option.
#append = 0
# append_filename = [ string ]
#
# Specifies the filename to be used by the append option.
#$DIR may be used to specify a name relative to the directory
#specified in the -d or dir option.
#append_filename =
# newmsg_command = [ string ]
#
# This specifies the mail command to use when converting the
# set_hmail address to links in replies. The variables $TO, $SUBJECT,
# and $ID can be used in constructing the command string.
#newmsg_command = mailto:$TO
# replymsg_command = [ string ]
#
# This specifies the mail command to use when converting the
# set_hmail address to links in replies. The variables $TO, $SUBJECT,
# and $ID can be used in constructing the command string. The value
# from mailcommand will be used if this option is not specified.
#replymsg_command = mailto:$TO
# icss_url = [ URL ]
#
# Specifies a URL to an external CSS stylesheet for the index pages.
The CSS will be associated to the indexes thru an HTML LINK element.
#icss_url =
# mcss_url = [ URL ]
#
# Specifies a URL to an external CSS stylesheet for the message pages.
The CSS will be associated to the indexes thru an HTML LINK element.
#mcss_url =
# spamprotect = [ 0 | 1 ]
#
# Set this to On to make hypermail not output real email addresses
# in the output HTML but instead it will obfuscate them a little.
spamprotect = 1
# spamprotect_id = [ 0 | 1 ]
#
# Set this to On 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.
spamprotect_id = 1
# attachmentsindex = [ 0 | 1 ]
#
# Set this to Off to make hypermail not output an index of
# messages with attachments.
attachmentsindex = 1
# 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).
#linkquotes = 0
# searchbackmsgnum = number
#
# If the linkquotes option is on and an incremental update is being# done (-u option), this controls the tradeoff between speed and
# the reliability of finding the right source for quoted text.
# Try to set it to the largest number of messages between a
# message and the final direct reply to that message.
searchbackmsgnum = 500
# link_to_replies = string
#
# If the linkquotes option is on, specifying a string here
# causes it to generate links from original quoted text to the
# location(s) in replies which quote them. The string
# is used to display the link.
#link_to_replies =
# quote_hide_threshold = percentage-number
#
# If the linkquotes option is on, setting this to an
# integer less than 100 will cause it to replace quoted
# text with one-line links if the percent of lines in the
# message body (exluding the signature) consisting of
# quoted text exceeds the number indicated by this option.
#quote_hide_threshold = 100
# quote_link_string = string
#
# If the quote_hide_threshold option is being used, the
# quote_link_string will be used if available to display the
# link that replaces the quoted text. If no string is specified
# here, the first line of each section of quoted text will used.
#quote_link_string =
# monthly_index = [ 0 | 1 ]
#
# Set this to On to create additional index files broken up
# by month. A summary.html file will provide links to all the
# monthly indices.
#monthly_index = Off
# yearly_index = [ 0 | 1 ]
#
# Set this to On to create additional index files broken up
# by year. A summary.html file will provide links to all the
# yearly indices.
#yearly_index = Off
# thread_file_depth = [ 0 | 1 ]
#
# If nonzero, break the threads index file into multiple files,
# with the initial message of each thread in the main index file
# along with links to files containing the replies. Setting this
# to 1 creates one file for each thread that has replies, and is
# recommended for archives with over a few hundred messages.
# Setting this greater than 1 will produce multiple levels of files
# for each thread whose replies are nested by more than 1 level,
# but that is rarely useful. This option is currently disabled
# if the indextable option is turned on, and probably needs to
# be less than thrdlevels.
#thread_file_depth = 0
# 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) 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.
# folder_by_date = %b%y
# 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.
#msgsperfolder = 0
# describe_folder = format string
#
# 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) 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.
#describe_folder =
# 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.
#latest_folder = current
# iso2022jp = [ 0 | 1 ]
#
# Set this to On to support ISO-2022-JP messages.
#iso2022jp = Off
# 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'.
deleted = 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.
expires = Expires
# 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_msgnum =
# 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.
delete_level = 1
# txtsuffix = [ string ]
#
# 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).
#
# txtsuffix =
# show_index_links = [ 0 | 1 | 3 | 4 ]
#
# Set this to 1 to show links to index pages from the top and
# bottom of each message file. Set it to 0 to avoid those links.
# Set it to 3 to show the links only at the top of the message
# pages, or 4 to produce those links only at the bottom of the
# message.
show_index_links = 1
# filter_out
#
# 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_out =
# filter_require
#
# 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_require =
# filter_out_full_body = string
#
# 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_out_full_body =
# filter_require_full_body = string
#
# 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.
#filter_require_full_body =
# 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.
#
#save_alts = 0
# alts_text = descriptive text
#
# 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.
# the default if save_alts = 2:
#alts_text = "alternate version of message"
# the default if save_alts = 1:
#alts_text =
# warn_surpressions = [ 0 | 1 ]
#
# Set this to 1 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.
# warn_surpressions = 1
# unsafe_chars = list of chars to prohibit
# 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.
#unsafe_chars = "."
# files_by_thread = [ 0 | 1 ]
#
# Set this to 1 to generate (in addition to the usual files),
# a file for each thread that contains all the messages in that
# thread. The first line in each thread of the thread index page
# links to this file instead of to a single message.
#files_by_thread = 0
# href_detection = [ 0 | 1 ]
#
# Set this to On to assume that any string on the body of the message
# that says