.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Mail::Box::Tie 3"
.TH Mail::Box::Tie 3 2026-04-11 "perl v5.42.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
Mail::Box::Tie \- access an existing message\-folder as an array or hash
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 3
\& Mail::Box::Tie is extended by
\&   Mail::Box::Tie::ARRAY
\&   Mail::Box::Tie::HASH
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
As an array:
.PP
.Vb 2
\&  tie my(@inbox), Mail::Box::Tie::ARRAY => $folder;
\&  print $inbox[3];
.Ve
.PP
or as hash:
.PP
.Vb 2
\&  tie my(%inbox), Mail::Box::Tie::HASH => $folder;
\&  print $inbox{\*(Aq<12379.124879@example.com>\*(Aq};
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Folders certainly look like an array of messages, so why not just
access them as one?  Or, the order is not important, but the
message\-ids are (give relations): why not access them from a hash
based on this message\-id?  Programs using one of these ties will
look simpler than programs using the more traditional method calls.
.SH METHODS
.IX Header "METHODS"
.SS Constructors
.IX Subsection "Constructors"
.ie n .IP "$class\->\fBnew\fR($folder, $type)" 4
.el .IP "\f(CW$class\fR\->\fBnew\fR($folder, \f(CW$type\fR)" 4
.IX Item "$class->new($folder, $type)"
Do not call this method directly, but via the tie interface.
.SS Attributes
.IX Subsection "Attributes"
.ie n .IP $obj\->\fBfolder\fR() 4
.el .IP \f(CW$obj\fR\->\fBfolder\fR() 4
.IX Item "$obj->folder()"

.ie n .IP $obj\->\fBtype\fR() 4
.el .IP \f(CW$obj\fR\->\fBtype\fR() 4
.IX Item "$obj->type()"

.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
.IP "Error: no folder specified to tie to." 4
.IX Item "Error: no folder specified to tie to."
Cast by \f(CWnew()\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Mail\-Box version 4.02,
built on April 10, 2026. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
For contributors see file ChangeLog.
.PP
This software is copyright (c) 2001\-2026 by Mark Overmeer.
.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.