1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
=encoding utf8
=head1 NAME
Mail::Message::Convert::Html - Format messages in HTML
=head1 INHERITANCE
Mail::Message::Convert::Html
is a Mail::Message::Convert
is a Mail::Reporter
=head1 SYNOPSIS
use Mail::Message::Convert::Html;
my $Html = Mail::Message::Convert::Html->new;
print $html->fieldToHtml($head);
print $html->headToHtmlHead($head);
print $html->headToHtmlTable($head);
print $html->textToHtml($text);
=head1 DESCRIPTION
The package contains various translators which handle HTML or XHTML
without the help of external modules. There are more HTML related modules,
which do require extra packages to be installed.
Extends L<"DESCRIPTION" in Mail::Message::Convert|Mail::Message::Convert/"DESCRIPTION">.
=head1 METHODS
Extends L<"METHODS" in Mail::Message::Convert|Mail::Message::Convert/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in Mail::Message::Convert|Mail::Message::Convert/"Constructors">.
=over 4
=item $class-E<gt>B<new>(%options)
Inherited, see L<Mail::Reporter/"Constructors">
-Option --Defined in --Default
fields Mail::Message::Convert <see description>
head_mailto true
produce HTML
=over 2
=item fields => $name|$regex|\@names|\@regexes
=item head_mailto => BOOLEAN
Whether to replace e-mail addresses in some header lines with links.
=item produce => 'HTML'|'XHTML'
Produce HTML or XHTML output. The output is slightly different, even
html browsers will usually accept the XHTML data.
=back
=back
=head2 Attributes
Extends L<"Attributes" in Mail::Message::Convert|Mail::Message::Convert/"Attributes">.
=head2 Converting
Extends L<"Converting" in Mail::Message::Convert|Mail::Message::Convert/"Converting">.
=over 4
=item $obj-E<gt>B<fieldContentsToHtml>( $field, [$subject] )
Format one field from the header to HTML. When the header line usually
contains e-mail addresses, the line is scanned and valid addresses
are linked with an C<mailto:> anchor. The C<$subject> can be specified to
be included in that link.
=item $obj-E<gt>B<fieldToHtml>( $field, [$subject] )
Reformat one header line field to HTML. The C<$field>'s name
is printed in bold, followed by the formatted field content,
which is produced by L<fieldContentsToHtml()|Mail::Message::Convert::Html/"Converting">.
=item $obj-E<gt>B<headToHtmlHead>($head, $meta)
Translate the selected header lines (fields) to an html page header. Each
selected field will get its own meta line with the same name as the line.
Furthermore, the C<Subject> field will become the C<title>,
and C<From> is used for the C<Author>.
Besides, you can specify your own meta fields, which will overrule header
fields. Empty fields will not be included. When a C<title> is specified,
this will become the html title, otherwise the C<Subject> field is
taken. In list context, the lines are separately, where in scalar context
the whole text is returned as one.
If you need to add lines to the head (for instance, http-equiv lines), then
splice them before the last element in the returned list.
» example:
my @head = $html->headToHtmlHead(
$head,
description => 'This is a message',
generator => 'Mail::Box',
);
splice @head, -1, 0, '<meta http-equiv=...>';
print @head;
=item $obj-E<gt>B<headToHtmlTable>( $head, [$table_params] )
Produce a display of the L<selectedFields()|Mail::Message::Convert/"Converting"> of the header in a
table shape. The optional C<$table_params> are added as parameters to the
produced TABLE tag. In list context, the separate lines are returned.
In scalar context, everything is returned as one.
» example:
print $html->headToHtmlTable($head, 'width="50%"');
=item $obj-E<gt>B<selectedFields>($head)
Inherited, see L<Mail::Message::Convert/"Converting">
=item $obj-E<gt>B<textToHtml>($lines)
Translate one or more C<$lines> from text into HTML. Each line is taken one
after the other, and only simple things are translated. C<textToHtml>
is able to convert large plain texts in a descent fashion. In scalar
context, the resulting lines are returned as one.
=back
=head2 Error handling
Extends L<"Error handling" in Mail::Message::Convert|Mail::Message::Convert/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
Extends L<"Cleanup" in Mail::Message::Convert|Mail::Message::Convert/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
=over 4
=item Error: class $package does not implement method $method.
Fatal error: the specific C<$package> (or one of its superclasses) does not
implement this method where it should. This message means that some other
related classes do implement this method however the class at hand does
not. Probably you should investigate this and probably inform the author
of the package.
Cast by C<notImplemented()>
=item Error: produce XHTML or HTML, not $what.
Cast by C<new()>
=back
=head1 SEE ALSO
This module is part of Mail-Message version 4.02,
built on January 22, 2026. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
For contributors see file ChangeLog.
This software is copyright (c) 2001-2026 by Mark Overmeer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
