Test::POP3(3) User Contributed Perl Documentation Test::POP3(3)NAMETest::POP3 - Automate Email Delivery Tests
SYNOPSIS
use Test::POP3;
my $pop = Test::POP3->new({
host => $host,
user => $user,
pass => $pass,
});
# this will delete all messages from the server!
ok($count == $pop->wait_for_email_count($count,$timeout),"got $count");
# find and delete a single email message which matches these rules
# see Test::Email for more information
$pop->ok({
# optional search parameters
to => ($is or qr/is like/),
from => ($is or qr/is like/),
subject => ($is or qr/is like/),
body => ($is or qr/is like/),
headername => ($is or qr/is like/),
}, "got message");
ok($pop->get_email_count() == $count, "$count emails in cache");
# get the Test::Email object
my @email = $pop->get_email();
ok($pop->delete_all() == 2, "deleted 2 messages");
# tweak MIME::Parser settings
my $parser = $pop->get_parser();
DESCRIPTION
Please note that this is ALPHA CODE. As such, the interface is likely
to change.
This module can help you to create automated tests of email delivered
to a POP3 account.
Messages retrieved from the server but not yet matched by a test will
be cached until either that message is the first to pass a test, or is
returned by "$pop3->get_email()". Messages returned are Test::Email
objects.
METHODS
"my $pop = Test::Email->new($href);"
The arguments passed in the href are host, user, and pass.
"my $count = $pop->wait_for_email_count($count, $timeout_seconds?);"
Calling this method will result in all messages being deleted from
the server. This will wait up to $timeout seconds for there to be
$count unprocessed messages found on the server. After $count or
more messages are found, or after $timeout seconds, the current
email count will be returned. $timeout_seconds defaults to 30. All
messages will be deleted from the server.
"my @email = $pop->get_email();"
Get all of the email messages currently in local cache. You should
call "$pop3->wait_for_email_count($count)" before calling this
method if you think that there may be messages on the server yet to
be retrieved. Calling this method will cause the local cache to be
emptied. Email messages returned will be Test::Email objects.
"my $count = $pop->get_email_count($check_server);"
This will return the number of email messages in the cache. If
$check_server is true, then the server will be checked once before
the count is determined. If you would like to wait for messages to
arrive on the server, and then be downloaded prior to counting, use
"$pop3->wait_for_email_count()".
"my $ok = $pop->ok($test_href, $description);"
Calling this method will cause the email in the local cache to be
tested, according to the contents of $test_href. The first email
which passes all tests will be deleted from the local cache. Since
this method only checks the local cache, you will want to call
"$pop3->wait_for_email_count()" before calling this method. "ok"
will produce TAP output, identical to "Test::Simple::ok" and
"Test::More::ok".
"my $parser = $pop->get_parser();"
Test::POP3 uses MIME::Parser to process the messages. (MIME is not
yet handled by "Test::Email", it will be soon.) Use this method if
you want to manage the parser.
EXPORT
None.
SEE ALSO
Test::Builder, Test::Simple, Test::More, MIME::Parser
AUTHOR
James Tolley, <james@cpan.org>
COPYRIGHT AND LICENSE
Copyright (C) 2007 by James Tolley
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself, either Perl version 5.8.8 or, at
your option, any later version of Perl 5 you may have available.
perl v5.14.1 2007-06-09 Test::POP3(3)
