NAME

Mail::vpopmail - Utility to get information about vpopmail managed email addresses

SYNOPSIS

use Mail::vpopmail;

my $vchkpw = Mail::vpopmail->new();

my $vchkpw = Mail::vpopmail->new(cache => 1, debug => 0);

DESCRIPTION

Mail::vpopmail provides serveral functions for interacting with vpopmail. This module can be useful especially when hashing is turned on, as you can not predict the location of the domain's nor the mailbox's directories.

CONSTRUCTOR

new( [OPTIONS] );

OPTIONS are passwed in a hash like fashion, using key and value pairs. Possible options are:

cache - Cache results of queries (0=Off, 1=On). Default=On.

debug - Print debugging info to STDERR (0=Off, 1=On). Default=On.

get( email => $email, field => <fields> );

email - the email address to get properties on

field - the field(s) you want to be returned (may be comma separated):

        dir - return this domain's vpopmail domains directory

        crypt - return the encrypted password

        uid - return the uid

        gid - return the gid

        comment - return the comment, if available

        maildir - return this user's maildir
        
        quota - return the quota (you have to parse this yourself)

        plain - return the plain text password, if available
        

EXAMPLES

        use Mail::vpopmail;
        my $email = shift;
        unless(defined($email)){
                print "email address: ";
                chop($email=<STDIN>);
        }

        my $vchkpw = Mail::vpopmail->new();

        my $dir = $vchkpw->get(email => $email, field => 'dir');
        my ($crypt,$uid,$gid) = $vchkpw->get(email => $email, field => 'crypt,uid,gid');
        my $comment = $vchkpw->get(email => $email, field => 'comment');
        my $maildir = $vchkpw->get(email => $email, field => 'maildir');
        my $quota = $vchkpw->get(email => $email, field => 'quota');
        my $plain = $vchkpw->get(email => $email, field => 'plain');

CAVEATS

This version does not support SQL based vpopmail solutions.

AUTHOR

Jeremy Kister - http://jeremy.kister.net/