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::ReporterSYNOPSIS
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: ""()
- overload: +0()
- overload: <=>()
- overload: bool()
- overload: cmp()
- overload: stringification()
METHODS
Constructors
- $obj->clone()
- Mail::Message::Field::Date->from(FIELD, OPTIONS)
- 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()
- $obj->length()
- $obj->nrLines()
- $obj->print([FILEHANDLE])
- $obj->size()
- $obj->string([WRAP])
- $obj->toDisclose()
Access to the name
Access to the body
- $obj->body()
- $obj->decodedBody(OPTIONS)
- $obj->folded()
- $obj->foldedBody([BODY])
- $obj->stripCFWS([STRING])
- Mail::Message::Field::Date->stripCFWS([STRING])
- $obj->unfoldedBody([BODY, [WRAP]])
Access to the content
- $obj->addAttribute(...)
-
Attributes are not supported for date fields.
- $obj->addresses()
- $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()
- $obj->comment([STRING])
- $obj->createComment(STRING, OPTIONS)
- Mail::Message::Field::Date->createComment(STRING, OPTIONS)
- $obj->createPhrase(STRING, OPTIONS)
- Mail::Message::Field::Date->createPhrase(STRING, OPTIONS)
- $obj->study()
- $obj->time()
-
Convert date into a timestamp, as produced with POSIX::time().
- $obj->toDate([TIME])
- Mail::Message::Field::Date->toDate([TIME])
- $obj->toInt()
Other methods
Internals
- $obj->consume(LINE | (NAME,BODY|OBJECTS))
- $obj->decode(STRING, OPTIONS)
- Mail::Message::Field::Date->decode(STRING, OPTIONS)
- $obj->defaultWrapLength([LENGTH])
- $obj->encode(STRING, OPTIONS)
- $obj->fold(NAME, BODY, [MAXCHARS])
- Mail::Message::Field::Date->fold(NAME, BODY, [MAXCHARS])
- $obj->setWrapLength([LENGTH])
- $obj->stringifyData(STRING|ARRAY|OBJECTS)
- $obj->unfold(STRING)
Parsing
- $obj->consumeComment(STRING)
- Mail::Message::Field::Date->consumeComment(STRING)
- $obj->consumeDotAtom(STRING)
- $obj->consumePhrase(STRING)
- Mail::Message::Field::Date->consumePhrase(STRING)
- $obj->datum([VALUE])
- $obj->parse(STRING)
- $obj->produceBody()
Error handling
- $obj->AUTOLOAD()
- $obj->addReport(OBJECT)
- $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
- Mail::Message::Field::Date->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
- $obj->errors()
- $obj->log([LEVEL [,STRINGS]])
- Mail::Message::Field::Date->log([LEVEL [,STRINGS]])
- $obj->logPriority(LEVEL)
- Mail::Message::Field::Date->logPriority(LEVEL)
- $obj->logSettings()
- $obj->notImplemented()
- $obj->report([LEVEL])
- $obj->reportAll([LEVEL])
- $obj->trace([LEVEL])
- $obj->warnings()
Cleanup
DIAGNOSTICS
- Warning: Field content is not numerical: $content
-
The numeric value of a field is requested (for instance the
LinesorContent-Lengthfields 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 (
borB) or quoted-printable (qorQ) 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.102, built on January 04, 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