File Coverage

blib/lib/Metabrik/Email/Mbox.pm

Criterion	Covered	Total	%
statement	9	34	26.4
branch	0	8	0.0
condition	0	3	0.0
subroutine	3	8	37.5
pod	1	5	20.0
total	13	58	22.4

#
# $Id$
#
# email::mbox Brik
#
package Metabrik::Email::Mbox;
use strict;
use warnings;

use base qw(Metabrik);

sub brik_properties {
   return {
      revision => '$Revision$',
      tags => [ qw(unstable) ],
      author => 'GomoR ',
      license => 'http://opensource.org/licenses/BSD-3-Clause',
      attributes => {
         input => [ qw(mbox_file) ],
         _folder => [ qw(INTERNAL) ],
      },
      commands => {
         open => [ qw(mbox_file|OPTIONAL) ],
         read => [ ],
         read_next => [ ],
         close => [ ],
      },
      require_modules => {
         'Email::Folder' => [ ],
      },
   };
}

sub open {
   my $self = shift;
   my ($input) = @_;

   $input ||= $self->input;
   $self->brik_help_run_undef_arg('open', $input) or return;

   my $folder = Email::Folder->new($input);
   if (! defined($folder)) {
      return $self->log->error("open: Email::Folder new failed for mbox [$input]");
   }

   return $self->_folder($folder);
}

sub read {
   my $self = shift;

   my $folder = $self->_folder;
   $self->brik_help_run_undef_arg('open', $folder) or return;

   my @messages = ();
   for my $message ($folder->messages) {
      my $subject = $message->header('Subject');
      $self->log->verbose("read: Subject [$subject]");

      push @messages, $message;
   }

   return \@messages;
}

sub read_next {
   my $self = shift;

   my $folder = $self->_folder;
   $self->brik_help_run_undef_arg('open', $folder) or return;

   my $message = $folder->next_message;

   return $message;
}

sub close {
   my $self = shift;

   return 1;
}

1;

__END__