NAME

mha-preview - MHonArc front-end to support message preview variable

SYNOPSIS

mha-preview [options] [arguments]

DESCRIPTION

mha-preview is an example program the utilizes MHonArc's callback API to support the special resource variable $X-MSG-PREVIEW$. The $X-MSG-PREVIEW$ represents the initial text of a message body. With this variable, index pages can contain be customized to give a listing like some MUAs that provide a glimpse of the message body in the mail listing of a mail folder.

When extracting the preview text of the message body, all HTML tags are removed and whitespace is compressed.

CAUTION: If mha-preview is used for an archive, it should always be used to process the archive. Otherwise, the message preview data will be lost.

OPTIONS

mha-preview takes the same options available to mhonarc along with the following additional options:

-help

Print a usage summary of this program (this option overrides mhonarc's -help option).

-man

Print the manpage for this program.

-prv-maxlen

Maximum amount of characters of the message body to store for each message. The default value is 256.

NOTES

• The functionality of this program could be placed into the mhasiteinit.pl library to avoid the need for this program and to make it part of the locally installed mhonarc. This would avoid the problem noted in the CAUTION mentioned in the DESCRIPTION section.
• The body preview resource variable may be worth putting into the MHonArc code base directly.

SEE ALSO

mhonarc(1)

LICENSE

mha-preview comes with ABSOLUTELY NO WARRANTY and can be distributed under the same terms as MHonArc itself.

AUTHOR

Earl Hood, earl@earlhood.com