Mail::Box::Dir - handle folders with a file per message.

NAME
INHERITANCE
SYNOPSIS
DESCRIPTION
OVERLOADED
METHODS

Constructors
The folder
Folder flags
The messages
Sub-folders
Internals
Other methods
Error handling
Cleanup

DIAGNOSTICS
DETAILS
REFERENCES
COPYRIGHTS

NAME

Mail::Box::Dir - handle folders with a file per message.

INHERITANCE

 Mail::Box::Dir
   is a Mail::Box
   is a Mail::Reporter

 Mail::Box::Dir is extended by
   Mail::Box::MH
   Mail::Box::Maildir

SYNOPSIS

 # Do not instantiate this object

DESCRIPTION

This documentation describes the way directory organized mailboxes work. At the moment, this object is extended by

Mail::Box::MH
MH folders, which are represented by a directory containing files which are sequentially numbered.
Mail::Box::Maildir
Maildir folders, which are located in a directory which has sub-directories named tmp, new, and cur. Each of these directories may contain files with names which are a combination of a numeric timestamp and some status flags.
Mail::Box::Netzwert
This folder type was especially developed for Netzwert AG, optimized to run on a cluster of servers with folders on NFS. The code is not publicly available (yet).

OVERLOADED

overload: ``''

See OVERLOADED in the Mail::Box manpage

overload: @{}

See OVERLOADED in the Mail::Box manpage

overload: cmp

See OVERLOADED in the Mail::Box manpage

METHODS

Constructors

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

 Option             Defined in       Default                                                         
 access             L<Mail::Box>     C<'r'>                                                          
 body_delayed_type  L<Mail::Box>     L<Mail::Message::Body::Delayed|Mail::Message::Body::Delayed>    
 body_type          L<Mail::Box>     L<Mail::Message::Body::Lines|Mail::Message::Body::Lines>        
 coerce_options     L<Mail::Box>     C<[]>                                                           
 create             L<Mail::Box>     <false>                                                         
 directory                           <derived from folder name>                                      
 extract            L<Mail::Box>     C<10240>                                                        
 field_type         L<Mail::Box>     undef                                                           
 fix_headers        L<Mail::Box>     <false>                                                         
 folder             L<Mail::Box>     C<$ENV{MAIL}>                                                   
 folderdir          L<Mail::Box>     undef                                                           
 head_delayed_type  L<Mail::Box>     L<Mail::Message::Head::Delayed|Mail::Message::Head::Delayed>    
 head_type          L<Mail::Box>     L<Mail::Message::Head::Complete|Mail::Message::Head::Complete>  
 keep_dups          L<Mail::Box>     <false>                                                         
 lock_file          L<Mail::Box>     <folder>C</.lock>                                               
 lock_timeout       L<Mail::Box>     1 hour                                                          
 lock_type          L<Mail::Box>     L<Mail::Box::Locker::DotLock|Mail::Box::Locker::DotLock>        
 lock_wait          L<Mail::Box>     10 seconds                                                      
 locker             L<Mail::Box>     undef                                                           
 log                L<Mail::Reporter>  C<'WARNINGS'>                                                   
 manager            L<Mail::Box>     undef                                                           
 message_type       L<Mail::Box>     L<Mail::Box::Message|Mail::Box::Message>                        
 multipart_type     L<Mail::Box>     L<Mail::Message::Body::Multipart|Mail::Message::Body::Multipart>
 remove_when_empty  L<Mail::Box>     <true>                                                          
 save_on_exit       L<Mail::Box>     <true>                                                          
 trace              L<Mail::Reporter>  C<'WARNINGS'>                                                   
 trusted            L<Mail::Box>     <depends on folder location>

. access MODE

. body_delayed_type CLASS

. body_type CLASS|CODE

. coerce_options ARRAY

. create BOOLEAN

. directory DIRECTORY

For rare folder types, the directory name may differ from the folder name.

. 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

. remove_when_empty BOOLEAN

. save_on_exit BOOLEAN

. trace LEVEL

. trusted BOOLEAN

The folder

$obj->addMessage(MESSAGE, OPTIONS)

See The folder in the Mail::Box manpage

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

See The folder in the Mail::Box manpage

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

See The folder in the Mail::Box manpage

$obj->close(OPTIONS)

See The folder in the Mail::Box manpage

$obj->copyTo(FOLDER, OPTIONS)

See The folder in the Mail::Box manpage

$obj->delete(OPTIONS)

