GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::BOX::IMAP4::HEAD (3)

.ds Aq ’

NAME

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

CONTENTS

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

See documentation in the base class.

OVERLOADED

See documentation in the base class.
overload: <B>‘‘’’B>() See OVERLOADED in Mail::Message::Head
overload: <B>boolB>() See OVERLOADED in Mail::Message::Head

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
Mail::Box::IMAP4::Head-><B>buildB>([PAIR|FIELD]-LIST) See Constructors in Mail::Message::Head
Mail::Box::IMAP4::Head-><B>newB>(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

See documentation in the base class.
$obj-><B>isDelayedB>() See The header in Mail::Message::Head
$obj-><B>isEmptyB>() See The header in Mail::Message::Head
$obj-><B>isModifiedB>() See The header in Mail::Message::Head
$obj-><B>knownNamesB>() See The header in Mail::Message::Head
$obj-><B>messageB>([MESSAGE]) See The header in Mail::Message::Head
$obj-><B>modifiedB>([BOOLEAN]) See The header in Mail::Message::Head
$obj-><B>orderedFieldsB>() See The header in Mail::Message::Head

    Access to the header

See documentation in the base class.
$obj-><B>getB>(NAME [,INDEX]) Get the information about the header line NAME. Realization will take place.
$obj-><B>studyB>(NAME [,INDEX]) See Access to the header in Mail::Message::Head

    About the body

See documentation in the base class.
$obj-><B>guessBodySizeB>() See About the body in Mail::Message::Head
$obj-><B>isMultipartB>() See About the body in Mail::Message::Head

    Internals

See documentation in the base class.
$obj-><B>addNoRealizeB>(FIELD) See Internals in Mail::Message::Head
$obj-><B>addOrderedFieldsB>(FIELDS) See Internals in Mail::Message::Head
$obj-><B>fileLocationB>() See Internals in Mail::Message::Head
$obj-><B>loadB>() See Internals in Mail::Message::Head
$obj-><B>moveLocationB>(DISTANCE) See Internals in Mail::Message::Head
$obj-><B>readB>(PARSER) See Internals in Mail::Message::Head
$obj-><B>setNoRealizeB>(FIELD) See Internals in Mail::Message::Head

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::IMAP4::Head-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Box::IMAP4::Head-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Box::IMAP4::Head-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

DETAILS

See documentation in the base class.

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.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2013 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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::BOX::IMAP4::HEAD (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.