NAME

Mail::Box-Index - list of all extended documentation

DESCRIPTION

All methods defined by MailBox are documented, but you still need to get a grip on the large picture: the relations between the modules and the methods. These larger explanations are included in the DETAILS of the manual pages, and listed here below. Of course, each page has a DESCRIPTION section as well, which tells some bare necessities about the module.

Only the HTML version of this manual page will list the sections.

1. General sources of information
   • MailBox distribution overview (Mail::Box-Overview)
     • Introduction
     • The class relations
     • The Manager
     • The Messages
     • The Folder types
     • Various Other Classes
   • MailBox simple recepies (Mail::Box-Cookbook)
     • The Manager
     • Multi part messages
     • Filter
     • Create a reply
     • Build a message

2. Messages ( Mail::Message ) See separate entries on header, body, fields and construction in this index below.
   • Structure of a Message
     • The header
     • The body
   • Coercing messages
   • Message object implementation
   • Message class implementation

3. Message headers ( Mail::Message::Head )
   • Ordered header fields
   • Subsets of header fields
   • Head class implementation

4. Message header fields ( Mail::Message::Field )
   • Field syntax
     • Folding fields
     • Structured fields
     • Comments in fields
   • Getting a field
     • Using get() field
     • Using study() field
     • Using resent groups (Mail::Message::Head::ResentGroup)
     • Mailing list fields
   • The field's data
     • Access to the field
     • Using simplified field access
     • Specifying field data
   • Field class implementation

5. Message bodies ( Mail::Message::Body )
   • Access to the body
   • Body meta information
     • Content types (MIME::Types)
     • Content transfer encoding (Mail::Message::TransferEnc)
   • Multipart bodies (Mail::Message::Body::Multipart)
   • Nested (encapsulated) messages (Mail::Message::Body::Nested)
   • Body class implementation
     • Data collector bodies
     • Complex bodies

6. Message labels
   • Labels (Mail::Message)
     • Predefined labels (Mail::Message)
     • Storing labels folder dependent
     • Flags in filename (Mail::Box::Maildir::Message)
     • Status and X-Status fields (MBOX and POP3 folders)
     • The .mh_sequences file (Mail::Box::MH::Labels)
     • IMAP protocol flags (Mail::Box::IMAP4::Message)

7. Message processing
   • Reading a message (Mail::Message::Construct::Read)
   • Building a message (Mail::Message::Construct::Build)
   • Reply to a message (Mail::Message::Construct::Reply)
   • Forward a message (Mail::Message::Construct::Forward)
   • Bounce a message (Mail::Message::Construct::Bounce)
   • Rebuilding a message (Mail::Message::Construct::Rebuild)
     • General rules
     • Conversion rules
     • Adding your own rules
   • Convert messages
     • To and from Mail::Internet objects (Mail::Message::Convert::MailInternet)
     • To and from MIME::Entity objects(Mail::Message::Convert::MimeEntity)
     • Into HTML (Mail::Message::Convert::Html)
   • Convert body contents
     • From HTML to PostScript (Mail::Message::Convert::HtmlFormatPS)
     • From HTML into plain text (Mail::Message::Convert::HtmlFormatText)
     • Beautify text (Mail::Message::Convert::TextAutoformat)

8. Folders ( Mail::Box ) See separate section for type specifics below.
   • Folder types (Mail::Box)
     • Different kinds of folders
     • Supported folder types
     • Folder class implementation
   • The folder manager (Mail::Box::Manager)
   • Folder tied as array (Mail::Box::Tie::ARRAY)
     • Limitations
   • Folder tied as hash (Mail::Box::Tie::HASH)
   • Folder locking (Mail::Box::Locker)
   • Searching folders (Mail::Box::Search)
     • scan header and body (Mail::Box::Search::Grep)
     • check for spam (Mail::Box::Search::SpamAssassin)

9. Folder types
   • DBX folders (Mail::Box::Dbx, read only)
     • How DBX folders work
     • This implementation
     • Converting DBX folders to MBOX
   • IMAP4 folders (Mail::Box::IMAP4)
     • How IMAP4 folders work
   • MAILDIR folders (Mail::Box::Maildir)
     • How MAILDIR folders work
   • MBOX folders (Mail::Box::Mbox)
     • How MBOX folders work
     • Simulation of sub-folders
   • MH folders (Mail::Box::MH)
     • How MH folders work
     • This implementation
     • An index-file
   • POP3 folders (Mail::Box::POP3)
     • How POP3 folders work
     • This implementation

10. Discussion threads
    • The thread manager (Mail::Box::Thread::Manager)
      • Maintaining threads
      • Delayed thread detection
    • The thread node (Mail::Box::Thread::Node)

11. Transmitting messages ( Mail::Transport )
    • Sending (Mail::Transport::Send)
      • Via Exim (Mail::Transport::Exim)
      • Via Mailx (Mail::Transport::Mailx)
      • Via Qmail (Mail::Transport::Qmail)
      • Via Sendmail or Postfix (Mail::Transport::Sendmail)
      • Via raw SMTP (Mail::Transport::SMTP)
    • Receiving (Mail::Transport::Receive)
      • Via POP3 (Mail::Transport::POP3)
    • Bi-directional
      • Via IMAP4 (Mail::Transport::IMAP4)

12. Performance
    • Quality over performance
    • Weak references
    • Reducing memory consumption
      • Lazy extraction
      • Picking the optimal body class
      • Reducing the header size (Mail::Message::Head::Partial)
      • Destructing messages (Mail::Box::Message::Destructed)
      • Helper modules
        • Install Mail::Box::Parser::C
        • MIME::Types
        • Object::Realize::Later
        • User::Identity

REFERENCES

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

COPYRIGHTS

Distribution version 2.047. 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.