Mail::Box::Net::Message(3)

NAME
Mail::Box::Net::Message - one message from a distant folder

INHERITANCE
 Mail::Box::Net::Message
   is a Mail::Box::Message
   is a Mail::Message
   is a Mail::Reporter

 Mail::Box::Net::Message is extended by
   Mail::Box::IMAP4::Message
   Mail::Box::POP3::Message

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

DESCRIPTION
A Mail::Box::Net::Message represents one message in a folder which can only be accessed via some kind of protocol. On this moment, only a POP3 client is available. IMAP, DBI, and NNTP are other candidates.

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)
    Inherited, 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>
      head        Mail::Message       undef
      head_type   Mail::Message       Mail::Message::Head::Complete
      labels      Mail::Message       +{}
      messageId   Mail::Message       undef
      message_id  Mail::Message       undef
      modified    Mail::Message       false
      size        Mail::Box::Message  undef
      trusted     Mail::Message       false
      unique                          <unique string>

    body => $object
    body_type => CODE|$class
    deleted => BOOLEAN
    field_type => $class
    folder => $folder
    head => $object
    head_type => $class
    labels => \@pairs|\%settings
    messageId => $id
    message_id => $id
    modified => BOOLEAN
    size => $bytes
    trusted => BOOLEAN
    unique => STRING
        The unique keys which identifies this message on the remote server.

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

$obj->bodyType()
    Inherited, see "Attributes" in Mail::Message

$obj->fieldType()
    Inherited, see "Attributes" in Mail::Message

$obj->folder( [$folder] )
    Inherited, see "Attributes" in Mail::Box::Message

$obj->headType()
    Inherited, see "Attributes" in Mail::Message

$obj->messageId()
    Inherited, see "Attributes" in Mail::Message

$obj->seqnr( [$integer] )
    Inherited, see "Attributes" in Mail::Box::Message

$obj->unique( [STRING|undef] )
    Returns the name of the file in which this message is actually stored. This will return "undef" when the message is not stored in a file. When a "STRING" is specified, a new identifier is stored first.

  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|$text|\$text|\@lines, %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|\@addrs|\@fields] )
    Inherited, see "Constructing a message" in Mail::Message::Construct::Reply

$any->replySubject(STRING)
    Inherited, see "Constructing a message" in Mail::Message::Construct::Reply

  The message
Extends "The message" in Mail::Box::Message.

$obj->container()
    Inherited, see "The message" in Mail::Message

$obj->copyTo($folder, %options)
    Inherited, see "The message" in Mail::Box::Message

$obj->endsOnNewline()
    Inherited, see "The message" in Mail::Message

$obj->isDummy()
    Inherited, see "The message" in Mail::Message

$obj->isPart()
    Inherited, see "The message" in Mail::Message

$obj->moveTo($folder, %options)
    Inherited, see "The message" in Mail::Box::Message

$obj->partNumber()
    Inherited, see "The message" in Mail::Message

$obj->print( [$fh] )
    Inherited, see "The message" in Mail::Message

$obj->send( [$mailer], %options )
    Inherited, see "The message" in Mail::Message

$obj->size()
    Inherited, see "The message" in Mail::Message

$obj->toplevel()
    Inherited, see "The message" in Mail::Message

$obj->write( [$fh] )
    Inherited, see "The message" in Mail::Message

  The header
Extends "The header" in Mail::Box::Message.

$obj->bcc()
    Inherited, see "The header" in Mail::Message

$obj->cc()
    Inherited, see "The header" in Mail::Message

$obj->date()
    Inherited, see "The header" in Mail::Message

$obj->destinations()
    Inherited, see "The header" in Mail::Message

$obj->from()
    Inherited, see "The header" in Mail::Message

$obj->get($fieldname)
    Inherited, see "The header" in Mail::Message

$obj->guessTimestamp()
    Inherited, see "The header" in Mail::Message

$obj->head( [$head] )
    Inherited, see "The header" in Mail::Message

$obj->nrLines()
    Inherited, see "The header" in Mail::Message

$obj->sender()
    Inherited, see "The header" in Mail::Message

$obj->study($fieldname)
    Inherited, see "The header" in Mail::Message

$obj->subject()
    Inherited, see "The header" in Mail::Message

$obj->timestamp()
    Inherited, see "The header" in Mail::Message

$obj->to()
    Inherited, see "The header" in Mail::Message

  The body
Extends "The body" in Mail::Box::Message.

$obj->body( [$body] )
    Inherited, see "The body" in Mail::Message

$obj->contentType()
    Inherited, see "The body" in Mail::Message

$obj->decoded(%options)
    Inherited, see "The body" in Mail::Message

$obj->encode(%options)
    Inherited, see "The body" in Mail::Message

$obj->isMultipart()
    Inherited, see "The body" in Mail::Message

$obj->isNested()
    Inherited, see "The body" in Mail::Message

