The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Mail-Box-2.041
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Box::POP3::Message

NAME

Mail::Box::POP3::Message - one message on a POP3 server

INHERITANCE

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

SYNOPSIS

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

DESCRIPTION

A Mail::Box::POP3::Message represents one message on a POP3 server, maintained by a Mail::Box::POP3 folder. Each message is stored as separate entity on the server, and maybe temporarily in your program as well.

METHODS

Constructors

$obj->clone

Mail::Box::POP3::Message->coerce(MESSAGE)

Mail::Box::POP3::Message->new(OPTIONS)

     Option      Defined in       Default                                                       
 body        L<Mail::Message>  undef                                                         
 body_type   L<Mail::Box::Message>  L<Mail::Message::Body::Lines|Mail::Message::Body::Lines>      
 deleted     L<Mail::Box::Message>  <false>                                                       
 field_type  L<Mail::Message>  undef                                                         
 folder      L<Mail::Box::Message>  <required>                                                    
 head        L<Mail::Message>  undef                                                         
 head_type   L<Mail::Message>  L<Mail::Message::Head::Complete|Mail::Message::Head::Complete>
 log         L<Mail::Reporter>  C<'WARNINGS'>                                                 
 messageId   L<Mail::Message>  undef                                                         
 modified    L<Mail::Message>  <false>                                                       
 size        L<Mail::Box::Message>  undef                                                         
 trace       L<Mail::Reporter>  C<'WARNINGS'>                                                 
 trusted     L<Mail::Message>  <false>                                                       
 unique      L<Mail::Box::Net::Message>  <unique string>

    . body OBJECT

    . body_type CODE|CLASS

    . deleted BOOLEAN

    . field_type CLASS

    . folder FOLDER

    . head OBJECT

    . head_type CLASS

    . log LEVEL

    . messageId STRING

    . modified BOOLEAN

    . size INTEGER

    . trace LEVEL

    . trusted BOOLEAN

    . unique STRING

Constructing a message

$obj->bounce([RG-OBJECT|OPTIONS])

Mail::Box::POP3::Message->build([MESSAGE|BODY], CONTENT)

Mail::Box::POP3::Message->buildFromBody(BODY, [HEAD], HEADERS)

$obj->forward(OPTIONS)

$obj->forwardPostlude

$obj->forwardPrelude

$obj->forwardSubject(STRING)

Mail::Box::POP3::Message->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)

$obj->rebuild(OPTIONS)

$obj->reply(OPTIONS)

$obj->replyPrelude([STRING|FIELD|ADDRESS])

$obj->replySubject(STRING)

Mail::Box::POP3::Message->replySubject(STRING)

The Message

$obj->container

$obj->copyTo(FOLDER)

$obj->folder([FOLDER])

$obj->isDummy

$obj->isPart

$obj->messageId

$obj->moveTo(FOLDER)

$obj->print([FILEHANDLE])

$obj->send([MAILER], OPTIONS)

$obj->seqnr([INTEGER])

$obj->size

    Returns the size of this message. If the message is still on the remote server, POP is used to ask for the size. When the message is already loaded onto the local system, the size of the parsed message is taken. These sizes can differ because the difference in line-ending representation.

$obj->toplevel

$obj->unique([STRING])

$obj->write([FILEHANDLE])

The header

$obj->bcc

$obj->cc

$obj->date

$obj->destinations

$obj->from

$obj->get(FIELD)

$obj->guessTimestamp

$obj->head([HEAD])

$obj->nrLines

$obj->sender

$obj->subject

$obj->timestamp

$obj->to

The body

$obj->body([BODY])

$obj->decoded(OPTIONS)

$obj->encode(OPTIONS)

$obj->isMultipart

$obj->isNested

$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])

Flags

$obj->delete

$obj->deleted([BOOLEAN])

$obj->isDeleted

$obj->isModified

$obj->label(LABEL [,VALUE [LABEL, VALUE] ])

$obj->labels

$obj->labelsToStatus

$obj->modified([BOOLEAN])

$obj->statusToLabels

The whole message as text

$obj->file

$obj->lines

$obj->printStructure([FILEHANDLE][, INDENT])

$obj->string

Internals

$obj->diskDelete

$obj->isDelayed

$obj->loadBody

$obj->readBody(PARSER, HEAD [, BODYTYPE])

$obj->readFromParser(PARSER, [BODYTYPE])

$obj->readHead(PARSER [,CLASS])

$obj->recursiveRebuildPart(PART, OPTIONS)

$obj->storeBody(BODY)

$obj->takeMessageId([STRING])

Error handling

$obj->AUTOLOAD

$obj->defaultTrace([LEVEL, [LEVEL])

Mail::Box::POP3::Message->defaultTrace([LEVEL, [LEVEL])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Box::POP3::Message->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Box::POP3::Message->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->shortString

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->inGlobalDestruction

DIAGNOSTICS

Error: Cannot include forward source as $include.

Unknown alternative for the forward(include). Valid choices are NO, INLINE, and ATTACH.

Error: Cannot include reply source as $include.

Unknown alternative for the include option of reply(). Valid choices are NO, INLINE, and ATTACH.

Error: No address to create forwarded to.

If a forward message is created, a destination address must be specified.

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.

Error: Package $package does not implement $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.

Error: Unable to read delayed body.

Error: Unable to read delayed head.

Error: no rebuild rule $name defined.

DETAILS

REFERENCES

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

COPYRIGHTS

Module version 2.041. 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.