See METHODS in Mail::Reporter
For authentications, you have three choices: specify a foldername which resembles an URL, or specify a pop-client object, or separate options for user, password, pop-server and server-port.
Option | Defined in | Default |
---|---|---|
access | Mail::Box |
|
authenticate |
| |
body_delayed_type | Mail::Box | |
body_type | Mail::Box | |
coerce_options | Mail::Box |
|
create | Mail::Box | <not applicable> |
extract | Mail::Box |
|
field_type | Mail::Box | undef |
fix_headers | Mail::Box | <false> |
folder | Mail::Box | <not applicable> |
folderdir | Mail::Box | <not used> |
head_delayed_type | Mail::Box | |
head_type | Mail::Box | |
keep_dups | Mail::Box | <false> |
lock_file | Mail::Box | undef |
lock_timeout | Mail::Box | 1 hour |
lock_type | Mail::Box |
|
lock_wait | Mail::Box | 10 seconds |
locker | Mail::Box | undef |
log | Mail::Reporter |
|
manager | Mail::Box | undef |
message_type | Mail::Box | |
multipart_type | Mail::Box | |
password | Mail::Box::Net | undef |
pop_client | undef | |
remove_when_empty | Mail::Box | <false> |
save_on_exit | Mail::Box | <true> |
server_name | Mail::Box::Net | undef |
server_port | Mail::Box::Net | 110 |
trace | Mail::Reporter |
|
trusted | Mail::Box | <false> |
username | Mail::Box::Net | undef |
my $url = 'pop3://user:password@pop.xs4all.nl' my $pop = Mail::Box::POP3->new($url); my $pop = $mgr->open(type => 'pop3', username => 'myname', password => 'mypassword', server_name => 'pop.xs4all.nl');
It is impossible to write messages to the average POP3 server. There are extensions to the protocol which do permit it, however these are not implemented (yet, patches welcome).
undef
is returned, and an error displayed. However, no complaint is
given when the MESSAGE is undef
itself.
Option | Defined in | Default |
---|---|---|
share | Mail::Box | <not used> |
Some extensions to the POP3 protocol do permit writing messages to the server, but the standard protocol only implements retreival. Feel invited to extend our implementation with writing.
As useless as addMessage(). The only acceptable call to this method is without any message.
It is not possible to delete a POP3 folder remotely: the best we can do is remove all the messages in it... which is the action implemented here. A notice is logged about this.
Option | Defined in | Default |
---|---|---|
recursive | Mail::Box | <not used> |
Each user has only one POP3 folder on a server. This folder is created and deleted by the server's administrator only.
NOT IMPLEMENTED YET
The standard POP3 protocol does not support sub-folders, so an empty list will be returned in any case.
Option | Defined in | Default |
---|---|---|
check | Mail::Box | <false> |
folder | Mail::Box | <from calling object> |
folderdir | Mail::Box | <from folder> |
skip_empty | Mail::Box | <false> |
It is not possible to open a sub-folder for a POP3 folder, because that
is not supported by the official POP3 protocol. In any case, undef
is returned to indicate a failure.
Read the header for the specified message from the remote server.
Read all data for the specified message from the remote server.
The server told to have this message, but when asked for its headers, no single line was returned. Did the message get destroyed?
The message's headers are retreived from the server, but the body seems to be lost. Did the message get destroyed between reading the header and reading the body?
The server indicated the existence of this message before, however it has no information about the message anymore.
Returns the pop client object. This does not establish the connection.
The connection to the POP3 server cannot be established. You may see more, related, error messages about the failure.
Option | Defined in | Default |
---|---|---|
messages | Mail::Box | <required> |
The standard POP3 implementation does not support writing from client back to the server. Therefore, modifications may be lost.