The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Mail-Box-2.068
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Box::Net

NAME

Mail::Box::Net - handle folders which are stored remote.

INHERITANCE

 Mail::Box::Net
   is a Mail::Box
   is a Mail::Reporter

 Mail::Box::Net is extended by
   Mail::Box::IMAP4
   Mail::Box::POP3

SYNOPSIS

 # Do not instantiate this object directly

DESCRIPTION

At the moment, this object is extended by

OVERLOADED

overload: ""

overload: @{}

overload: cmp

METHODS

Constructors

Mail::Box::Net->new(OPTIONS)

     Option           --Defined in     --Default
 access             Mail::Box        'r'
 body_delayed_type  Mail::Box        Mail::Message::Body::Delayed
 body_type          Mail::Box        Mail::Message::Body::Lines
 coerce_options     Mail::Box        []
 create             Mail::Box        <false>
 extract            Mail::Box        10240
 field_type         Mail::Box        undef
 fix_headers        Mail::Box        <false>
 folder             Mail::Box        '/'
 folderdir          Mail::Box        <not used>
 head_delayed_type  Mail::Box        Mail::Message::Head::Delayed
 head_type          Mail::Box        Mail::Message::Head::Complete
 keep_dups          Mail::Box        <false>
 lock_file          Mail::Box        undef
 lock_timeout       Mail::Box        1 hour
 lock_type          Mail::Box        'NONE'
 lock_wait          Mail::Box        10 seconds
 locker             Mail::Box        undef
 log                Mail::Reporter   'WARNINGS'
 manager            Mail::Box        undef
 message_type       Mail::Box        Mail::Box::Message
 multipart_type     Mail::Box        Mail::Message::Body::Multipart
 password                            undef
 remove_when_empty  Mail::Box        <false>
 save_on_exit       Mail::Box        <true>
 server_name                         undef
 server_port                         undef
 trace              Mail::Reporter   'WARNINGS'
 trusted            Mail::Box        <false>
 username                            undef

    . access MODE

    . body_delayed_type CLASS

    . body_type CLASS|CODE

    . coerce_options ARRAY

    . create BOOLEAN

    . extract INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS'

    . field_type CLASS

    . fix_headers BOOLEAN

    . folder FOLDERNAME

    . folderdir DIRECTORY

    . head_delayed_type CLASS

    . head_type CLASS

    . keep_dups BOOLEAN

    . lock_file FILENAME

    . lock_timeout SECONDS

    . lock_type CLASS|STRING|ARRAY

    . lock_wait SECONDS

    . locker OBJECT

    . log LEVEL

    . manager MANAGER

    . message_type CLASS

    . multipart_type CLASS

    . password STRING

      The password which is required to contact the remote server.

    . remove_when_empty BOOLEAN

    . save_on_exit BOOLEAN

    . server_name HOSTNAME

      The name of the host which contains the remote mail server.

    . server_port INTEGER

      Port number in use by the server application.

    . trace LEVEL

    . trusted BOOLEAN

    . username STRING

      The username which is to be used for the remote server.

The folder

$obj->addMessage(MESSAGE, OPTIONS)

$obj->addMessages(MESSAGE [, MESSAGE, ...])

Mail::Box::Net->appendMessages(OPTIONS)

$obj->close(OPTIONS)

$obj->copyTo(FOLDER, OPTIONS)

$obj->delete(OPTIONS)

$obj->folderdir([DIRECTORY])

    Not applicatable for folders on a remote server, so will always return the undef.

$obj->name

$obj->organization

$obj->size

$obj->type

$obj->update(OPTIONS)

$obj->url

Folder flags

$obj->access

$obj->isModified

$obj->modified([BOOLEAN])

$obj->writable

The messages

$obj->current([NUMBER|MESSAGE|MESSAGE-ID])

$obj->find(MESSAGE-ID)

$obj->findFirstLabeled(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])

$obj->message(INDEX [,MESSAGE])

$obj->messageId(MESSAGE-ID [,MESSAGE])

$obj->messageIds

$obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])

$obj->nrMessages(OPTIONS)

$obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)

Sub-folders

$obj->listSubFolders(OPTIONS)

Mail::Box::Net->listSubFolders(OPTIONS)

$obj->nameOfSubFolder(SUBNAME, [PARENTNAME])

Mail::Box::Net->nameOfSubFolder(SUBNAME, [PARENTNAME])

$obj->openRelatedFolder(OPTIONS)

$obj->openSubFolder(SUBNAME, OPTIONS)

$obj->topFolderWithMessages

Mail::Box::Net->topFolderWithMessages

Internals

$obj->coerce(MESSAGE, OPTIONS)

$obj->create(FOLDER, OPTIONS)

Mail::Box::Net->create(FOLDER, OPTIONS)

    Create a new folder on the remote server.

     Option   --Defined in--Default
 folderdir  Mail::Box   <not used>

    . folderdir DIRECTORY

$obj->determineBodyType(MESSAGE, HEAD)

Mail::Box::Net->foundIn([FOLDERNAME], OPTIONS)

$obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])

$obj->locker

$obj->read(OPTIONS)

$obj->readMessages(OPTIONS)

$obj->storeMessage(MESSAGE)

$obj->toBeThreaded(MESSAGES)

$obj->toBeUnthreaded(MESSAGES)

$obj->updateMessages(OPTIONS)

$obj->write(OPTIONS)

$obj->writeMessages(OPTIONS)

Other methods

$obj->timespan2seconds(TIME)

Mail::Box::Net->timespan2seconds(TIME)

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

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

Mail::Box::Net->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

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

Mail::Box::Net->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Box::Net->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->inGlobalDestruction

DIAGNOSTICS

Warning: Changes not written to read-only folder $self.

You have opened the folder read-only --which is the default set by new(access)--, made modifications, and now want to close it. Set close(force) if you want to overrule the access mode, or close the folder with close(write) set to NEVER.

Error: Copying failed for one message.

For some reason, for instance disc full, removed by external process, or read-protection, it is impossible to copy one of the messages. Copying will proceed for the other messages.

Error: Destination folder $name is not writable.

The folder where the messages are copied to is not opened with write access (see new(access)). This has no relation with write permission to the folder which is controled by your operating system.

Warning: Different messages with id $msgid

The message id is discovered more than once within the same folder, but the content of the message seems to be different. This should not be possible: each message must be unique.

Error: Folder $name is opened read-only

You can not write to this folder unless you have opened the folder to write or append with new(access), or the force option is set true.

Error: Folder $name not deleted: not writable.

The folder must be opened with write access via new(access), otherwise removing it will be refused. So, you may have write-access according to the operating system, but that will not automatically mean that this delete method permits you to. The reverse remark is valid as well.

Error: Invalid timespan '$timespan' specified.

The string does not follow the strict rules of the time span syntax which is permitted as parameter.

Warning: Message-id '$msgid' does not contain a domain.

According to the RFCs, message-ids need to contain a unique random part, then an @, and then a domain name. This is made to avoid the creation of two messages with the same id. The warning emerges when the @ is missing from the string.

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.

Error: Unable to create subfolder $name of $folder.

The copy includes the subfolders, but for some reason it was not possible to copy one of these. Copying will proceed for all other sub-folders.

Error: Writing folder $name failed

For some reason (you probably got more error messages about this problem) it is impossible to write the folder, although you should because there were changes made.

DETAILS

REFERENCES

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

COPYRIGHTS

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

Copyright (c) 2001-2006 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.