See The folder in the Mail::Box manpage

$obj->directory

Returns the directory related to this folder.

Example:

 print $folder->directory;

$obj->folderdir([DIRECTORY])

See The folder in the Mail::Box manpage

$obj->name

See The folder in the Mail::Box manpage

$obj->organization

See The folder in the Mail::Box manpage

$obj->size

See The folder in the Mail::Box manpage

$obj->type

See The folder in the Mail::Box manpage

$obj->update(OPTIONS)

See The folder in the Mail::Box manpage

$obj->url

See The folder in the Mail::Box manpage

Folder flags

$obj->access

See Folder flags in the Mail::Box manpage

$obj->isModified

See Folder flags in the Mail::Box manpage

$obj->modified([BOOLEAN])

See Folder flags in the Mail::Box manpage

$obj->writable

See Folder flags in the Mail::Box manpage

The messages

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

See The messages in the Mail::Box manpage

$obj->find(MESSAGE-ID)

See The messages in the Mail::Box manpage

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

See The messages in the Mail::Box manpage

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

See The messages in the Mail::Box manpage

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

See The messages in the Mail::Box manpage

$obj->messageIds

See The messages in the Mail::Box manpage

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

See The messages in the Mail::Box manpage

$obj->nrMessages(OPTIONS)

See The messages in the Mail::Box manpage

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

See The messages in the Mail::Box manpage

Sub-folders

$obj->listSubFolders(OPTIONS)

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

See Sub-folders in the Mail::Box manpage

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

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

See Sub-folders in the Mail::Box manpage

$obj->openRelatedFolder(OPTIONS)

See Sub-folders in the Mail::Box manpage

$obj->openSubFolder(SUBNAME, OPTIONS)

See Sub-folders in the Mail::Box manpage

$obj->topFolderWithMessages

Mail::Box::Dir->topFolderWithMessages

See Sub-folders in the Mail::Box manpage

Internals

$obj->coerce(MESSAGE, OPTIONS)

See Internals in the Mail::Box manpage

$obj->create(FOLDERNAME, OPTIONS)

Mail::Box::Dir->create(FOLDERNAME, OPTIONS)

See Internals in the Mail::Box manpage

$obj->determineBodyType(MESSAGE, HEAD)

See Internals in the Mail::Box manpage

$obj->folderToDirectory(FOLDERNAME, FOLDERDIR)

(class method) Translate a foldername into a filename, with use of the FOLDERDIR to replace a leading =.

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

See Internals in the Mail::Box manpage

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

See Internals in the Mail::Box manpage

$obj->locker

See Internals in the Mail::Box manpage

$obj->read(OPTIONS)

See Internals in the Mail::Box manpage

$obj->readMessageFilenames(DIRECTORY)

Returns a list of all filenames which are found in this folder directory and represent a message. The filenames are returned as relative path.

$obj->readMessages(OPTIONS)

See Internals in the Mail::Box manpage

$obj->storeMessage(MESSAGE)

See Internals in the Mail::Box manpage

$obj->toBeThreaded(MESSAGES)

See Internals in the Mail::Box manpage

$obj->toBeUnthreaded(MESSAGES)

See Internals in the Mail::Box manpage

$obj->updateMessages(OPTIONS)

See Internals in the Mail::Box manpage

$obj->write(OPTIONS)

See Internals in the Mail::Box manpage

$obj->writeMessages(OPTIONS)

See Internals in the Mail::Box manpage

Other methods

$obj->timespan2seconds(TIME)

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

See Other methods in the Mail::Box manpage

Error handling

$obj->AUTOLOAD

See Error handling in the Mail::Reporter manpage

$obj->addReport(OBJECT)

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->errors

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

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

See Error handling in the Mail::Reporter manpage

$obj->logSettings

See Error handling in the Mail::Reporter manpage

$obj->notImplemented

See Error handling in the Mail::Reporter manpage

$obj->report([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->reportAll([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->trace([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->warnings

See Error handling in the Mail::Reporter manpage

Cleanup

$obj->DESTROY

See Cleanup in the Mail::Box manpage

$obj->inGlobalDestruction

See Cleanup in the Mail::Reporter manpage

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.

Warning: Folder directory $directory is write-protected.

The folder directory does already exist and is write protected, which may interfere with the requested write access. Change new(access) or the permissions on the directory.

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.

Warning: No directory $name for folder of $class

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.059. 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.

Mail::Box::Dir - handle folders with a file per message.