NAME

Mail::Box::IMAP4::Head - header fields related IMAP interface

INHERITANCE 

 Mail::Box::IMAP4::Head
   is a Mail::Message::Head
   is a Mail::Reporter

SYNOPSIS

DESCRIPTION

This class implements a pure IMAP4 protocol interface, where as little data is retreived from the header as possible. This may look nice to you, but is not sufficient for many tasks. For instance, you cannot removed or modify fields this way.

Change Mail::Box::IMAP4::new(cache_head) to YES or DELAY, to get a message header which is capable of performing all possible games with headers. On the other hand: the other settings are not 100% safe...

OVERLOADED

overload: ""

See Mail::Message::Head/"OVERLOADED"

overload: bool

See Mail::Message::Head/"OVERLOADED"

METHODS

Constructors

$obj->build([PAIR|FIELD]-LIST)

See Mail::Message::Head/"Constructors"

Mail::Box::IMAP4::Head->new(OPTIONS) 

 Option      --Defined in     --Default
 cache_fields                   false
 field_type    Mail::Message::Head  Mail::Message::Field::Fast
 log           Mail::Reporter   'WARNINGS'
 message       Mail::Message::Head  undef
 modified      Mail::Message::Head  <false>
 trace         Mail::Reporter   'WARNINGS'

. cache_fields => BOOLEAN

This is only a read-cache on fields, because this kind of header does not allow writing of fields. See Mail::Box::IMAP4::new(cache_head), this value is set to false for NO and true for PARTIAL..

. field_type => CLASS

. log => LEVEL

. message => MESSAGE

. modified => BOOLEAN

. trace => LEVEL

The header

$obj->isDelayed

See Mail::Message::Head/"The header"

$obj->isEmpty

See Mail::Message::Head/"The header"

$obj->isModified

See Mail::Message::Head/"The header"

$obj->knownNames

See Mail::Message::Head/"The header"

$obj->message([MESSAGE])

See Mail::Message::Head/"The header"

$obj->modified([BOOLEAN])

See Mail::Message::Head/"The header"

$obj->orderedFields

See Mail::Message::Head/"The header"

Access to the header

$obj->get(NAME [,INDEX])

Get the information about the header line NAME. Realization will take place.

$obj->study(NAME [,INDEX])

See Mail::Message::Head/"Access to the header"

About the body

$obj->guessBodySize

See Mail::Message::Head/"About the body"

$obj->isMultipart

See Mail::Message::Head/"About the body"

Internals

$obj->addNoRealize(FIELD)

See Mail::Message::Head/"Internals"

$obj->addOrderedFields(FIELDS)

See Mail::Message::Head/"Internals"

$obj->fileLocation

See Mail::Message::Head/"Internals"

$obj->load

See Mail::Message::Head/"Internals"

$obj->moveLocation(DISTANCE)

See Mail::Message::Head/"Internals"

$obj->read(PARSER)

See Mail::Message::Head/"Internals"

$obj->setNoRealize(FIELD)

See Mail::Message::Head/"Internals"

Error handling

$obj->AUTOLOAD

See Mail::Reporter/"Error handling"

$obj->addReport(OBJECT)

See Mail::Reporter/"Error handling"

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Box::IMAP4::Head->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See Mail::Reporter/"Error handling"

$obj->errors

See Mail::Reporter/"Error handling"

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

Mail::Box::IMAP4::Head->log([LEVEL [,STRINGS]])

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

Mail::Box::IMAP4::Head->logPriority(LEVEL)

See Mail::Reporter/"Error handling"

$obj->logSettings

See Mail::Reporter/"Error handling"

$obj->notImplemented

See Mail::Reporter/"Error handling"

$obj->report([LEVEL])

See Mail::Reporter/"Error handling"

$obj->reportAll([LEVEL])

See Mail::Reporter/"Error handling"

$obj->trace([LEVEL])

See Mail::Reporter/"Error handling"

$obj->warnings

See Mail::Reporter/"Error handling"

Cleanup

$obj->DESTROY

See Mail::Reporter/"Cleanup"

$obj->inGlobalDestruction

See Mail::Reporter/"Cleanup"

DETAILS

DIAGNOSTICS

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.

SEE ALSO

This module is part of Mail-Box distribution version 2.082, built on April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2008 by Mark Overmeer. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html