-
-
22 Nov 2021 03:12:04 UTC
- Distribution: Sisimai
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (24)
- Testers
- Kwalitee
Bus factor: 1- 87.33% Coverage
- License: freebsd
- Perl: v5.10.1
- Activity
24 month- Tools
- Download (918.92KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 15 contributors-
azumakuniyuki
-
0xcdcdcdcd
-
Adrian Yee
-
Alexandre Derumier
-
Jon Jensen
-
Jonathan Leroy
-
Mutsutoshi Yoshimoto
-
Stefan Hornburg (Racke)
-
Valentin Henon
-
Xavier
-
Xavier Guimard
-
azuma, kuniyuki
-
batarian71
-
jcbf
-
root
NAME
Sisimai::Mail - Handler of Mbox/Maildir for reading each mail.
SYNOPSIS
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; }
DESCRIPTION
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
CLASS METHODS
new(path to mbox|Maildir/)
new()
is a constructor of Sisimai::Mailmy $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);
INSTANCE METHODS
path()
path()
returns the path to mbox or Maildir.print $mailbox->path; # /var/mail/root
mbox()
kind()
Returns the name of data typeprint $mailbox->kind; # mailbox or maildir, stdin, or memory.
mail()
mail()
returns Sisimai::Mail::Mbox object or Sisimai::Mail::Maildir object.my $o = $mailbox->mail; print ref $o; # Sisimai::Mail::Mbox
read()
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()
Close the handle of the mailbox or the Maildir/.my $o = $mailbox->close; print $o; # 1 = Successfully closed, 0 = already closed.
AUTHOR
azumakuniyuki
COPYRIGHT
Copyright (C) 2014-2016,2018-2020 azumakuniyuki, All rights reserved.
LICENSE
This software is distributed under The BSD 2-Clause License.
Module Install Instructions
To install Sisimai, copy and paste the appropriate command in to your terminal.
cpanm Sisimai
perl -MCPAN -e shell install Sisimai
For more information on module installation, please visit the detailed CPAN module installation guide.