Mail::Box::Mbox - handle folders in Mbox format |
Mail::Box::Mbox - handle folders in Mbox format
Mail::Box::Mbox is a Mail::Box::File is a Mail::Box is a Mail::Reporter
use Mail::Box::Mbox; my $folder = Mail::Box::Mbox->new(folder => $ENV{MAIL}, ...);
This documentation describes how Mbox mailboxes work, and also describes what you can do with the Mbox folder object Mail::Box::Mbox.
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
Mail::Box::Mbox->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::File> <see description> coerce_options L<Mail::Box> C<[]> create L<Mail::Box> <false> 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> C<$ENV{HOME}.'/Mail'> 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_extension L<Mail::Box::File> C<'.lock'> lock_file L<Mail::Box> <foldername>.<lock-extension> 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::Mbox::Message|Mail::Box::Mbox::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> subfolder_extension C<'.d'> trace L<Mail::Reporter> C<'WARNINGS'> trusted L<Mail::Box> <depends on folder location> write_policy L<Mail::Box::File> 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_extension FILENAME|STRING
. 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
. subfolder_extension STRING
Mbox folders do not support sub-folders. However, this module can
simulate sub-directories if the user wants it to. When a subfolder of
folder xyz
is created, we create a directory which is called xyz.d
to contain them. This extension .d
can be changed using this option.
. trace LEVEL
. trusted BOOLEAN
. write_policy 'REPLACE'|'INPLACE'|undef
$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::Mbox->appendMessages(OPTIONS)
See METHODS in the Mail::Box::File 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->filename
See The folder in the Mail::Box::File manpage
$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
$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
$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
$obj->listSubFolders(OPTIONS)
Mail::Box::Mbox->listSubFolders(OPTIONS)
Option Defined in Default check L<Mail::Box> <false> folder L<Mail::Box> <from calling object> folderdir L<Mail::Box> <from folder> skip_empty L<Mail::Box> <false> subfolder_extension <from object>
. check BOOLEAN
. folder FOLDERNAME
. folderdir DIRECTORY
. skip_empty BOOL
. subfolder_extension STRING
When the method is called on an open folder, the extension defined by it is
used to detect sub-folders by default. Otherwise, '.d'
is taken.
$obj->nameOfSubFolder(SUBNAME, [PARENTNAME])
Mail::Box::Mbox->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::Mbox->topFolderWithMessages
See Sub-folders in the Mail::Box manpage
$obj->coerce(MESSAGE, OPTIONS)
See Internals in the Mail::Box manpage
$obj->create(FOLDERNAME, OPTIONS)
Mail::Box::Mbox->create(FOLDERNAME, OPTIONS)
Option Defined in Default folderdir L<Mail::Box> undef subfolder_extension undef
. folderdir DIRECTORY
. subfolder_extension STRING
If a directory is found on the location of the folder to be created, this STRING is used to extend that directory name with. This will cause the directory to be seen as sub-folder for the created folder. This argument is passed to folderToFilename().
$obj->determineBodyType(MESSAGE, HEAD)
See Internals in the Mail::Box manpage
$obj->folderToFilename(FOLDERNAME, FOLDERDIR, [EXTENSION])
Mail::Box::Mbox->folderToFilename(FOLDERNAME, FOLDERDIR, [EXTENSION])
Translate a folder name into a filename, using the
FOLDERDIR value to replace a leading =
. If no EXTENSION is specified and
this method is called as instance method, new(subfolder_extension)
is used.
Otherwise, the extension default to '.d'
.
Mail::Box::Mbox->foundIn([FOLDERNAME], [OPTIONS])
If no FOLDERNAME is specified, then the value of the folder
option
is taken. A mbox folder is a file which starts with a separator
line: a line with 'From '
as first characters. Blank lines which
start the file are ignored, which is not for all MUA's acceptable.
Option Defined in Default folder undef folderdir L<Mail::Box> undef subfolder_extension <from object>
. folder FOLDERNAME
. folderdir DIRECTORY
. subfolder_extension STRING
$obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])
See Internals in the Mail::Box manpage
$obj->locker
See Internals in the Mail::Box manpage
$obj->messageCreateOptions([TYPE, CONFIG])
See Internals in the Mail::Box::File manpage
$obj->moveAwaySubFolder(DIRECTORY, EXTENSION)
See Internals in the Mail::Box::File manpage
$obj->parser
See Internals in the Mail::Box::File manpage
$obj->read(OPTIONS)
See Internals in the Mail::Box manpage
$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::File manpage
$obj->write(OPTIONS)
See Internals in the Mail::Box::File manpage
$obj->writeMessages(OPTIONS)
See Internals in the Mail::Box manpage
$obj->timespan2seconds(TIME)
Mail::Box::Mbox->timespan2seconds(TIME)
See Other methods in the Mail::Box manpage
$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::Mbox->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::Mbox->log([LEVEL [,STRINGS]])
See Error handling in the Mail::Reporter manpage
$obj->logPriority(LEVEL)
Mail::Box::Mbox->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
$obj->DESTROY
See Cleanup in the Mail::Box manpage
$obj->inGlobalDestruction
See Cleanup in the Mail::Reporter manpage
Error: Cannot append messages to folder file $filename: $!
Appending messages to a not-opened file-organized folder may fail when the operating system does not allow write access to the file at hand.
Error: Cannot move away sub-folder $dir
Warning: Cannot remove folder $name file $filename: $!
Writing an empty folder will usually cause that folder to be removed, which fails for the indicated reason. new(remove_when_empty)
Warning: Cannot remove folder $name file $filename: $!
Writing an empty folder will usually cause that folder to be removed,
which fails for the indicated reason. new(remove_when_empty)
controls whether the empty folder will removed; setting it to false
(0
) may be needed to avoid this message.
Error: Cannot replace $filename by $tempname, to update folder $name: $!
The replace policy wrote a new folder file to update the existing, but was unable to give the final touch: replacing the old version of the folder file for the indicated reason.
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: File too short to get write message $nr ($size, $need)
Mail::Box is lazy: it tries to leave messages in the folders until they are used, which saves time and memory usage. When this message appears, something is terribly wrong: some lazy message are needed for updating the folder, but they cannot be retreived from the original file anymore. In this case, messages can be lost.
This message does appear regularly on Windows systems when using the 'replace' write policy. Please help to find the cause, probably something to do with Windows incorrectly handling multiple filehandles open in the same file.
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: Unable to update folder $self.
When a folder is to be written, both replace and inplace write policies are tried, If both fail, the whole update fails. You may see other, related, error messages to indicate the real problem.
MBOX folders store many messages in one file. Each message begins with a
line which starts with the string From
. Lines inside a message which
accidentally start with From
are, in the file, preceded by `>'. This
character is stripped when the message is read.
In this respect must be noted that the format of the MBOX files is not
strictly defined. The exact content of the separator lines differ between
Mail User Agents (MUA's). Besides, some MUAs (like mutt) forget to encode
the From
lines within message bodies, breaking other parsers....
MBOX folders do not have a sub-folder concept as directory based folders do, but this MBOX module tries to simulate them. In this implementation a directory like
Mail/subject1/
is taken as an empty folder Mail/subject1
, with the folders in that
directory as sub-folders for it. You may also use
Mail/subject1 Mail/subject1.d/
where Mail/subject1
is the folder, and the folders in the
Mail/subject1.d
directory are used as sub-folders. If your situation
is similar to the first example and you want to put messages in that empty
folder, the directory is automatically (and transparently) renamed, so
that the second situation is reached.
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
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::Mbox - handle folders in Mbox format |