| Sisimai::Mail(3pm) | User Contributed Perl Documentation | Sisimai::Mail(3pm) |
Sisimai::Mail - Handler of Mbox/Maildir for reading each mail.
use Sisimai::Mail;
my $mailbox = Sisimai::Mail->new('/var/mail/root');
while( my $r = $mailbox->read ) {
print $r;
}
$mailbox->close;
my $maildir = Sisimai::Mail->new('/home/neko/Maildir/cur');
while( my $r = $maildir->read ) {
print $r;
}
$maildir->close;
my $mailtxt = 'From Mailer-Daemon ...';
my $mailobj = Sisimai::Mail->new(\$mailtxt);
while( my $r = $mailobj->read ) {
print $r;
}
Sisimai::Mail is a handler for reading a UNIX mbox, a Maildir, or any email message input from STDIN, variable. It is a wrapper class of the following child classes:
* Sisimai::Mail::Mbox
* Sisimai::Mail::Maildir
* Sisimai::Mail::STDIN
* Sisimai::Mail::Memory
"new()" is a constructor of Sisimai::Mail
my $mailbox = Sisimai::Mail->new('/var/mail/root');
my $maildir = Sisimai::Mail->new('/home/nyaa/Maildir/cur');
my $mailtxt = 'From Mailer-Daemon ...';
my $mailobj = Sisimai::Mail->new(\$mailtxt);
"path()" returns the path to mbox or Maildir.
print $mailbox->path; # /var/mail/root
"kind()" Returns the name of data type
print $mailbox->kind; # mailbox or maildir, stdin, or memory.
"mail()" returns Sisimai::Mail::Mbox object or Sisimai::Mail::Maildir object.
my $o = $mailbox->mail;
print ref $o; # Sisimai::Mail::Mbox
"read()" works as a iterator for reading each email in mbox or Maildir. It calls Sisimai::Mail::Mbox->read or Sisimai::Mail::Maildir->read method.
my $mailbox = Sisimai::Mail->new('/var/mail/neko');
while( my $r = $mailbox->read ) {
print $r; # print each email in /var/mail/neko
}
$mailbox->close;
"close()" Close the handle of the mailbox or the Maildir/.
my $o = $mailbox->close;
print $o; # 1 = Successfully closed, 0 = already closed.
azumakuniyuki
Copyright (C) 2014-2016,2018-2020 azumakuniyuki, All rights reserved.
This software is distributed under The BSD 2-Clause License.
| 2022-12-23 | perl v5.36.0 |