Mail::Message::Field::Date(3)

NAME
Mail::Message::Field::Date - message header field with uris

INHERITANCE
 Mail::Message::Field::Date
   is a Mail::Message::Field::Structured
   is a Mail::Message::Field::Full
   is a Mail::Message::Field
   is a Mail::Reporter

SYNOPSIS
 my $f = Mail::Message::Field->new(Date => time);

DESCRIPTION
Dates are a little more tricky than it should be: the formatting permits a few constructs more than other RFCs use for timestamps. For instance, a small subset of timezone abbreviations are permitted.

The studied date field will reformat the content into a standard form.

OVERLOADED

overload: ""()
    See "OVERLOADED" in Mail::Message::Field

overload: 0+()
    See "OVERLOADED" in Mail::Message::Field

overload: <=>()
    See "OVERLOADED" in Mail::Message::Field

overload: bool()
    See "OVERLOADED" in Mail::Message::Field

overload: cmp()
    See "OVERLOADED" in Mail::Message::Field

overload: stringification()
    See "OVERLOADED" in Mail::Message::Field::Full

METHODS

  Constructors

$obj->clone()
    See "Constructors" in Mail::Message::Field

Mail::Message::Field::Date->from(FIELD, OPTIONS)
    See "Constructors" in Mail::Message::Field::Full

Mail::Message::Field::Date->new(DATA)
     -Option    --Defined in     --Default
      attributes  Mail::Message::Field::Structured  <ignored>
      charset     Mail::Message::Field::Full  undef
      datum       Mail::Message::Field::Structured  undef
      encoding    Mail::Message::Field::Full  'q'
      force       Mail::Message::Field::Full  false
      language    Mail::Message::Field::Full  undef
      log         Mail::Reporter   'WARNINGS'
      trace       Mail::Reporter   'WARNINGS'

    attributes => ATTRS
    charset => STRING
    datum => STRING
    encoding => 'q'|'Q'|'b'|'B'
    force => BOOLEAN
    language => STRING
    log => LEVEL
    trace => LEVEL

    example:

     my $mmfd = 'Mail::Message::Field::Date';
     my $f = $mmfd->new(Date => time);

  The field

$obj->isStructured()
Mail::Message::Field::Date->isStructured()
    See "The field" in Mail::Message::Field

$obj->length()
    See "The field" in Mail::Message::Field

$obj->nrLines()
    See "The field" in Mail::Message::Field

$obj->print([FILEHANDLE])
    See "The field" in Mail::Message::Field

$obj->size()
    See "The field" in Mail::Message::Field

$obj->string([WRAP])
    See "The field" in Mail::Message::Field

$obj->toDisclose()
    See "The field" in Mail::Message::Field

  Access to the name

$obj->Name()
    See "Access to the name" in Mail::Message::Field

$obj->name()
    See "Access to the name" in Mail::Message::Field

$obj->wellformedName([STRING])
    See "Access to the name" in Mail::Message::Field

  Access to the body

$obj->body()
    See "Access to the body" in Mail::Message::Field

$obj->decodedBody(OPTIONS)
    See "Access to the body" in Mail::Message::Field::Full

$obj->folded()
    See "Access to the body" in Mail::Message::Field

$obj->foldedBody([BODY])
    See "Access to the body" in Mail::Message::Field

$obj->stripCFWS([STRING])
Mail::Message::Field::Date->stripCFWS([STRING])
    See "Access to the body" in Mail::Message::Field

$obj->unfoldedBody([BODY, [WRAP]])
    See "Access to the body" in Mail::Message::Field

  Access to the content

$obj->addAttribute(...)
    Attributes are not supported for date fields.

$obj->addresses()
    See "Access to the content" in Mail::Message::Field

$obj->attrPairs()
    See "Access to the content" in Mail::Message::Field::Structured

$obj->attribute(OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS))
    See "Access to the content" in Mail::Message::Field::Structured

$obj->attributes()
    See "Access to the content" in Mail::Message::Field::Structured

$obj->beautify()
    See "Access to the content" in Mail::Message::Field::Full

