Mail::SpamAssassin::Message::Node
Mail::SpamAssassin::Message::Node
NAMESYNOPSIS
DESCRIPTION
PUBLIC METHODS
NAME
Mail::SpamAssassin::Message::Node − decode, render, and make available MIME message parts
SYNOPSIS
DESCRIPTION
This module will encapsulate an email message and allow access to the various MIME message parts.
PUBLIC METHODS
new()
Generates an empty Node object and returns it. Typically only called by functions in Message.
find_parts()
Used to search the tree for specific MIME parts. An array of matching Node objects (pointers into the tree) is returned. The parameters that can be passed in are (in order, all scalars):
Regexp − Used to match against each part’s Content-Type header, specifically the type and not the rest of the header. ie: "Content-type: text/html; encoding=quoted−printable" has a type of "text/html". If no regexp is specified, find_parts() will return an empty array.
Only_leaves − By default, find_parts() will return any part that matches the regexp, including multipart. If you only want to see leaves of the tree (ie: parts that aren’t multipart), set this to true (1).
Recursive − By default, when find_parts() finds a multipart which has parts underneath it, it will recurse through all sub-children. If set to 0, only look at the part and any direct children of the part.
header()
Stores and retrieves headers from a specific MIME part. The first parameter is the header name. If there is no other parameter, the header is retrieved. If there is a second parameter, the header is stored.
Header names are case-insensitive and are stored in both raw and decoded form. Using header(), only the decoded form is retrievable.
For retrieval, if header() is called in an array context, an array will be returned with each header entry in a different element. In a scalar context, the last specific header is returned.
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.
raw_header()
Retrieves the raw version of headers from a specific MIME part. The only parameter is the header name. Header names are case-insensitive.
For retrieval, if raw_header() is called in an array context, an array will be returned with each header entry in a different element. In a scalar context, the last specific header is returned.
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.
add_body_part()
Adds a Node child object to the current node object.
is_leaf()
Returns true if the tree node in question is a leaf of the tree (ie: has no children of its own). Note: This function may return odd results unless the message has been mime parsed via _do_parse()!
raw()
Return a reference to the the raw array. Treat this as READ ONLY .
decode()
If necessary, decode the part text as base64 or quoted-printable. The decoded text will be returned as a scalar string. An optional length parameter can be passed in which limits how much decoded data is returned. If the scalar isn’t needed, call with "0" as a parameter.
rendered()
render_text() takes the given text/* type MIME part, and attempts to render it into a text scalar. It will always render text/html, and will use a heuristic to determine if other text/* parts should be considered text/html. Two scalars are returned: the rendered type (either text/html or whatever the original type was), and the rendered text.
set_rendered($text, $type)
Set the rendered text and type for the given part. If type is not specified, and text is a defined value, a default of ’text/plain’ is used. This can be used, for instance, to render non-text parts using plugins.
visible_rendered()
Render and return the visible text in this part.
invisible_rendered()
Render and return the invisible text in this part.
content_summary()
Returns an array of scalars describing the mime parts of the message. Note: This function requires that the message be parsed first!
delete_header()
Delete the specified header (decoded and raw) from the Node information.
get_header()
Retrieve a specific header. Will have a newline at the end and will be unfolded. The first parameter is the header name (case-insensitive), and the second parameter (optional) is whether or not to return the raw header.
If get_header() is called in an array context, an array will be returned with each header entry in a different element. In a scalar context, the last specific header is returned.
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.
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.
get_all_headers()
Retrieve all headers. Each header will have a newline at the end and will be unfolded. The first parameter (optional) is whether or not to return the raw headers, and the second parameter (optional) is whether or not to include the mbox separator.
If get_all_header() is called in an array context, an array will be returned with each header entry in a different element. In a scalar context, the headers are returned in a single scalar.
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
