.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Palm::Mail 3pm"
.TH Palm::Mail 3pm "2013-08-21" "perl v5.18.2" "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 Mail databases.
.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 "SOURCE CONTROL"
.IX Header "SOURCE CONTROL"
The source is in Github:
.PP
.Vb 1
\&        http://github.com/briandfoy/p5\-Palm/tree/master
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Alessandro Zummo, \f(CW\*(C`<a.zummo@towertech.it>\*(C'\fR
.PP
Currently maintained by brian d foy, \f(CW\*(C`<bdfoy@cpan.org>\*(C'\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIPalm::PDB\fR\|(3)
.PP
\&\fIPalm::StdAppInfo\fR\|(3)