.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Palm::Mail 3pm" .TH Palm::Mail 3pm "2016-04-23" "perl v5.22.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Palm::Mail \- Handler for Palm OS Mail databases .SH "VERSION" .IX Header "VERSION" This document describes version 1.400 of Palm::Mail, released March 14, 2015 as part of Palm version 1.400. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Palm::Mail; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Mail \s-1PDB\s0 handler is a helper class for the Palm::PDB package. It parses Mail databases. .SS "AppInfo block" .IX Subsection "AppInfo block" The AppInfo block begins with standard category support. See Palm::StdAppInfo for details. .PP Other fields include: .PP .Vb 3 \& $pdb\->{appinfo}{sortOrder} \& $pdb\->{appinfo}{unsent} \& $pdb\->{appinfo}{sigOffset} .Ve .PP I don't know what these are. .SS "Sort block" .IX Subsection "Sort block" .Vb 1 \& $pdb\->{sort} .Ve .PP This is a scalar, the raw data of the sort block. .SS "Records" .IX Subsection "Records" .Vb 1 \& $record = $pdb\->{records}[N] \& \& $record\->{year} \& $record\->{month} \& $record\->{day} \& $record\->{hour} \& $record\->{minute} .Ve .PP The message's timestamp. .PP .Vb 1 \& $record\->{is_read} .Ve .PP This is defined and true iff the message has been read. .PP .Vb 1 \& $record\->{has_signature} .Ve .PP For outgoing messages, this is defined and true iff the message should have a signature attached. The signature itself is stored in the \&\*(L"Saved Preferences.prc\*(R" database, and is of type \*(L"mail\*(R" with \s-1ID 2.\s0 .PP .Vb 1 \& $record\->{confirm_read} .Ve .PP If this is defined and true, then the sender requests notification when the message has been read. .PP .Vb 1 \& $record\->{confirm_delivery} .Ve .PP If this is defined and true, then the sender requests notification when the message has been delivered. .PP .Vb 1 \& $record\->{priority} .Ve .PP An integer in the range 0\-2, for high, normal, or low priority, respectively. .PP .Vb 1 \& $record\->{addressing} .Ve .PP An integer in the range 0\-2, indicating the addressing type: To, Cc, or Bcc respectively. I don't know what this means. .PP .Vb 7 \& $record\->{subject} \& $record\->{from} \& $record\->{to} \& $record\->{cc} \& $record\->{bcc} \& $record\->{replyTo} \& $record\->{sentTo} .Ve .PP Strings, the various header fields. .PP .Vb 1 \& $record\->{body} .Ve .PP A string, the body of the message. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" .Vb 1 \& $pdb = new Palm::Mail; .Ve .PP Create a new \s-1PDB,\s0 initialized with the various Palm::Mail fields and an empty record list. .PP Use this method if you're creating a Mail \s-1PDB\s0 from scratch. .SS "new_Record" .IX Subsection "new_Record" .Vb 1 \& $record = $pdb\->new_Record; .Ve .PP Creates a new Mail record, with blank values for all of the fields. .PP \&\f(CW\*(C`new_Record\*(C'\fR does \fBnot\fR add the new record to \f(CW$pdb\fR. For that, you want \f(CW\*(C`$pdb\->append_Record\*(C'\fR. .PP Note: the time given by the \f(CW\*(C`year\*(C'\fR, \f(CW\*(C`month\*(C'\fR, \f(CW\*(C`day\*(C'\fR, \f(CW\*(C`hour\*(C'\fR, and \&\f(CW\*(C`minute\*(C'\fR 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. .SH "SEE ALSO" .IX Header "SEE ALSO" Palm::PDB .PP Palm::StdAppInfo .SH "CONFIGURATION AND ENVIRONMENT" .IX Header "CONFIGURATION AND ENVIRONMENT" Palm::Mail requires no configuration files or environment variables. .SH "INCOMPATIBILITIES" .IX Header "INCOMPATIBILITIES" None reported. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .SH "AUTHORS" .IX Header "AUTHORS" Andrew Arensburger \f(CW\*(C`\*(C'\fR .PP Currently maintained by Christopher J. Madsen \f(CW\*(C`\*(C'\fR .PP Please report any bugs or feature requests to \f(CW\*(C`\*(C'\fR or through the web interface at . .PP You can follow or contribute to p5\-Palm's development at . .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2003 by Andrew Arensburger & Alessandro Zummo. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" \&\s-1BECAUSE 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 \*(L"AS IS\*(R" 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.\s0 .PP \&\s-1IN 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 \s0(\s-1INCLUDING 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\s0), \s-1EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\s0