Mail::Box::Dir - handle folders with a file per message.
Mail::Box::Dir is a Mail::Box is a Mail::Reporter Mail::Box::Dir is extended by Mail::Box::MH Mail::Box::Maildir
# Do not instantiate this object
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.
tmp
new
cur
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).
Extends "DESCRIPTION" in Mail::Box.
Extends "OVERLOADED" in Mail::Box.
Inherited, see "OVERLOADED" in Mail::Box
Extends "METHODS" in Mail::Box.
Extends "Constructors" in Mail::Box.
-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> directory <derived from folder name> extract Mail::Box 10240 field_type Mail::Box undef fix_headers Mail::Box <false> folder Mail::Box $ENV{MAIL} folderdir Mail::Box undef 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 <folder>/.lock lock_timeout Mail::Box 1 hour lock_type Mail::Box Mail::Box::Locker::DotLock lock_wait Mail::Box 10 seconds locker Mail::Box undef log Mail::Reporter 'WARNINGS' manager Mail::Box undef message_type Mail::Box <folder-class>::Message multipart_type Mail::Box Mail::Message::Body::Multipart remove_when_empty Mail::Box <true> save_on_exit Mail::Box <true> trace Mail::Reporter 'WARNINGS' trusted Mail::Box <depends on folder location>
For rare folder types, the directory name may differ from the folder name.
Extends "The folder" in Mail::Box.
Inherited, see "The folder" in Mail::Box
Returns the directory related to this folder.
example:
print $folder->directory;
Extends "Folder flags" in Mail::Box.
Inherited, see "Folder flags" in Mail::Box
Extends "The messages" in Mail::Box.
Inherited, see "The messages" in Mail::Box
Extends "Sub-folders" in Mail::Box.
Inherited, see "Sub-folders" in Mail::Box
Extends "Internals" in Mail::Box.
Inherited, see "Internals" in Mail::Box
(class method) Translate a foldername into a filename, with use of the $folderdir to replace a leading =.
=
Returns a list of all filenames which are found in this folder directory and represent a message. The filenames are returned as relative path.
Extends "Other methods" in Mail::Box.
Inherited, see "Other methods" in Mail::Box
Extends "Error handling" in Mail::Box.
Inherited, see "Error handling" in Mail::Reporter
Extends "Cleanup" in Mail::Box.
Inherited, see "Cleanup" in Mail::Box
Extends "DETAILS" in Mail::Box.
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.
NEVER
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.
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.
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.
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.
force
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.
delete
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.
The string does not follow the strict rules of the time span syntax which is permitted as parameter.
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.
@
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.
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.
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.
This module is part of Mail-Box distribution version 3.004, built on December 22, 2017.
Do not forget to read Mail::Box-Overview, Mail::Box-Cookbook, and Mail::Box-Index. Examples are included in the Mail-Box distribution, directories 'examples' and 'scripts'.
Browseable manuals, papers, and other released material van be found at Website: http://perl.overmeer.net/mailbox/
The central modules (in separate distributions) in the MailBox suite are: Mail::Message, Mail::Box, Mail::Box::IMAP4, Mail::Box::POP3, Mail::Box::Parser::C, Mail::Box::Dbx (unpublished), Mail::Transport, Object::Realize::Later, and User::Identity.
Please post questions or ideas to the author markov@cpan.org.
Copyrights 2001-2017 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://dev.perl.org/licenses/
To install Mail::Box, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Box
CPAN shell
perl -MCPAN -e shell install Mail::Box
For more information on module installation, please visit the detailed CPAN module installation guide.