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-MailMessage-0.02
/ MMS::MailMessage

NAME

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

VERSION

Version 0.02

SYNOPSIS

This class is used by MMS::MailParser to provide an itermediate data storage class after the MMS has been parsed but before it has been through the second stage of parsing (the provider parser).

METHODS

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

Constructor

new()

Return a new MMS::MailMessage object.

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.

header_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.

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.

Deprecated Methods

Methods listed here are maintained for backwards compatibility and should not be used in new code as they may be removed in future versions.

headerdatetime

Equivalent to header_datetime

headerfrom

Equivalent to header_from

headerto

Equivalent to header_to

headersubject

Equivalent to header_subject

headertext

Equivalent to header_text

addattachment

Equivalent to add_attachment

isvalid

Equivalent to is_valid

AUTHOR

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

BUGS

Please report any bugs or feature requests to bug-mms-mailmessage@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MMS-MailMessage. 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.