NAME
Mail::Box::IMAP4::Head - header fields related IMAP interface
INHERITANCE
Mail::Box::IMAP4::Head
is a Mail::Message::Head
is a Mail::ReporterSYNOPSIS
DESCRIPTION
This class implements a pure IMAP4 protocol interface, where as few 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: ""
overload: bool
METHODS
Constructors
$obj->build([PAIR|FIELD]-LIST)
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
$obj->isEmpty
$obj->isModified
$obj->knownNames
$obj->message([MESSAGE])
$obj->modified([BOOLEAN])
$obj->orderedFields
Access to the header
$obj->get(NAME [,INDEX])
Get the information about the header line NAME. Realization will take place.
$obj->study(NAME [,INDEX])
About the body
$obj->guessBodySize
$obj->isMultipart
Internals
$obj->addNoRealize(FIELD)
$obj->addOrderedFields(FIELDS)
$obj->fileLocation
$obj->load
$obj->moveLocation(DISTANCE)
$obj->read(PARSER)
$obj->setNoRealize(FIELD)
Error handling
$obj->AUTOLOAD
$obj->addReport(OBJECT)
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::IMAP4::Head->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Box::IMAP4::Head->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Box::IMAP4::Head->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
Cleanup
$obj->DESTROY
$obj->inGlobalDestruction
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.
DETAILS
REFERENCES
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
COPYRIGHTS
Distribution version 2.067. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2006 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.