Palm::Mail(3pm)

📦
version 1.400 · 4 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💌 Palm::Mail — the manual, but make it a group chat

ok so bestie, you found the Palm::Mail(3pm) page, and I'm gonna walk you through it like we're texting at 2am. It's a Perl thing, it's a Palm OS Mail database handler, and honestly? It eats. 💅

✨ NAME ✨

Palm::Mail — a handler for Palm OS Mail databases. yes literally that's the whole name, we love a concise queen. 👑

🌸 VERSION 🌸

This doc describes version 1.400 of Palm::Mail, which was released March 14, 2015 as part of Palm version 1.400. vintage, but iconic. 🎀

🦋 SYNOPSIS 🦋

use Palm::Mail;

that's it. that's the whole vibe. no cap. ✨

💖 DESCRIPTION 💖

The Mail PDB handler is a helper class for the Palm::PDB package — think of it as the bestie that stands behind Palm::PDB and hands it the mail stuff. It parses Mail databases. that's its whole job and it does it flawlessly. 🫶

🌈 AppInfo block

The AppInfo block starts off with standard category support. Peep Palm::StdAppInfo for the deets on that.

Other fields include:

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

and I need you to know: I don't know what these are. 😭 that's not me being cute, the original author says that too. we simply do not know. moving on. 🙈

⭐ Sort block

$pdb->{sort}

This is a scalar — literally just the raw data of the sort block. no thoughts, just bytes. 💀

🎀 Records

$record = $pdb->{records}[N]
$record->{year}
$record->{month}
$record->{day}
$record->{hour}
$record->{minute}

that's the message's timestamp. the when. the moment. ⏰

$record->{is_read}

This one is defined and true iff the message has been read. read receipts but make it Perl.

$record->{has_signature}

For outgoing messages, this is defined and true iff the message should have a signature attached. and bestie, the signature itself is stored in the "Saved Preferences.prc" database, and it's of type "mail" with ID 2. write that down. 📝

$record->{confirm_read}

If this is defined and true, the sender is asking for a notification when the message has been read. yes, they're that person.

$record->{confirm_delivery}

If this is defined and true, the sender requests notification when the message has been delivered. tracking their package fr fr. 📦

$record->{priority}

An integer in the range 0-2, for high, normal, or low priority — respectively, in that order, don't mix it up. 🔥

$record->{addressing}

An integer in the range 0-2, indicating the addressing type: To, Cc, or Bcc respectively. and, once again, the original says "I don't know what this means." 💀 we are simply passing the message along.

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

Strings. the various header fields. the who-what-where of it all. ✨

$record->{body}

A string — the body of the message. the main character of the whole record, honestly. 👑

💅 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. from zero. from the ground up. 🧚

new_Record

$record = $pdb->new_Record;

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

Heads up though — "new_Record" does not add the new record to $pdb. For that, you want "$pdb->append_Record". don't forget this part, I'm begging. 🙏

Note: the time given by the "year", "month", "day", "hour", and "minute" fields in the new record gets initialized to the time when the record was created. You should reset them to the time when the message was actually sent. it's giving "wrong timestamp energy" otherwise. 😭

👀 SEE ALSO 👀

  • Palm::PDB
  • Palm::StdAppInfo

go read those too, they're the supporting cast and they understood the assignment. 💜

⚙️ CONFIGURATION AND ENVIRONMENT ⚙️

Palm::Mail requires no configuration files or environment variables. low maintenance. high value. we love a zero-setup icon. ✨

💀 INCOMPATIBILITIES 💀

None reported. periodt.

🐛 BUGS AND LIMITATIONS 🐛

No bugs have been reported. she's flawless, your honor. 🎀

🫶 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>. go be part of the lore. 🌈

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. slay. 💅

⚠️ DISCLAIMER OF WARRANTY ⚠️

bestie I need you to read this one carefully, it's the serious part, no jokes here, I'm just relaying it exactly:

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

and that's the whole page, bestie!! 🎉 this was perl v5.34.0, dated 2022-06-16, and it's the Palm::Mail(3pm) manual — thanks for reading with me, ily, go parse some mail databases responsibly 💖✨🎀

📦 where this page comes from