NAME

Mail::Transport::POP3 - receive messages via POP3

CLASS HIERARCHY

Mail::Transport::POP3
is a Mail::Transport::Receive
is a Mail::Transport
is a Mail::Reporter

SYNOPSIS

my $receiver = Mail::Transport::POP3->new(...);
my $message = $receiver->receive($id);

DESCRIPTION

Receive messages via the POP3 protocol. This object handles the contact with one POP3 server, and recovers broken connections automatically.

METHOD INDEX

Methods prefixed with an abbreviation are described in Mail::Reporter (MR), Mail::Transport (MT), Mail::Transport::Receive (MTR).

The general methods for Mail::Transport::POP3 objects:

 MR errors                            MR reportAll [LEVEL]
 MR log [LEVEL [,STRINGS]]               top UIDL, [MAXLINES]
    new OPTIONS                       MR trace [LEVEL]
MTR receive [UNIQUE-MESSAGE-ID]          url
 MR report [LEVEL]                    MR warnings

The extra methods for extension writers:

MR AUTOLOAD                          MR logPriority LEVEL
MR DESTROY                           MR logSettings
   contactServer                     MR notImplemented
MT findBinary NAME [, DIRECTOR...    MT remoteHost
MR inGlobalDestruction               MT retry

METHODS

new OPTIONS

OPTION        DESCRIBED IN             DEFAULT
authenticate  Mail::Transport::POP3    'LOGIN'
head_type     Mail::Transport::Receive 'Mail::Message::Head::Complete'
head_opts     Mail::Transport::Receive {}
hostname      Mail::Transport          'localhost'
interval      Mail::Transport          30
message_type  Mail::Transport::Receive 'Mail::Message'
message_opts  Mail::Transport::Receive undef
log           Mail::Reporter           'WARNINGS'
password      Mail::Transport          undef
proxy         Mail::Transport          undef
retry         Mail::Transport          undef
timeout       Mail::Transport          120
trace         Mail::Reporter           'WARNINGS'
username      Mail::Transport          undef
via           Mail::Transport          'pop3'

• authenticate => 'LOGIN'|'APOP'

  Use the old LOGIN authentication (unencryped, default) or the newer APOP.

url

Represent this pop3 connection as URL.

top UIDL, [MAXLINES]

Returns a reference to an array which contains the header of the message with the specified UIDL. The optional integer MAXLINES specifies the number of lines from the body which are wanted: by default all.

METHODS for extensions writers

contactServer

SEE ALSO

Mail::Box-Overview

For support and additional documentation, see http://perl.overmeer.net/mailbox/

AUTHOR

Mark Overmeer (mailbox@overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION

This code is beta, version 2.018.

Copyright (c) 2001-2002 Mark Overmeer. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.