Hypermail List Configuration File


The hypermail list configuration file is used to specify list specific information to hypermail. Comments are denoted by the '#' character at the begining of the line.

Sample Hypermail List Specific Configuration File

# 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 ]
# 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.
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

# htmlsuffix = [ html | htm | shtml ... ]
#
# 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.
#
htmlsuffix = shtml

# language = two-letter-language-id ]
#
# 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.
#
# Current supported languages:
#
# de - German
# en - English
# es - Spanish
# fi - Finnish
# fr - French
# is - Icelandic
# se - Swedish
#
# uselock [ 0 | 1 ]
#
# 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.

uselock = 0

# locktime = number-of-seconds
#
# The number of seconds that a lock should be honored when processing
# inbound messages before it is overridden.

locktime = 3600

# usemeta [ 0 | 1 ]
#
# This option allows you to use metadata to store the content type
# of a MIME attachments 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 metadata.
#
usemeta = 0

# archives = [ URL | NONE ]
#
# This creates a link in the archived index pages labeled
# "Other mail archives". Set this to NONE to omit such a link.
#
archives = NONE

# custom_archives = [ HTML 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 = NONE

# 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 ]
#
# This indicates the default type of main index hypermail will generate.
# Users see this type of index when the archive is first accessed.
#
defaultindex = thread

# 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
# a message index Subject/Author/Date listings using a table
# format. Set to 0 if you want the standard Hypermail index
# page look and feel.
#
indextable = 0

# progress = [ 0 | 1 | 2 ]
#
# Set to 1 or 2 to show progress as Hypermail works. Set to 0 for silent
# operation. Output goes to standard output.
# Set to 1, progress information relating to attachments creation is
# overwritten for each new attachment. Set to 2, attachment creation
# information is listed individually with the number of the message
# the attachments relates to.
#
progress = 0

# 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"

# show_msg_links = [ 0 | 1 ]
#
# 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.
#
show_msg_links = 1

# showheaders = [ 0 | 1 ]
#
# Set this to 1 to show the RFC 822 message headers To:,
# From:, and Subject: information found in the 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 ]
#
# Set this to 1 to show the articles in a proportionally-spaced
# font rather than a fixed-width (monospace) font. Setting this
# option to 1 also tells Hypermail to attempt to italicize quoted
# passages in articles.
#
showhtml = 0

# showbr = [ 0 | 1 ]
#
# Set this to 1 if you want article lines to end with the <br> 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 <HR> before and after
# the articles. Set to 0 if you don't.
#
showhr = 1

# overwrite = [ 0 | 1 ]
#
# Set to 1 to make Hypermail overwrite existing archives by default.
#
overwrite = 0

# readone = [ 0 | 1 ]
#
# Set this to 1 to specify there is only one message in the input.
#
readone = 0

# increment = [ 0 | 1 ]
#
# Define as 1 to read in one article only and update existing archives.
# Define as 0 for it to read and process entire mailboxes.
#
increment = 0

# discard_dup_msgids = [ 0 | 1 ]
#
# 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.
#
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

# dateformat = strftime-date-format
#
# Format used in strftime(3) call for displaying dates.
# See strftime(3) for the valid conversion specifications.
dateformat = "%D-%r Z"

# stripsubject = [ string | NONE ]
# A string to be stripped from all subject lines. Helps
# unclutter mailing lists which add tags to subject
# lines.
stripsubject = NONE

# 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 2.

thrdlevels = 2

# 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

# dirmode = octal number
#
# This is an octal number representing the 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 permission modes 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

# mailto = [ email-address | NONE ]
#
# The address of the contact point that is put in the HTML header line
# <LINK REV=made HREF=mailto:mailto>
#
# The <LINK...> header can be disabled by default by setting
# mailto to NONE.
#
mailto = webmaster@landfield.com

# 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 = landfield.com

# ihtmlheaderfile = [ path to index header template file | NONE ]
#
# Set this to the path to the Index header template file. The template
# file contains HTML directives and substitution cookies for runtime
# expansion.
#
ihtmlheaderfile = /lists/hypermail-idxheader.hyp

# ihtmlfooterfile = [ path to index footer template file | NONE ]
#
# Set this to the path to the Index footer template file. The template
# file contains HTML directives and substitution cookies for runtime
# expansion.
#
ihtmlfooterfile = /lists/hypermail-idxfooter.hyp

# mhtmlheaderfile = [ path to message header template file | NONE ]
#
# Set this to the path to the Message header template file. The template
# file contains HTML directives and substitution cookies for runtime
# expansion.
#
mhtmlheaderfile = /lists/hypermail-msgheader.hyp

# mhtmlfooterfile = [ path to message footer template file | NONE ]
#
# Set this to the path to the Message footer template file. The template
# file contains HTML directives and substitution cookies for runtime
# expansion.
#
mhtmlfooterfile = /lists/hypermail-msgfooter.hyp

# 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@landfield.com

# body = [ HTML <BODY> statement | NONE ]
#
# Set this to the <BODY> line to use when generating the HTML pages.
# Set to "NONE" to use the builtin <BODY> line by default.
#
body = <BODY BGCOLOR="#FFFFFF" TEXT="#000000">

######################
# Multiline variables
######################

# show_headers = List of RFC 822 Headers to display
#
# This is the list of headers to be displayed if showheaders
# is set to 1 (TRUE) They can be listed comman 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
#
# If show_headers contains the special character ``*'', then
# hypermail will display all header lines.
#
# NOTE: Do not put the ':' at the end of the headers.
#
show_headers = From,Subject,Date,Message-ID

# inline_types = indicate data types data to be inlined
#
# This is the list of MIME types that you want inlined as opposed to
# simply linked into the message. 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

# ignore_types = indicate types of attachments to ignore
#
# This is the list of MIME attachment types that you do not want to
# do anything with. They are quietly ignored and are not processed.
# 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

# text_types = list of types to be the same as text/plain
#
# This is a list of MIME types that you want hypermail to treat
# exactly as if they were text/plain. They can be listed individually
# on multiple lines or comma or space separated on a single line.
#
text_types = text, text/plain, message/rfc822

# prefered_types = multipart/mixed types to present
#
# When mails using multipart/mixed types are scanned, this list of
# MIME types defines which part you want presented in the result.
#
prefered_types = text/plain, text/html


See Also
hypermail(1),   hmrc(4),   Hypermail   and   Customizing Hypermail Pages

Last updated October 8, 1999