---
name: "Mail"
section: "3pm"
platform: "linux"
package: "libpalm-perl"
version: "1:1.012-1"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/Mail/3pm"
---

# Mail(3pm)

Handler for Palm Mail databases.

## NAME

Palm::Mail - Handler for Palm Mail databases.

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

## SOURCE CONTROL

The source is in Github:

```
        http://github.com/briandfoy/p5-Palm/tree/master
```

## AUTHOR

Alessandro Zummo, `"<a.zummo@towertech.it>"`

Currently maintained by brian d foy, `"<bdfoy@cpan.org>"`

## SEE ALSO

*Palm::PDB*(3)

*Palm::StdAppInfo*(3)
