Company Innovation Man pages Tech News Developer Mirrors Search
 
Mail::Box::Dir   (3) manpage
Mail::Box::Dir
3
2004-05-16
perl v5.8.3
User Contributed Perl Documentation
  • 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
      "*
      MH folders, which are represented by a directory containing files which are sequentially numbered.
      "*
      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.
  • OVERLOADED
      overload: ""
      See "OVERLOADED" in Mail::Box


      overload: @{}
      See "OVERLOADED" in Mail::Box


      overload: cmp
      See "OVERLOADED" in Mail::Box
  • METHODS
  • "Constructors"
      $obj->create(FOLDERNAME, OPTIONS)

      Mail::Box::Dir->create(FOLDERNAME, OPTIONS)
      See "Constructors" in Mail::Box


      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>                                                         
      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 . 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)
      See "The folder" in Mail::Box


      $obj->addMessages(MESSAGE [, MESSAGE, ...])
      See "The folder" in Mail::Box


      Mail::Box::Dir->appendMessages(OPTIONS)
      See "The folder" in Mail::Box


      $obj->close(OPTIONS)
      See "The folder" in Mail::Box


      $obj->copyTo(FOLDER, OPTIONS)
      See "The folder" in Mail::Box


      $obj->delete
      See "The folder" in Mail::Box


      $obj->directory
      Returns the directory related to this folder. Example:
      print $folder->directory;


      $obj->folderdir([DIRECTORY])
      See "The folder" in Mail::Box


      Mail::Box::Dir->foundIn([FOLDERNAME], OPTIONS)
      See "The folder" in Mail::Box


      $obj->name
      See "The folder" in Mail::Box


      $obj->organization
      See "The folder" in Mail::Box


      $obj->size
      See "The folder" in Mail::Box


      $obj->type
      See "The folder" in Mail::Box


      $obj->update(OPTIONS)
      See "The folder" in Mail::Box


      $obj->url
      See "The folder" in Mail::Box
  • "Folder flags"
      $obj->isModified
      See "Folder flags" in Mail::Box


      $obj->modified([BOOLEAN])
      See "Folder flags" in Mail::Box


      $obj->writable
      See "Folder flags" in Mail::Box
  • "The messages"
      $obj->current([NUMBER|MESSAGE|MESSAGE-ID])
      See "The messages" in Mail::Box


      $obj->find(MESSAGE-ID)
      See "The messages" in Mail::Box


      $obj->findFirstLabeled(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
      See "The messages" in Mail::Box


      $obj->message(INDEX [,MESSAGE])
      See "The messages" in Mail::Box


      $obj->messageId(MESSAGE-ID [,MESSAGE])
      See "The messages" in Mail::Box


      $obj->messageIds
      See "The messages" in Mail::Box


      $obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
      See "The messages" in Mail::Box


      $obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
      See "The messages" in Mail::Box
  • "Sub-folders"
      $obj->listSubFolders(OPTIONS)

      Mail::Box::Dir->listSubFolders(OPTIONS)
      See "Sub-folders" in Mail::Box


      $obj->nameOfSubFolder(NAME)
      See "Sub-folders" in Mail::Box


      $obj->openRelatedFolder(OPTIONS)
      See "Sub-folders" in Mail::Box


      $obj->openSubFolder(NAME, OPTIONS)
      See "Sub-folders" in Mail::Box
  • "Internals"
      $obj->coerce(MESSAGE)
      See "Internals" in Mail::Box


      $obj->determineBodyType(MESSAGE, HEAD)
      See "Internals" in Mail::Box


      $obj->folderToDirectory(FOLDERNAME, FOLDERDIR)
      (class method)  Translate a foldername into a filename, with use of the FOLDERDIR to replace a leading "=".


      $obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])
      See "Internals" in Mail::Box


      $obj->locker
      See "Internals" in Mail::Box


      $obj->read(OPTIONS)
      See "Internals" in Mail::Box


      $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 Mail::Box


      $obj->storeMessage(MESSAGE)
      See "Internals" in Mail::Box


      $obj->toBeThreaded(MESSAGES)
      See "Internals" in Mail::Box


      $obj->toBeUnthreaded(MESSAGES)
      See "Internals" in Mail::Box


      $obj->updateMessages(OPTIONS)
      See "Internals" in Mail::Box


      $obj->write(OPTIONS)
      See "Internals" in Mail::Box


      $obj->writeMessages(OPTIONS)
      See "Internals" in Mail::Box
  • "Other methods"
      $obj->timespan2seconds(TIME)

      Mail::Box::Dir->timespan2seconds(TIME)
      See "Other methods" in Mail::Box
  • "Error handling"
      $obj->AUTOLOAD
      See "Error handling" in Mail::Reporter


      $obj->addReport(OBJECT)
      See "Error handling" in Mail::Reporter


      $obj->defaultTrace([LEVEL, [LEVEL])

      Mail::Box::Dir->defaultTrace([LEVEL, [LEVEL])
      See "Error handling" in Mail::Reporter


      $obj->errors
      See "Error handling" in Mail::Reporter


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

      Mail::Box::Dir->log([LEVEL [,STRINGS]])
      See "Error handling" in Mail::Reporter


      $obj->logPriority(LEVEL)

      Mail::Box::Dir->logPriority(LEVEL)
      See "Error handling" in Mail::Reporter


      $obj->logSettings
      See "Error handling" in Mail::Reporter


      $obj->notImplemented
      See "Error handling" in Mail::Reporter


      $obj->report([LEVEL])
      See "Error handling" in Mail::Reporter


      $obj->reportAll([LEVEL])
      See "Error handling" in Mail::Reporter


      $obj->trace([LEVEL])
      See "Error handling" in Mail::Reporter


      $obj->warnings
      See "Error handling" in Mail::Reporter
  • "Cleanup"
      $obj->DESTROY
      See "Cleanup" in Mail::Box


      $obj->inGlobalDestruction
      See "Cleanup" in Mail::Reporter
  • 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.

      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.055. 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.
Current Users: 33 © 1999-2006 Linux.com.hk PenguinSoft
All trademarks and copyrights on this page are owned by their respective companies. Linux is a trademark of Linus Torvalds.