The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
MMS-Mail-Message-0.02
River stage one • 2 direct dependents • 9 total dependents
/ MMS::Mail::Message

NAME

MMS::Mail::Message - A class representing an MMS (or picture) message.

VERSION

Version 0.02

SYNOPSIS

This class is used by MMS::Mail::Parser to provide an itermediate data storage class after the MMS has been parsed by the parse method but before it has been through the second stage of parsing (the provider_parse method).

METHODS

The following are the top-level methods of the MMS::Mail::Message class.

Constructor

new()

Return a new MMS::Mail::Message object. Valid attributes are:

strip_characters STRING

Passed as an array reference, strip_characters defines the characters used by the header_from, header_to, header_datetime, body_text and header_subject methods to remove from their respective properties (in both the MMS::Mail::Message and MMS::Mail::Message::Parsed classes).

Regular Methods

header_datetime STRING

Returns the time and date the MMS was sent (?) when invoked with no supplied parameter. When supplied with a parameter it sets the object property to the supplied parameter.

header_from STRING

Returns the sending email address the MMS was sent from when invoked with no supplied parameter. When supplied with a parameter it sets the object property to the supplied parameter.

header_to STRING

Returns the recieving email address the MMS was sent to when invoked with no supplied parameter. When supplied with a parameter it sets the object property to the supplied parameter.

header_subject STRING

Returns the MMS subject when invoked with no supplied parameter. When supplied with a parameter it sets the object property to the supplied parameter.

body_text STRING

Returns the MMS bodytext when invoked with no supplied parameter. When supplied with a paramater it sets the object property to the supplied parameter.

strip_characters STRING

The supplied string should be a set of characters valid for use in a regular expression character class. When set with a value the property is used by the header_from, header_to, header_datetime, body_text and header_subject methods to remove these characters from their respective properties (in both the MMS::Mail::Message and MMS::Mail::Message::Parsed classes).

attachments ARRAYREF

Returns an array reference to the array of MMS message attachments. When supplied with a parameter it sets the object property to the supplied parameter.

add_attachment MIME::Entity

Adds the supplied MIME::Entity attachment to the attachment stack for the message. This method is mainly used by the MMS::MailParser class to add attatchments while parsing.

is_valid

Returns true or false depending if the header_datetime, header_from and header_to fields are all populated or not.

AUTHOR

Rob Lee, <robl@robl.co.uk>

BUGS

Please report any bugs or feature requests to bug-mms-mail-message@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MMS-Mail-Message. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

NOTES

To quote the perl artistic license ('perldoc perlartistic') :

10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

ACKNOWLEDGEMENTS

As per usual this module is sprinkled with a little Deb magic.

COPYRIGHT & LICENSE

Copyright 2005 Rob Lee, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

MMS::Mail::Message, MMS::Mail::Message::Parsed, MMS::Mail::Provider, MMS::Mail::Provider