See METHODS in Mail::Reporter
Create an attachment file, and return a hash with information about
that file. Returns undef
if creation fails.
This method is used by htmlAttach() and htmlPreview() to create
an actual attachment file. It defines url
, size
and type
tags for the template.
Option | Default |
---|---|
outdir | <required> |
Returns a string, which is either inline
, attach
, or preview
,
which indicates how the part of the message should be formatted.
This can be changed with setting disposition
.
Returns the field text producing object.
Returns the header text producting object.
Produce data about addresses which are in the field. This method uses HTML::FromMail::Field::htmlAddresses() for that.
The attach
container defines url
, size
and type
tags for the template.
<!--{message}--> <!--{attach}--> <!--{/attach}--> <!--{/message}-->
Produce the body of a field. This tag can only be used inside a field container. See HTML::FromMail::Field::htmlBody() for the use and options.
Returns the field definition for the currently active message part. When the formatter sees this is a final token, then only the body of the field is returned (and the options of HTML::FromMail::Field::htmlBody() are accepted as well). Otherwise, the information about the field is captured to be used later.
Option | Default |
---|---|
decode | <true> if possible |
from | PART |
name | <required> |
<!--{field name => To, content => REFOLD, wrap => 20}--> <!--{field name => To}--> <!--{name capitals => WELLFORMED}--> <!--{body wrap => 30}--> <!--{/field}-->
Produces html for the parts of a multipart mesasge body. Each part
may be a multipart too. For each part, the message
container
code is applied recursively.
This container defines a part_number
, and enables the use of the
part
tag.
<!--{message}--> <!--{multipart}--> <ul> <!--{foreachPart}--> <li>This is part <!--{part_number}--> <!--{part}--> </li> <!--{/foreachPart}--> </ul> <!--{/multipart}--> <!--{message}-->
Defines the fields of a header. The options are provided by HTML::FromMail::Head::fields().
# simple <pre><!--{head}--></pre> # complex <table> <!--{head remove_spam_groups => 0}--> <tr><td><!--{name}--></td> <td><!--{body}--></td></tr> <!--{/head}--> </table>
Option | Default |
---|---|
type | '' |
<!--{message}--> <!--{inline type => text/html}--> <!--{html}--> <!--{/inline}--> <!--{/message}-->
Encapsulated code which is producing the message, which may be a multipart. You have to defined the message block when you use the part (see htmlPart()) tag. If you do not use that, you do not need this.
<!--{message}--> <!--{inline}-->This is an inlined singlepart<!--{/inline}--> <!--{attach}-->This is an attachment<!--{/attach}--> <!--{preview}-->An attachment with preview<!--{/preview}--> <!--{multipart}-->This is a multipart<!--{/multipart}--> <!--{nested}-->message/rfc822 encapsulated<!--{/nested}--> <!--{/message}-->
Encapsulates text to be produced when the message(-part) is a multipart.
Produce the name of a field. This tag can only be used inside a field container. See HTML::FromMail::Field::htmlName() for the use and options.
Contains text to be produced when the message(-part) is a nested message; encapsulated in a message/rfc822.
Apply the message
container of the current part on its data. See example
in htmlForeachPart().
Option | Default |
---|---|
type | '' |
<!--{message}--> <!--{preview}--> <!--{html}--> <!--{text}--> <!--{/html}--> <!--{image}--> <img src="<!--{smallurl}-->" width="<!--{smallwidth}-->" height="<!--{smallheight}-->"><br /> (real is <!--{width}--> x <!--{height}-->) <!--{/image}--> <a href="<!--{url}-->">Attachment of <!--{type}--> (<!--{size}--> bytes)</a> <!--{/preview}--> <!--{/message}-->
Returns the plain text of the body.
Get the subject field from the message's header, just a short-cut
for specifying htmlField(name) with subject
.
<!--{subject}--> # message subject <!--{field name => subject}--> # part's subject <!--{field name => subject, from => MESSAGE}--> # message subject
Returns the code reference for a routine which can create html
for the objects of the specified MIME-TYPE. The TYPE may be a (smartly
overloaded) MIME::Type object. The behaviour can be changed with
the htmlifiers
setting.
Returns the code reference for a routine which can create a preview
for the objects of the specified MIME-TYPE. The TYPE may be a (smartly
overloaded) MIME::Type object. The behaviour can be changed with
the previewers
setting.
Option | Defined in | Default |
---|---|---|
log | Mail::Reporter |
|
settings | HTML::FromMail::Object | {} |
topic | HTML::FromMail::Object |
|
trace | Mail::Reporter |
|