Palm::Mail

Palm::Mail(3)         User Contributed Perl Documentation        Palm::Mail(3)



NAME
       Palm::Mail - Handler for Palm OS Mail databases

VERSION
       This document describes version 1.400 of Palm::Mail, released March 14,
       2015 as part of Palm version 1.400.

SYNOPSIS
           use Palm::Mail;

DESCRIPTION
       The Mail PDB handler is a helper class for the Palm::PDB package. It
       parses Mail databases.

   AppInfo block
       The AppInfo block begins with standard category support. See
       Palm::StdAppInfo for details.

       Other fields include:

           $pdb->{appinfo}{sortOrder}
           $pdb->{appinfo}{unsent}
           $pdb->{appinfo}{sigOffset}

       I don't know what these are.

   Sort block
           $pdb->{sort}

       This is a scalar, the raw data of the sort block.

   Records
           $record = $pdb->{records}[N]

           $record->{year}
           $record->{month}
           $record->{day}
           $record->{hour}
           $record->{minute}

       The message's timestamp.

           $record->{is_read}

       This is defined and true iff the message has been read.

           $record->{has_signature}

       For outgoing messages, this is defined and true iff the message should
       have a signature attached. The signature itself is stored in the "Saved
       Preferences.prc" database, and is of type "mail" with ID 2.

           $record->{confirm_read}

       If this is defined and true, then the sender requests notification when
       the message has been read.

           $record->{confirm_delivery}

       If this is defined and true, then the sender requests notification when
       the message has been delivered.

           $record->{priority}

       An integer in the range 0-2, for high, normal, or low priority,
       respectively.

           $record->{addressing}

       An integer in the range 0-2, indicating the addressing type: To, Cc, or
       Bcc respectively. I don't know what this means.

           $record->{subject}
           $record->{from}
           $record->{to}
           $record->{cc}
           $record->{bcc}
           $record->{replyTo}
           $record->{sentTo}

       Strings, the various header fields.

           $record->{body}

       A string, the body of the message.

METHODS
   new
         $pdb = new Palm::Mail;

       Create a new PDB, initialized with the various Palm::Mail fields and an
       empty record list.

       Use this method if you're creating a Mail PDB from scratch.

   new_Record
         $record = $pdb->new_Record;

       Creates a new Mail record, with blank values for all of the fields.

       "new_Record" does not add the new record to $pdb. For that, you want
       "$pdb->append_Record".

       Note: the time given by the "year", "month", "day", "hour", and
       "minute" fields in the new record are initialized to the time when the
       record was created. They should be reset to the time when the message
       was sent.

SEE ALSO
       Palm::PDB

       Palm::StdAppInfo

CONFIGURATION AND ENVIRONMENT
       Palm::Mail requires no configuration files or environment variables.

INCOMPATIBILITIES
       None reported.

BUGS AND LIMITATIONS
       No bugs have been reported.

AUTHORS
       Andrew Arensburger "<arensb AT ooblick.com>"

       Currently maintained by Christopher J. Madsen "<perl AT cjmweb.net>"

       Please report any bugs or feature requests to
       "<bug-Palm AT rt.cpan.org>" or through the web interface at
       <http://rt.cpan.org/Public/Bug/Report.html?Queue=Palm>.

       You can follow or contribute to p5-Palm's development at
       <https://github.com/madsen/p5-Palm>.

COPYRIGHT AND LICENSE
       This software is copyright (c) 2003 by Andrew Arensburger & Alessandro
       Zummo.

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

DISCLAIMER OF WARRANTY
       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
       FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
       YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
       NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.



perl v5.28.1                      2015-03-14                     Palm::Mail(3)