NAME

Sisimai::Mail::Maildir - Mailbox reader

SYNOPSIS

    use Sisimai::Mail::Maildir;
    my $maildir = Sisimai::Mail::Maildir->new('/home/neko/Maildir/new');
    while( my $r = $maildir->read ) {
        print $r;   # print contents of the mail in the Maildir/
    }

DESCRIPTION

Sisimai::Mail::Maildir is a reader for getting contents of each email in the Maildir/ directory.

CLASS METHODS

new(path to Maildir/)

new() method is a constructor of Sisimai::Mail::Maildir

    my $maildir = Sisimai::Mail::Maildir->new('/home/neko/Maildir/new');

INSTANCE METHODS

dir()

dir() method returns the path to Maildir/

    print $maildir->dir;   # /home/neko/Maildir/new/

path()

path() method returns the path to each email in Maildir/

    print $maildir->path;   # /home/neko/Maildir/new/1.eml

file()

file() method returns the current file name of the Maildir.

    print $maildir->file;

size()

size() method returns the amount of email size which has been read

    print $maildir->size;

offset()

offset() method returns the number of emails which have been read in the Maildir/

    $maildir->offset;   # 2

handle()

handle() meethod returns file handle object IO::Dir of the Maildir.

    $maildir->handle->close;

read()

read() method works as an iterator for reading each email in the Maildir.

    my $maildir = Sisimai::Mail->new('/home/neko/Maildir/new');
    while( my $r = $mailbox->read ) {
        print $r;   # print each email in /home/neko/Maildir/new
    }

AUTHOR

azumakuniyuki

COPYRIGHT

Copyright (C) 2014-2016,2018-2021,2024 azumakuniyuki, All rights reserved.

LICENSE

This software is distributed under The BSD 2-Clause License.

cpanm Sisimai

perl -MCPAN -e shell
install Sisimai