Box::Maildir::Message(3)

NAME
Mail::Box::Maildir::Message - one message in a Maildir folder

CLASS HIERARCHY
 Mail::Box::Maildir::Message
 is a Mail::Box::Dir::Message
 is a Mail::Box::Message
 is a Mail::Message + ::Construct
 is a Mail::Reporter

SYNOPSIS
 my $folder = new Mail::Box::Maildir ...
 my $message = $folder->message(10);

DESCRIPTION
A "Mail::Box::Maildir::Message" represents one message in an Maildir-folder. Each message is stored in a separate file.

The bottom of this page provides more details about details about the implementation, but first the use.

METHOD INDEX
Methods prefixed with an abbreviation are described in Mail::Message (MM), Mail::Reporter (MR), Mail::Box::Message (MBM), Mail::Message::Construct (MMC), Mail::Box::Dir::Message (MBDM).

The general methods for "Mail::Box::Maildir::Message" objects:

   MM bcc                              MMC lines
  MMC bounce OPTIONS                    MR log [LEVEL [,STRINGS]]
  MMC build [MESSAGE|BODY], CONTENT     MM messageId
  MMC buildFromBody BODY, HEADERS       MM modified [BOOL]
   MM cc                                   new OPTIONS
  MBM copyTo FOLDER                     MM nrLines
   MM date                              MM parent
   MM decoded OPTIONS                   MM parts ['ALL'|'ACTIVE'|'DELE...
  MBM delete                            MM print [FILEHANDLE]
  MBM deleted [BOOL]                   MMC printStructure [INDENT]
   MM destinations                     MMC read FILEHANDLE|SCALAR|REF-...
   MM encode OPTIONS                   MMC reply OPTIONS
   MR errors                           MMC replyPrelude [STRING|FIELD|...
  MMC file                             MMC replySubject STRING
      filename [FILENAME]               MR report [LEVEL]
  MBM folder [FOLDER]                   MR reportAll [LEVEL]
  MMC forward OPTIONS                   MM send [MAILER], OPTIONS
  MMC forwardPostlude                  MBM seqnr [INTEGER]
  MMC forwardPrelude                   MBM shortString
  MMC forwardSubject STRING             MM size
   MM from                             MMC string
   MM get FIELD                         MM subject
   MM guessTimestamp                    MM timestamp
   MM isDummy                           MM to
   MM isMultipart                       MM toplevel
   MM isPart                            MR trace [LEVEL]
   MM label LABEL [,VALUE [LABEL,...    MR warnings

The extra methods for extension writers:

   MR AUTOLOAD                             labelsToFilename
   MM DESTROY                           MM labelsToStatus
      accept                          MBDM loadHead
   MM body [BODY]                       MR logPriority LEVEL
   MM clone                             MR logSettings
  MBM coerce MESSAGE                    MR notImplemented
 MBDM create FILENAME                 MBDM parser
  MBM diskDelete                       MBM readBody PARSER, HEAD [, BO...
      guessTimestamp                    MM readFromParser PARSER, [BOD...
   MM head [HEAD]                       MM readHead PARSER [,CLASS]
   MR inGlobalDestruction               MM statusToLabels
   MM isDelayed                         MM storeBody BODY
   MM labels                            MM takeMessageId [STRING]

METHODS

new OPTIONS
    Messages in directory-based folders use the following options:

     OPTION      DESCRIBED IN            DEFAULT
     body        Mail::Message           undef
     deleted     Mail::Box::Message      0
     filename    Mail::Box::Dir::Message undef
     folder      Mail::Box::Message      <required>
     head        Mail::Message           undef
     head_wrap   Mail::Message           undef
     log         Mail::Reporter          'WARNINGS'
     messageId   Mail::Message           undef
     modified    Mail::Message           0
     size        Mail::Box::Message      undef
     trace       Mail::Reporter          'WARNINGS'
     trusted     Mail::Message           0

    Only for extension writers:

     OPTION      DESCRIBED IN            DEFAULT
     body_type   Mail::Box::Message      <not used>
     field_type  Mail::Message           undef
     head_type   Mail::Message           'Mail::Message::Head::Complete'

filename [FILENAME]
    Returns the current filename for this message. If the FILENAME argument is specified, a new filename will be set. For maildir messages this means that modifications are immediately performed: there will be a rename (move) from the old name to the new name. Labels may change within in the message object as well.

METHODS for extension writers

accept
    Accept a message for the folder. This will move it from the "new" or "tmp" sub-directories into the "cur" sub-directory. When you accept an already accepted message, nothing will happen.

labelsToFilename
    When the labels on a message change, this may implicate a change in the message's filename. The change will take place immediately.

guessTimestamp
    The filename of a "Mail::Box::Maildir::Message" contains a timestamp. This is a wild guess about the actual time of sending of the message: it is the time of receipt which may be seconds to hours off. But is still a good guess... When the message header is not parsed, then this date is used.

SEE ALSO
Mail::Box-Overview

For support and additional documentation, see http://perl.overmeer.net/mailbox/

AUTHOR
Mark Overmeer (mailbox@overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION
This code is beta, version 2.018.

Copyright (c) 2001-2002 Mark Overmeer. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.