Palm::Mail (3)

Leading comments

Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Palm::Mail.3pm".)

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

    $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

initialized with the various Palm::Mail fields and an empty record list.

Use this method if you're creating a Mail

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 <rt.cpan.org/Public/Bug/Report.html?Queue=Palm>.

You can follow or contribute to p5-Palm's development at <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

(),