NAME¶

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

INHERITANCE¶

 Mail::Box::File::Message
   is a Mail::Box::Message
   is a Mail::Message
   is a Mail::Reporter
 Mail::Box::File::Message is extended by
   Mail::Box::Mbox::Message

SYNOPSIS¶

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

DESCRIPTION¶

Maintain one message in an file based folder, any Mail::Box::File extension.

Extends "DESCRIPTION" in Mail::Box::Message.

METHODS¶

Extends "METHODS" in Mail::Box::Message.

Constructors¶

Extends "Constructors" in Mail::Box::Message.

$obj->clone(%options)

Inherited, see "Constructors" in Mail::Message

$class->new(%options)

Messages in file-based folders use the following options for creation: Improves base, see "Constructors" in Mail::Reporter

 -Option    --Defined in        --Default
  body        Mail::Message       undef
  body_type   Mail::Box::Message  <from folder>
  deleted     Mail::Message       false
  field_type  Mail::Message       undef
  folder      Mail::Box::Message  <required>
  from_line                       undef
  head        Mail::Message       undef
  head_type   Mail::Message       Mail::Message::Head::Complete
  labels      Mail::Message       +{}
  log         Mail::Reporter      'WARNINGS'
  messageId   Mail::Message       undef
  modified    Mail::Message       false
  size        Mail::Box::Message  undef
  trace       Mail::Reporter      'WARNINGS'
  trusted     Mail::Message       false

body => $object
body_type => CODE|$class
deleted => BOOLEAN
field_type => $class
folder => $folder
from_line => $line: The $line which begins each message in the file. Some people detest this line, but this is just how things were invented...
head => $object
head_type => $class
labels => ARRAY|HASH
log => LEVEL
messageId => $id
modified => BOOLEAN
size => $bytes
trace => LEVEL
trusted => BOOLEAN

Attributes¶

Extends "Attributes" in Mail::Box::Message.

$obj->folder( [$folder] ): Inherited, see "Attributes" in Mail::Box::Message
$obj->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.
$obj->logSettings(): Inherited, see "Attributes" in Mail::Reporter
$obj->seqnr( [$integer] ): Inherited, see "Attributes" in Mail::Box::Message

Constructing a message¶

Extends "Constructing a message" in Mail::Box::Message.

$obj->bounce( [<$rg_object|%options>] ): Inherited, see "Constructing a message" in Mail::Message::Construct::Bounce
$class->build( [$message|$part|$body], @fields, %options ): Inherited, see "Constructing a message" in Mail::Message::Construct::Build
$class->buildFromBody($body, [$head], $headers): Inherited, see "Constructing a message" in Mail::Message::Construct::Build
$obj->forward(%options): Inherited, see "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardAttach(%options): Inherited, see "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardEncapsulate(%options): Inherited, see "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardInline(%options): Inherited, see "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardNo(%options): Inherited, see "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardPostlude(): Inherited, see "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardPrelude(): Inherited, see "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardSubject(STRING): Inherited, see "Constructing a message" in Mail::Message::Construct::Forward
$class->read($fh|STRING|SCALAR|ARRAY, %options): Inherited, see "Constructing a message" in Mail::Message::Construct::Read
$obj->rebuild(%options): Inherited, see "Constructing a message" in Mail::Message::Construct::Rebuild
$obj->reply(%options): Inherited, see "Constructing a message" in Mail::Message::Construct::Reply
$obj->replyPrelude( [STRING|$field|$address|ARRAY-$of-$things] ): Inherited, see "Constructing a message" in Mail::Message::Construct::Reply
$any->replySubject(STRING): Inherited, see "Constructing a message" in Mail::Message::Construct::Reply