• NAME
• INHERITANCE
• SYNOPSIS
• DESCRIPTION
• OVERLOADED
• METHODS
• Constructors
• The header
• Access to the header
• About the body
• Internals
• Error handling
• Cleanup
• DIAGNOSTICS
• DETAILS
• REFERENCES
• COPYRIGHTS

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 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: ``''

See OVERLOADED in the Mail::Message::Head manpage

overload: bool

See OVERLOADED in the Mail::Message::Head manpage

METHODS

Constructors

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

See Constructors in the Mail::Message::Head manpage

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

 Option        Defined in       Default                                                 
 cache_fields                   C<false>                                                
 field_type    L<Mail::Message::Head>  L<Mail::Message::Field::Fast|Mail::Message::Field::Fast>
 log           L<Mail::Reporter>  C<'WARNINGS'>                                           
 message       L<Mail::Message::Head>  undef                                                   
 modified      L<Mail::Message::Head>  <false>                                                 
 trace         L<Mail::Reporter>  C<'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 The header in the Mail::Message::Head manpage

$obj->isEmpty

See The header in the Mail::Message::Head manpage

$obj->isModified

See The header in the Mail::Message::Head manpage

$obj->knownNames

See The header in the Mail::Message::Head manpage

$obj->message([MESSAGE])

See The header in the Mail::Message::Head manpage

$obj->modified([BOOLEAN])

See The header in the Mail::Message::Head manpage

$obj->orderedFields

See The header in the Mail::Message::Head manpage

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 Access to the header in the Mail::Message::Head manpage

About the body

$obj->guessBodySize

See About the body in the Mail::Message::Head manpage

$obj->isMultipart

See About the body in the Mail::Message::Head manpage

Internals

$obj->addNoRealize(FIELD)

See Internals in the Mail::Message::Head manpage

$obj->addOrderedFields(FIELDS)

See Internals in the Mail::Message::Head manpage

$obj->fileLocation

See Internals in the Mail::Message::Head manpage

$obj->load

See Internals in the Mail::Message::Head manpage

$obj->moveLocation(DISTANCE)

See Internals in the Mail::Message::Head manpage

$obj->read(PARSER)

See Internals in the Mail::Message::Head manpage

$obj->setNoRealize(FIELD)

See Internals in the Mail::Message::Head manpage

Error handling

$obj->AUTOLOAD

See Error handling in the Mail::Reporter manpage

$obj->addReport(OBJECT)

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->errors

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

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

See Error handling in the Mail::Reporter manpage

$obj->logSettings

See Error handling in the Mail::Reporter manpage

$obj->notImplemented

See Error handling in the Mail::Reporter manpage

$obj->report([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->reportAll([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->trace([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->warnings

See Error handling in the Mail::Reporter manpage

Cleanup

$obj->DESTROY

See Cleanup in the Mail::Reporter manpage

$obj->inGlobalDestruction

See Cleanup in the Mail::Reporter manpage

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.059. 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.