File Coverage

blib/lib/Nagios/Plugin/POP3.pm

Criterion	Covered	Total	%
statement	13	31	41.9
branch	0	10	0.0
condition	0	3	0.0
subroutine	5	6	83.3
pod	1	1	100.0
total	19	51	37.2

package Nagios::Plugin::POP3;
BEGIN {
  $Nagios::Plugin::POP3::VERSION = '1.001';
}

# ABSTRACT: Nagios plugin for checking POP3 Servers

use warnings;
use strict;
use Nagios::Plugin;
use Mail::POP3Client;




sub run {

    my $p = Nagios::Plugin->new(
        usage => <
Usage: %s [ -v|--verbose ] [-h|--host=] [-u|--user=] [-p|--password=] [--count] [--delete]
[ -c|--critical= ]
[ -w|--warning= ]
END_USAGE
        version => $Nagios::Plugin::POP3VERSION,
        blurb   => q{Nagios plugin for POP3 mailboxes},
        extra   => <
Currently only two POP3 mailbox actions are supported: count and delete

Count - Counts the number of messages on the server. The messages are not modified.
Delete - Deletes all messages on the server (and returns then number deleted)

THRESHOLDs for -w and -c are specified 'min:max' or 'min:' or ':max'
(or 'max'). If specified '\@min:max', a warning status will be generated
if the count *is* inside the specified range.
END_EXTRA
    );

    $p->add_arg(
        spec => 'warning|w=s',
        help => <
-w, --warning=INTEGER:INTEGER
Minimum and maximum number of allowable result, outside of which a
warning will be generated.  If omitted, no warning is generated.
END_HELP
    );

    $p->add_arg(
        spec => 'critical|c=s',
        help => <
-c, --critical=INTEGER:INTEGER
Minimum and maximum number of the generated result, outside of
which a critical will be generated.
END_HELP
    );

    $p->add_arg(
        spec    => 'host|h=s',
        default => 'localhost.localdomain',
        help    => <
-h, --host
POP3 Host (defaults to localhost.localdomain)
END_HELP
    );

    $p->add_arg(
        spec => 'username|u=s',
        help => <
-u, --username
POP3 Username
END_HELP
    );

    $p->add_arg(
        spec => 'password|p=s',
        help => <
-p, --password
POP3 password
END_HELP
    );

    $p->add_arg(
        spec => 'count',
        help => <
--count
Count the number of messages on the server. The messages on the server are not modified.
This is the default action.
END_HELP
    );

    $p->add_arg(
        spec => 'delete',
        help => <
--delete
Delete all messages on the server. Counts how many messages were deleted.
END_HELP
    );

    # Parse arguments and process standard ones (e.g. usage, help, version)
    $p->getopts;

    if ( !defined $p->opts->warning && !defined $p->opts->critical ) {
        $p->nagios_die("You need to specify a threshold argument");
    }

    my $pop = new Mail::POP3Client(
        USER     => $p->opts->username,
        PASSWORD => $p->opts->password,
        HOST     => $p->opts->host,
    );
    my $count = $pop->Count;
    $p->nagios_die( "Error connecting to server: " . $p->opts->host ) if $count < 0;

    for my $i ( 1 .. $count ) {
        $pop->Delete($i) if $p->opts->delete,;
    }
    $pop->Close();

    $p->nagios_exit(
        return_code => $p->check_threshold($count),
        message => ( $p->opts->delete ? 'Deleted ' : 'Counted ' ) . "$count message" . ( $count == 1 ? "\n" : "s\n" ),
    );
}


1;

__END__