GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Sisimai::Mail::Mbox(3) User Contributed Perl Documentation Sisimai::Mail::Mbox(3)

Sisimai::Mail::Mbox - Mailbox reader

    use Sisimai::Mail::Mbox;
    my $mailbox = Sisimai::Mail::Mbox->new('/var/spool/mail/root');
    while( my $r = $mailbox->read ) {
        print $r;   # print contents of each mail in mbox
    }

Sisimai::Mail::Mbox is a mailbox file (UNIX mbox) reader.

"new()" is a constructor of Sisimai::Mail::Mbox

    my $mailbox = Sisimai::Mail::Mbox->new('/var/mail/root');

"dir()" returns the directory name of mbox

    print $mailbox->dir;   # /var/mail

"path()" returns the path to mbox.

    print $mailbox->path;   # /var/mail/root

"file()" returns a file name of the mbox.

    print $mailbox->file;   # root

"size()" returns the file size of the mbox.

    print $mailbox->size;   # 94515

"offset()" returns offset position for seeking the mbox. The value of "offset" is bytes which have already read.

    print $mailbox->offset;   # 0

"handle()" returns file handle object (IO::File) of the mbox.

    $mailbox->handle->close;

"read()" works as a iterator for reading each email in the mbox.

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

azumakuniyuki

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

This software is distributed under The BSD 2-Clause License.
2021-02-22 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.