.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >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
.\"
.\" 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 "Sisimai::Mail 3pm"
.TH Sisimai::Mail 3pm "2020-12-26" "perl v5.32.0" "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"
Sisimai::Mail \- Handler of Mbox/Maildir for reading each mail.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    use Sisimai::Mail;
\&    my $mailbox = Sisimai::Mail\->new(\*(Aq/var/mail/root\*(Aq);
\&    while( my $r = $mailbox\->read ) {
\&        print $r;
\&    }
\&    $mailbox\->close;
\&
\&    my $maildir = Sisimai::Mail\->new(\*(Aq/home/neko/Maildir/cur\*(Aq);
\&    while( my $r = $maildir\->read ) {
\&        print $r;
\&    }
\&    $maildir\->close;
\&
\&    my $mailtxt = \*(AqFrom Mailer\-Daemon ...\*(Aq;
\&    my $mailobj = Sisimai::Mail\->new(\e$mailtxt);
\&    while( my $r = $mailobj\->read ) {
\&        print $r;
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sisimai::Mail is a handler for reading a \s-1UNIX\s0 mbox, a Maildir, or any email
message input from \s-1STDIN,\s0 variable. It is a wrapper class of the following 
child classes:
.PP
.Vb 4
\&    * Sisimai::Mail::Mbox
\&    * Sisimai::Mail::Maildir
\&    * Sisimai::Mail::STDIN
\&    * Sisimai::Mail::Memory
.Ve
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.ie n .SS """\f(CBnew(path to mbox|Maildir/)\fP"""
.el .SS "\f(CW\fP\f(CBnew(path to mbox|Maildir/)\fP\f(CW\fP"
.IX Subsection "new(path to mbox|Maildir/)"
\&\f(CW\*(C`new()\*(C'\fR is a constructor of Sisimai::Mail
.PP
.Vb 4
\&    my $mailbox = Sisimai::Mail\->new(\*(Aq/var/mail/root\*(Aq);
\&    my $maildir = Sisimai::Mail\->new(\*(Aq/home/nyaa/Maildir/cur\*(Aq);
\&    my $mailtxt = \*(AqFrom Mailer\-Daemon ...\*(Aq;
\&    my $mailobj = Sisimai::Mail\->new(\e$mailtxt);
.Ve
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
.ie n .SS """\f(CBpath()\fP"""
.el .SS "\f(CW\fP\f(CBpath()\fP\f(CW\fP"
.IX Subsection "path()"
\&\f(CW\*(C`path()\*(C'\fR returns the path to mbox or Maildir.
.PP
.Vb 1
\&    print $mailbox\->path;   # /var/mail/root
.Ve
.ie n .SS """\f(CBmbox()\fP"""
.el .SS "\f(CW\fP\f(CBmbox()\fP\f(CW\fP"
.IX Subsection "mbox()"
\&\f(CW\*(C`kind()\*(C'\fR Returns the name of data type
.PP
.Vb 1
\&    print $mailbox\->kind;   # mailbox or maildir, stdin, or memory.
.Ve
.ie n .SS """\f(CBmail()\fP"""
.el .SS "\f(CW\fP\f(CBmail()\fP\f(CW\fP"
.IX Subsection "mail()"
\&\f(CW\*(C`mail()\*(C'\fR returns Sisimai::Mail::Mbox object or Sisimai::Mail::Maildir object.
.PP
.Vb 2
\&    my $o = $mailbox\->mail;
\&    print ref $o;   # Sisimai::Mail::Mbox
.Ve
.ie n .SS """\f(CBread()\fP"""
.el .SS "\f(CW\fP\f(CBread()\fP\f(CW\fP"
.IX Subsection "read()"
\&\f(CW\*(C`read()\*(C'\fR works as a iterator for reading each email in mbox or Maildir. It calls
Sisimai::Mail::Mbox\->read or Sisimai::Mail::Maildir\->read method.
.PP
.Vb 5
\&    my $mailbox = Sisimai::Mail\->new(\*(Aq/var/mail/neko\*(Aq);
\&    while( my $r = $mailbox\->read ) {
\&        print $r;   # print each email in /var/mail/neko
\&    }
\&    $mailbox\->close;
.Ve
.ie n .SS """\f(CBclose()\fP"""
.el .SS "\f(CW\fP\f(CBclose()\fP\f(CW\fP"
.IX Subsection "close()"
\&\f(CW\*(C`close()\*(C'\fR Close the handle of the mailbox or the Maildir/.
.PP
.Vb 2
\&    my $o = $mailbox\->close;
\&    print $o;   # 1 = Successfully closed, 0 = already closed.
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
azumakuniyuki
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2014\-2016,2018\-2020 azumakuniyuki, All rights reserved.
.SH "LICENSE"
.IX Header "LICENSE"
This software is distributed under The \s-1BSD\s0 2\-Clause License.