.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::SpamAssassin::Message 3"
.TH Mail::SpamAssassin::Message 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mail::SpamAssassin::Message \- decode, render, and hold an RFC\-2822 message
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module encapsulates an email message and allows access to the various MIME
message parts and message metadata.
.PP
The message structure, after initiating a \fBparse()\fR cycle, looks like this:
.PP
.Vb 7
\&  Message object, also top\-level node in Message::Node tree
\&     |
\&     +\-\-\-> Message::Node for other parts in MIME structure
\&     |       |\-\-\-> [ more Message::Node parts ... ]
\&     |       [ others ... ]
\&     |
\&     +\-\-\-> Message::Metadata object to hold metadata
.Ve
.SH "PUBLIC METHODS"
.IX Header "PUBLIC METHODS"
.IP \fBnew()\fR 4
.IX Item "new()"
Creates a Mail::SpamAssassin::Message object.  Takes a hash reference
as a parameter.  The used hash key/value pairs are as follows:
.Sp
\&\f(CW\*(C`message\*(C'\fR is either undef (which will use STDIN), a scalar \- a string
containing an entire message, a reference to such string, an array reference
of the message with one line per array element, or either a file glob
or an IO::File object which holds the entire contents of the message.
.Sp
Note: The message is expected to generally be in RFC 2822 format, optionally
including an mbox message separator line (the "From " line) as the first line.
.Sp
\&\f(CW\*(C`parse_now\*(C'\fR specifies whether or not to create the MIME tree
at object-creation time or later as necessary.
.Sp
The \fIparse_now\fR option, by default, is set to false (0).
This allows SpamAssassin to not have to generate the tree of
Mail::SpamAssassin::Message::Node objects and their related data if the
tree is not going to be used.  This is handy, for instance, when running
\&\f(CW\*(C`spamassassin \-d\*(C'\fR, which only needs the pristine header and body which
is always handled when the object is created.
.Sp
\&\f(CW\*(C`subparse\*(C'\fR specifies how many MIME recursion levels should be parsed.
Defaults to 20.
.IP \fBfind_parts()\fR 4
.IX Item "find_parts()"
Used to search the tree for specific MIME parts.  See
\&\fIMail::SpamAssassin::Message::Node\fR for more details.
.IP \fBget_pristine_header()\fR 4
.IX Item "get_pristine_header()"
Returns pristine headers of the message.  If no specific header name
is given as a parameter (case-insensitive), then all headers will be
returned as a scalar, including the blank line at the end of the headers.
.Sp
If called in an array context, an array will be returned with each
specific header in a different element.  In a scalar context, the last
specific header is returned.
.Sp
ie: If 'Subject' is specified as the header, and there are 2 Subject
headers in a message, the last/bottom one in the message is returned in
scalar context or both are returned in array context.
.Sp
Btw, returning the last header field (not the first) happens to be consistent
with DKIM signatures, which search for and cover multiple header fields
bottom-up according to the 'h' tag. Let's keep it this way.
.Sp
Note: the returned header will include the ending newline and any embedded
whitespace folding.
.IP \fBget_mbox_separator()\fR 4
.IX Item "get_mbox_separator()"
Returns the mbox separator found in the message, or undef if there
wasn't one.
.IP \fBget_body()\fR 4
.IX Item "get_body()"
Returns an array of the pristine message body, one line per array element.
.IP \fBget_pristine()\fR 4
.IX Item "get_pristine()"
Returns a scalar of the entire pristine message.
.IP \fBget_pristine_body()\fR 4
.IX Item "get_pristine_body()"
Returns a scalar of the pristine message body.
.IP \fBget_pristine_body_digest()\fR 4
.IX Item "get_pristine_body_digest()"
Returns SHA1 hex digest of the pristine message body.
CRLF line endings are normalized to LF before hashing.
.IP \fBget_msgid()\fR 4
.IX Item "get_msgid()"
Returns Message-ID header for the message, with <> and surrounding
whitespace removed. Returns undef, if nothing found between <>.
.IP \fBgenerate_msgid()\fR 4
.IX Item "generate_msgid()"
Generate a calculated "Message-ID" in \fBsha1hex@sa_generated\fR format, using
To, Date headers and pristine body as source for hashing.
.IP extract_message_metadata($permsgstatus) 4
.IX Item "extract_message_metadata($permsgstatus)"
.PD 0
.ie n .IP "$str = get_metadata($hdr)" 4
.el .IP "\f(CW$str\fR = get_metadata($hdr)" 4
.IX Item "$str = get_metadata($hdr)"
.ie n .IP "put_metadata($hdr, $text)" 4
.el .IP "put_metadata($hdr, \f(CW$text\fR)" 4
.IX Item "put_metadata($hdr, $text)"
.IP delete_metadata($hdr) 4
.IX Item "delete_metadata($hdr)"
.ie n .IP "$str = \fBget_all_metadata()\fR" 4
.el .IP "\f(CW$str\fR = \fBget_all_metadata()\fR" 4
.IX Item "$str = get_all_metadata()"
.IP \fBfinish_metadata()\fR 4
.IX Item "finish_metadata()"
.PD
Destroys the metadata for this message.  Once a message has been
scanned fully, the metadata is no longer required.   Destroying
this will free up some memory.
.IP \fBfinish()\fR 4
.IX Item "finish()"
Clean up an object so that it can be destroyed.
.IP \fBreceive_date()\fR 4
.IX Item "receive_date()"
Return a time_t value with the received date of the current message,
or current time if received time couldn't be determined.
.SH "PARSING METHODS, NON-PUBLIC"
.IX Header "PARSING METHODS, NON-PUBLIC"
These methods take a RFC2822\-esque formatted message and create a tree
with all of the MIME body parts included.  Those parts will be decoded
as necessary, and text/html parts will be rendered into a standard text
format, suitable for use in SpamAssassin.
.IP \fBparse_body()\fR 4
.IX Item "parse_body()"
\&\fBparse_body()\fR passes the body part that was passed in onto the
correct part parser, either \fB_parse_multipart()\fR for multipart/* parts,
or \fB_parse_normal()\fR for everything else.  Multipart sections become the
root of sub-trees, while everything else becomes a leaf in the tree.
.Sp
For multipart messages, the first call to \fBparse_body()\fR doesn't create a
new sub-tree and just uses the parent node to contain children.  All other
calls to \fBparse_body()\fR will cause a new sub-tree root to be created and
children will exist underneath that root.  (this is just so the tree
doesn't have a root node which points at the actual root node ...)
.IP \fB_parse_multipart()\fR 4
.IX Item "_parse_multipart()"
Generate a root node, and for each child part call \fBparse_body()\fR
to generate the tree.
.IP \fB_parse_normal()\fR 4
.IX Item "_parse_normal()"
Generate a leaf node and add it to the parent.