|
Net::POP3 - Post Office Protocol 3 Client class |
Net::POP3 - Post Office Protocol 3 Client class (RFC1081)
use Net::POP3;
# Constructors
$pop = Net::POP3->new('pop3host');
$pop = Net::POP3->new('pop3host', Timeout => 60);
This module implements a client interface to the POP3 protocol, enabling a perl5 application to talk to POP3 servers. This documentation assumes that you are familiar with the POP3 protocol described in RFC1081.
A new Net::POP3 object must be created with the new method. Once this has been done, all POP3 commands are accessed via method calls on the object.
Need some small examples in here :-)
HOST is the
name of the remote host to which a
POP3 connection is required.
If HOST is not given, then the POP3_Host specified in Net::Config
will be used.
OPTIONS are passed in a hash like fashion, using key and value pairs.
Possible options are:
ResvPort - If given then the socket for the Net::POP3 object
will be bound to the local port given using bind when the socket is
created.
Timeout - Maximum time, in seconds, to wait for a response from the POP3 server (default: 120)
Debug - Enable debugging information
Unless otherwise stated all methods return either a true or false value, with true meaning that the operation was a success. When a method states that it returns a value, failure will be returned as undef or an empty list.
PASS is not given the
Net::POP3 uses Net::Netrc to lookup the password using the host
and username. If the username is not specified then the current user name
will be used.
Returns the number of messages in the mailbox. However if there are no
messages on the server the string "0E0" will be returned. This is
will give a true value in a boolean context, but zero in a numeric context.
If there was an error authenticating the user then undef will be returned.
USER with password PASS.
Similar ti login, but the password is not sent in clear text.
To use this method you must have the MD5 package installed, if you do not this method will return undef
NUMLINES of the body for the message
MSGNUM. Returns a reference to an array which contains the lines of text
read from the server.
list returns the size of the message
in octets.
If called without arguments a reference to a hash is returned. The
keys will be the MSGNUM's of all undeleted messages and the values will
be their size in octets.
MSGNUM from the remote mailbox. Returns a reference to an
array which contains the lines of text read from the server.
MSGNUM of all the messages accessed.
USER.
MSGNUM if given. If MSGNUM is not
given uidl returns a reference to a hash where the keys are the
message numbers and the values are the unique identifiers.
MSGNUM to be deleted from the remote mailbox. All messages
that are marked to be deleted will be removed from the remote mailbox
when the server connection closed.
If a Net::POP3 object goes out of scope before quit method is called
then the reset method will called before the connection is closed. This
means that any messages marked to be deleted will not be.
the Net::Netrc manpage the Net::Cmd manpage
Graham Barr <gbarr@pobox.com>
Copyright (c) 1995-1997 Graham Barr. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
|
Net::POP3 - Post Office Protocol 3 Client class |