NAME

Mail::Transport::Receive - receive messages

INHERITANCE

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

Mail::Transport::Receive is extended by
  Mail::Transport::IMAP4
  Mail::Transport::POP3

SYNOPSIS

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

DESCRIPTION

Each object which extends Mail::Transport::Receive implement a protocol which can get messages into your application. The internals of each implementation can differ quite a lot, so have a look at each separate manual page as well.

Current message receivers:

• Mail::Transport::POP3

  Implements the POP3 protocol. See also Mail::Box::POP3.

METHODS

Constructors

Mail::Transport::Receive->new(OPTIONS)

See "METHODS" in Mail::Transport

Receiving mail

$obj->receive([UNIQUE-MESSAGE-ID])

Receive one message from the remote server. Some receivers will provide the next message automatically, other are random access and use the specified ID.

Server connection

$obj->findBinary(NAME [, DIRECTORIES])

See "Server connection" in Mail::Transport

$obj->remoteHost

See "Server connection" in Mail::Transport

$obj->retry

See "Server connection" in Mail::Transport

Error handling

$obj->AUTOLOAD

See "Error handling" in Mail::Reporter

$obj->addReport(OBJECT)

See "Error handling" in Mail::Reporter

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Transport::Receive->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See "Error handling" in Mail::Reporter

$obj->errors

See "Error handling" in Mail::Reporter

$obj->log([LEVEL [,STRINGS]])

Mail::Transport::Receive->log([LEVEL [,STRINGS]])

See "Error handling" in Mail::Reporter

$obj->logPriority(LEVEL)

Mail::Transport::Receive->logPriority(LEVEL)

See "Error handling" in Mail::Reporter

$obj->logSettings

See "Error handling" in Mail::Reporter

$obj->notImplemented

See "Error handling" in Mail::Reporter

$obj->report([LEVEL])

See "Error handling" in Mail::Reporter

$obj->reportAll([LEVEL])

See "Error handling" in Mail::Reporter

$obj->trace([LEVEL])

See "Error handling" in Mail::Reporter

$obj->warnings

See "Error handling" in Mail::Reporter

Cleanup

$obj->DESTROY

See "Cleanup" in Mail::Reporter

$obj->inGlobalDestruction

See "Cleanup" in Mail::Reporter

DIAGNOSTICS

Warning: Avoid program abuse: specify an absolute path for $exec.

Specifying explicit locations for executables of email transfer agents should only be done with absolute file names, to avoid various pontential security problems.

Warning: Executable $exec does not exist.

The explicitly indicated mail transfer agent does not exists. The normal settings are used to find the correct location.

Error: Package $package does not implement $method.

Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.

REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

Distribution version 2.066. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.

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

cpanm Mail::Box

perl -MCPAN -e shell
install Mail::Box