Box::Mbox::Message(3)

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

CLASS HIERARCHY
 Mail::Box::Mbox::Message
 is a Mail::Box::Message
 is a Mail::Message + ::Construct
 is a Mail::Reporter

SYNOPSIS
 my $folder  = new Mail::Box::Mbox folder => $ENV{MAIL}, ...;
 my $message = $folder->message(0);

DESCRIPTION
Maintain one message in an Mbox folder. See the "Mail::Message" documentation for exceptions and extensions to messages which are Mbox-specific on this page.

The bottom of this page provides more 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).

The general methods for "Mail::Box::Mbox::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                               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
  MBM folder [FOLDER]                   MR report [LEVEL]
  MMC forward OPTIONS                   MR reportAll [LEVEL]
  MMC forwardPostlude                   MM send [MAILER], OPTIONS
  MMC forwardPrelude                   MBM seqnr [INTEGER]
  MMC forwardSubject STRING            MBM shortString
   MM from                              MM size
      fromLine [LINE]                  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                             loadBody
   MM DESTROY                           MR logPriority LEVEL
   MM body [BODY]                       MR logSettings
   MM clone                                moveLocation DISTANCE
  MBM coerce MESSAGE                    MR notImplemented
  MBM diskDelete                           read PARSER
      fileLocation                     MBM readBody PARSER, HEAD [, BO...
   MM head [HEAD]                       MM readFromParser PARSER, [BOD...
   MR inGlobalDestruction               MM readHead PARSER [,CLASS]
   MM isDelayed                         MM statusToLabels
   MM labels                            MM storeBody BODY
   MM labelsToStatus                    MM takeMessageId [STRING]

METHODS

new OPTIONS
    Messages in file-based folders use the following options for creation:

     OPTION        DESCRIBED IN          DEFAULT
     body          Mail::Message         undef
     deleted       Mail::Box::Message    0
     folder        Mail::Box::Message    <required>
     head          Mail::Message         undef
     head_wrap     Mail::Message         72
     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    <defined by folder>
     field_type    Mail::Message         undef
     head_type     Mail::Message         'Mail::Message::Head::Complete'

    * from_line STRING
        The line which begins each message in the file. Some people detest this line, but this is just how things were invented...

fromLine [LINE]
    Many people detest file-style folders because they store messages all in one file, where a line starting with "From " leads the header. If we receive a message from a file-based folder, we store that line. If we write to such a file, but there is no such line stored, then we try to generate one.

    If LINE is provided, then the starting line is set to this value.

print [FILEHANDLE]
    Write one message to a file handle. Unmodified messages are taken from the folder-file where they were stored. Modified messages are written to memory. Specify a FILEHANDLE to write to (defaults to the selected handle).

METHODS for extension writers

read PARSER
    Read one message from a Mbox folder, including the message separator. See "Mail::Message::read()" for more details.

loadBody
fileLocation
    Returns the location of the whole message including the from-line. In LIST context, both begin and end are returned. In SCALAR context, only the begin is passed back.

moveLocation DISTANCE
    The message is relocated in the file, being moved over DISTANCE bytes. Setting a new location will update the according information in the header and body.

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.