unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

Mail::Box::IMAP4::HeadUser)Contributed Perl DocumenMail::Box::IMAP4::Head(3pm)



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 "OVERLOADED" in Mail::Message::Head

       overload: bool

           See "OVERLOADED" in Mail::Message::Head

METHODS
       Constructors

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

           See "Constructors" in Mail::Message::Head

       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 "The header" in Mail::Message::Head

       $obj->isEmpty

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

       $obj->isModified

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

       $obj->knownNames

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

       $obj->message([MESSAGE])

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

       $obj->modified([BOOLEAN])

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

       $obj->orderedFields

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

       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 Mail::Message::Head

       About the body

       $obj->guessBodySize

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

       $obj->isMultipart

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

       Internals

       $obj->addNoRealize(FIELD)

           See "Internals" in Mail::Message::Head

       $obj->addOrderedFields(FIELDS)

           See "Internals" in Mail::Message::Head

       $obj->fileLocation

           See "Internals" in Mail::Message::Head

       $obj->load

           See "Internals" in Mail::Message::Head

       $obj->moveLocation(DISTANCE)

           See "Internals" in Mail::Message::Head

       $obj->read(PARSER)

           See "Internals" in Mail::Message::Head

       $obj->setNoRealize(FIELD)

           See "Internals" in Mail::Message::Head

       Error handling

       $obj->AUTOLOAD

           See "Error handling" in Mail::Reporter

       $obj->addReport(OBJECT)

           See "Error handling" in Mail::Reporter

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

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

           See "Error handling" in Mail::Reporter

       $obj->errors

           See "Error handling" in Mail::Reporter

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

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

           See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)

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

           See "Error handling" in Mail::Reporter

       $obj->logSettings

           See "Error handling" in Mail::Reporter

       $obj->notImplemented

           See "Error handling" in Mail::Reporter

       $obj->report([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->reportAll([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->trace([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->warnings

           See "Error handling" in Mail::Reporter

       Cleanup

       $obj->DESTROY

           See "Cleanup" in Mail::Reporter

       $obj->inGlobalDestruction

           See "Cleanup" in Mail::Reporter

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



perl v5.10.0                      2008-04-28       Mail::Box::IMAP4::Head(3pm)