$obj->comment([STRING])
    See "Access to the content" in Mail::Message::Field

$obj->createComment(STRING, OPTIONS)
Mail::Message::Field::Date->createComment(STRING, OPTIONS)
    See "Access to the content" in Mail::Message::Field::Full

$obj->createPhrase(STRING, OPTIONS)
Mail::Message::Field::Date->createPhrase(STRING, OPTIONS)
    See "Access to the content" in Mail::Message::Field::Full

$obj->study()
    See "Access to the content" in Mail::Message::Field

$obj->time()
    Convert date into a timestamp, as produced with POSIX::time().

$obj->toDate([TIME])
Mail::Message::Field::Date->toDate([TIME])
    See "Access to the content" in Mail::Message::Field

$obj->toInt()
    See "Access to the content" in Mail::Message::Field

  Other methods

$obj->dateToTimestamp(STRING)
Mail::Message::Field::Date->dateToTimestamp(STRING)
    See "Other methods" in Mail::Message::Field

  Internals

$obj->consume(LINE | (NAME,BODY|OBJECTS))
    See "Internals" in Mail::Message::Field

$obj->decode(STRING, OPTIONS)
Mail::Message::Field::Date->decode(STRING, OPTIONS)
    See "Internals" in Mail::Message::Field::Full

$obj->defaultWrapLength([LENGTH])
    See "Internals" in Mail::Message::Field

$obj->encode(STRING, OPTIONS)
    See "Internals" in Mail::Message::Field::Full

$obj->fold(NAME, BODY, [MAXCHARS])
Mail::Message::Field::Date->fold(NAME, BODY, [MAXCHARS])
    See "Internals" in Mail::Message::Field

$obj->setWrapLength([LENGTH])
    See "Internals" in Mail::Message::Field

$obj->stringifyData(STRING|ARRAY|OBJECTS)
    See "Internals" in Mail::Message::Field

$obj->unfold(STRING)
    See "Internals" in Mail::Message::Field

  Parsing

$obj->consumeComment(STRING)
Mail::Message::Field::Date->consumeComment(STRING)
    See "Parsing" in Mail::Message::Field::Full

$obj->consumeDotAtom(STRING)
    See "Parsing" in Mail::Message::Field::Full

$obj->consumePhrase(STRING)
Mail::Message::Field::Date->consumePhrase(STRING)
    See "Parsing" in Mail::Message::Field::Full

$obj->datum([VALUE])
    See "Parsing" in Mail::Message::Field::Structured

$obj->parse(STRING)
    See "Parsing" in Mail::Message::Field::Full

$obj->produceBody()
    See "Parsing" in Mail::Message::Field::Full

  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::Message::Field::Date->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::Message::Field::Date->log([LEVEL [,STRINGS]])
    See "Error handling" in Mail::Reporter

$obj->logPriority(LEVEL)
Mail::Message::Field::Date->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

DIAGNOSTICS

Warning: Field content is not numerical: $content
    The numeric value of a field is requested (for instance the "Lines" or "Content-Length" fields should be numerical), however the data contains weird characters.

Warning: Illegal character in charset '$charset'
    The field is created with an utf8 string which only contains data from the specified character set. However, that character set can never be a valid name because it contains characters which are not permitted.

Warning: Illegal character in field name $name
    A new field is being created which does contain characters not permitted by the RFCs. Using this field in messages may break other e-mail clients or transfer agents, and therefore mutulate or extinguish your message.

Warning: Illegal character in language '$lang'
    The field is created with data which is specified to be in a certain language, however, the name of the language cannot be valid: it contains characters which are not permitted by the RFCs.

Warning: Illegal encoding '$encoding', used 'q'
    The RFCs only permit base64 ("b " or "B ") or quoted-printable ("q" or "Q") encoding. Other than these four options are illegal.

Error: No attributes for date fields.
    Is is not possible to add attributes to date fields: it is not permitted by the RFCs.

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.106, built on August 15, 2012. Website: http://perl.overmeer.net/mailbox/

LICENSE
Copyrights 2001-2012 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