$obj->parts( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
    Inherited, see "The body" in Mail::Message

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

$obj->delete()
    Inherited, see "Flags" in Mail::Message

$obj->deleted( [BOOLEAN] )
    Inherited, see "Flags" in Mail::Message

$obj->isDeleted()
    Inherited, see "Flags" in Mail::Message

$obj->isModified()
    Inherited, see "Flags" in Mail::Message

$obj->label($label|PAIRS)
    Inherited, see "Flags" in Mail::Message

$obj->labels()
    Inherited, see "Flags" in Mail::Message

$obj->labelsToStatus()
    Inherited, see "Flags" in Mail::Message

$obj->modified( [BOOLEAN] )
    Inherited, see "Flags" in Mail::Message

$obj->statusToLabels()
    Inherited, see "Flags" in Mail::Message

  The whole message as text
Extends "The whole message as text" in Mail::Box::Message.

$obj->file()
    Inherited, see "The whole message as text" in Mail::Message::Construct::Text

$obj->lines()
    Inherited, see "The whole message as text" in Mail::Message::Construct::Text

$obj->printStructure( [$fh|undef],[$indent] )
    Inherited, see "The whole message as text" in Mail::Message::Construct::Text

$obj->string()
    Inherited, see "The whole message as text" in Mail::Message::Construct::Text

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

$obj->clonedFrom()
    Inherited, see "Internals" in Mail::Message

$class->coerce($message, %options)
    Inherited, see "Internals" in Mail::Message

$obj->diskDelete()
    Inherited, see "Internals" in Mail::Box::Message

$obj->isDelayed()
    Inherited, see "Internals" in Mail::Message

$obj->isTrusted()
    Inherited, see "Internals" in Mail::Message

$obj->loadBody()

$obj->readBody( $parser, $head, [$bodytype] )
    Inherited, see "Internals" in Mail::Box::Message

$obj->readFromParser( $parser, [$bodytype] )
    Inherited, see "Internals" in Mail::Message

$obj->readHead( $parser, [$class] )
    Inherited, see "Internals" in Mail::Message

$obj->recursiveRebuildPart($part, %options)
    Inherited, see "Internals" in Mail::Message::Construct::Rebuild

$obj->storeBody($body)
    Inherited, see "Internals" in Mail::Message

$obj->takeMessageId( [STRING] )
    Inherited, see "Internals" in Mail::Message

  Error handling
Extends "Error handling" in Mail::Box::Message.

$obj->AUTOLOAD()
    Inherited, see "METHODS" in Mail::Message::Construct

$obj->notImplemented()
    Inherited, see "Error handling" in Mail::Reporter

$any->shortSize( [$value] )
    Inherited, see "Error handling" in Mail::Message

$obj->shortString()
    Inherited, see "Error handling" in Mail::Message

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

$obj->DESTROY()
    Inherited, see "Cleanup" in Mail::Reporter

$obj->destruct()
    Inherited, see "Cleanup" in Mail::Box::Message

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

DIAGNOSTICS

Error: Cannot include forward source as $kind.
    Unknown alternative for the forward(include). Valid choices are "NO", "INLINE", "ATTACH", and "ENCAPSULATE". Cast by forward()

Error: No default mailer found to send message.
    The message send() mechanism had not enough information to automatically find a mail transfer agent to sent this message. Specify a mailer explicitly using the "via" options. Cast by send()

Error: cannot coerce a $type object into a $me object.
    Cast by coerce()

Error: cannot include reply source as $kind.
    Unknown alternative for the "include" option of reply(). Valid choices are "NO", "INLINE", and "ATTACH". Cast by reply()

Error: cannot read message from a $source.
    Cast by read()

Error: class $package does not implement method $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. Cast by notImplemented()

Error: coercion starts with some object, not '$type'.
    Cast by coerce()

Error: method bounce requires To, Cc, or Bcc.
    The message bounce() method forwards a received message off to someone else without modification; you must specified it's new destination. If you have the urge not to specify any destination, you probably are looking for reply(). When you wish to modify the content, use forward(). Cast by bounce()

Error: method forwardAttach requires a preamble.
    Cast by forwardAttach()

Error: method forwardEncapsulate requires a preamble.
    Cast by forwardEncapsulate()

Error: method forwardNo requires a To.
    Cast by forwardNo()

Error: method forwardNo requires a body.
    Cast by forwardNo()

Error: no rebuild rule $name defined.
    Cast by rebuild()

Error: only build() Mail::Message's; they are not in a folder yet.
    You may wish to construct a message to be stored in a some kind of folder, but you need to do that in two steps. First, create a normal Mail::Message, and then add it to the folder. During this Mail::Box::addMessage() process, the message will get coerce()-d into the right message type, adding storage information and the like. Cast by build()

Error: please install Email::Simple.
    Cast by coerce()

Error: please install MIME::Entity.
    Cast by coerce()

Error: please install Mail::Internet.
    Cast by coerce()

Error: select parts via '$what'?
    Cast by parts()

Warning: skipped unknown key '$key' in build.
    Cast by build()

Error: unable to read delayed body for $msgid.
    Cast by loadBody()

Error: unable to read delayed head for $msgid.
    Cast by loadBody()

SEE ALSO
This module is part of Mail-Box version 4.02, built on April 10, 2026. Website: http://perl.overmeer.net/CPAN/

LICENSE
For contributors see file ChangeLog.

This software is copyright (c) 2001-2026 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.