Mail::M...hResults(3)

📦
version 4.04 · 11 versions
, in fedora 44

🎀 Mail::Message::Field::AuthResults

okay bestie, gather round, because this is a Perl user-contributed manual page (section 3 of the docs, iykyk) and it's all about a very specific lil header field. Sit down, hydrate, and let's get into it. 💖

💖 NAME

Mail::Message::Field::AuthResults — message header field authentication result

🦋 INHERITANCE

the family tree, the bloodline, the lineage ✨

 Mail::Message::Field::AuthResults
   is a Mail::Message::Field::Structured
   is a Mail::Message::Field::Full
   is a Mail::Message::Field
   is a Mail::Reporter

✨ SYNOPSIS

here's the vibe in code form, no cap 🫶

 my $f = Mail::Message::Field->new('Authentication-Results' => '...');

 my $g = Mail::Message::Field->new('Authentication-Results');
 $g->addResult(method => 'dkim', result => 'fail');

💅 DESCRIPTION

so basically, Mail Transfer Agents can check whether an incoming message is actually legit, and when they do, they add Authentication-Results headers to it — and like, possibly more than one, because why not. This implementation is based on RFC7601, which is the moment. 📜

It extends "DESCRIPTION" in Mail::Message::Field::Structured.

🎀 OVERLOADED

It extends "OVERLOADED" in Mail::Message::Field::Structured. Here's every overload it carries, bestie:

  • overload: "" stringification — inherited, see "OVERLOADED" in Mail::Message::Field::Full
  • overload: '""' stringification — inherited, see "OVERLOADED" in Mail::Message::Field
  • overload: '0+' numification — inherited, see "OVERLOADED" in Mail::Message::Field
  • overload: '<='> numeric comparison — inherited, see "OVERLOADED" in Mail::Message::Field
  • overload: bool boolean — inherited, see "OVERLOADED" in Mail::Message::Field
  • overload: cmp string comparison — inherited, see "OVERLOADED" in Mail::Message::Field

👑 METHODS

It extends "METHODS" in Mail::Message::Field::Structured.

🌸 Constructors

It extends "Constructors" in Mail::Message::Field::Structured.

  • $obj->clone() — inherited, see "Constructors" in Mail::Message::Field
  • $class->from($field, %options) — inherited, see "Constructors" in Mail::Message::Field::Full
  • $class->new(%options) — inherited, see "METHODS" in Mail::Message::Field::Structured

and here are all the options new takes, with their homes and defaults, verbatim 🫡

 -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
 results                                       []
 server                                        <required>
 version                                       undef
  • attributes => \@attributes|\%attributes — defined in Mail::Message::Field::Structured, default is <ignored>
  • charset => $charset — defined in Mail::Message::Field::Full, default is undef
  • datum => $date — defined in Mail::Message::Field::Structured, default is undef
  • encoding => 'q'|'Q'|'b'|'B' — defined in Mail::Message::Field::Full, default is 'q'
  • force => BOOLEAN — defined in Mail::Message::Field::Full, default is false
  • language => $language — defined in Mail::Message::Field::Full, default is undef
  • results => ARRAY — default is []. Each authentication method is represented by a HASH, which contains the 'method' and 'result' keys. Sometimes, there is a 'comment'. Properties of form 'ptype.pname' will be there as well. 👀
  • server => $domain — where the authentication tool ran. This should be your local service, otherwise you may accept spoofed headers! 🚨
  • version => INTEGER — default is undef
⚠️ bestie, that server one is important: if it's not your local service, you might be accepting spoofed headers. Do not let them lie to you. 💀

🌈 Attributes

It extends "Attributes" in Mail::Message::Field::Structured.

  • $obj->Name() — inherited, see "Attributes" in Mail::Message::Field
  • $obj->body() — inherited, see "Attributes" in Mail::Message::Field
  • $obj->folded() — inherited, see "Attributes" in Mail::Message::Field
  • $obj->foldedBody( [$body] ) — inherited, see "Attributes" in Mail::Message::Field
  • $obj->name() — inherited, see "Attributes" in Mail::Message::Field
  • $obj->unfoldedBody( [$body, [$wrap]] ) — inherited, see "Attributes" in Mail::Message::Field
  • $obj->wellformedName( [STRING] ) — inherited, see "Attributes" in Mail::Message::Field

🦋 The field

It extends "The field" in Mail::Message::Field::Structured.

  • $any->isStructured( [$name] ) — inherited, see "The field" in Mail::Message::Field
  • $obj->length() — inherited, see "The field" in Mail::Message::Field
  • $obj->nrLines() — inherited, see "The field" in Mail::Message::Field
  • $obj->print( [$fh] ) — inherited, see "The field" in Mail::Message::Field
  • $obj->size() — inherited, see "The field" in Mail::Message::Field
  • $obj->string( [$wrap] ) — inherited, see "The field" in Mail::Message::Field
  • $obj->toDisclose() — inherited, see "The field" in Mail::Message::Field

💜 Access to the body

It extends "Access to the body" in Mail::Message::Field::Structured.

  • $obj->decodedBody(%options) — inherited, see "Access to the body" in Mail::Message::Field::Full

🍓 Access to the content

It extends "Access to the content" in Mail::Message::Field::Structured.

  • $obj->addAttribute(...) — attributes are not supported here. Not the vibe. 🙅
  • $obj->addResult(HASH|PAIRS) — add new results to this header. Invalid results are ignored. ✨
  • $obj->addresses() — inherited, see "Access to the content" in Mail::Message::Field
  • $obj->attrPairs() — inherited, see "Access to the content" in Mail::Message::Field::Structured
  • $obj->attribute( $object|<STRING, %options>|<$name,$value,%options> ) — inherited, see "Access to the content" in Mail::Message::Field::Structured
  • $obj->attributes() — inherited, see "Access to the content" in Mail::Message::Field::Structured
  • $obj->beautify() — inherited, see "Access to the content" in Mail::Message::Field::Full
  • $obj->comment( [STRING] ) — inherited, see "Access to the content" in Mail::Message::Field
  • $any->createComment(STRING, %options) — inherited, see "Access to the content" in Mail::Message::Field::Full
  • $any->createPhrase(STRING, %options) — inherited, see "Access to the content" in Mail::Message::Field::Full
  • $any->dateToTimestamp(STRING) — inherited, see "Access to the content" in Mail::Message::Field
  • $obj->results() — returns a LIST of result HASHes. Each HASH at least contains keys 'method', 'method_version', and 'result'. 📋
  • $obj->server() — the hostname which ran this authentication tool. 🖥️
  • $any->stripCFWS( [STRING] ) — inherited, see "Access to the content" in Mail::Message::Field
  • $obj->study() — inherited, see "Access to the content" in Mail::Message::Field
  • $any->toDate( [$time] ) — inherited, see "Access to the content" in Mail::Message::Field
  • $obj->toInt() — inherited, see "Access to the content" in Mail::Message::Field
  • $obj->version() — the version of the 'Authentication-Results' header, which may be different from '1' (default) for successors of RFC7601. 👑

🧚 Internals

It extends "Internals" in Mail::Message::Field::Structured.

  • $any->decode(STRING, %options) — inherited, see "Internals" in Mail::Message::Field::Full
  • $obj->encode(STRING, %options) — inherited, see "Internals" in Mail::Message::Field::Full

🌟 Parsing

It extends "Parsing" in Mail::Message::Field::Structured.

  • $obj->consume( $line | <$name,<$body|$objects>> ) — inherited, see "Parsing" in Mail::Message::Field
  • $any->consumeComment(STRING) — inherited, see "Parsing" in Mail::Message::Field::Full
  • $obj->consumeDotAtom(STRING) — inherited, see "Parsing" in Mail::Message::Field::Full
  • $any->consumePhrase(STRING) — inherited, see "Parsing" in Mail::Message::Field::Full
  • $obj->datum( [$value] ) — inherited, see "Parsing" in Mail::Message::Field::Structured
  • $obj->defaultWrapLength( [$length] ) — inherited, see "Parsing" in Mail::Message::Field
  • $any->fold( $name, $body, [$maxchars] ) — inherited, see "Parsing" in Mail::Message::Field
  • $obj->parse(STRING) — inherited, see "Parsing" in Mail::Message::Field::Full
  • $obj->produceBody() — inherited, see "Parsing" in Mail::Message::Field::Full
  • $obj->setWrapLength( [$length] ) — inherited, see "Parsing" in Mail::Message::Field
  • $obj->stringifyData(STRING|ARRAY|$objects) — inherited, see "Parsing" in Mail::Message::Field
  • $obj->unfold(STRING) — inherited, see "Parsing" in Mail::Message::Field

🩷 Error handling

It extends "Error handling" in Mail::Message::Field::Structured.

  • $obj->AUTOLOAD() — inherited, see "Error handling" in Mail::Reporter
  • $obj->notImplemented() — inherited, see "Error handling" in Mail::Reporter

🧼 Cleanup

It extends "Cleanup" in Mail::Message::Field::Structured.

  • $obj->DESTROY() — inherited, see "Cleanup" in Mail::Reporter

🌈 DETAILS

It extends "DETAILS" in Mail::Message::Field::Structured.

💀 DIAGNOSTICS

okay here's the part where things go wrong, and bestie, we love a well-documented crisis 💅

  • Error: class $package does not implement method $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. Cast by notImplemented()
  • 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. Cast by toInt()
  • Error: field name too long (max $count), in '$name'. — it is not specified in the RFCs how long a field name can be, but at least it should be a few characters shorter than the line wrap. Cast by fold()
  • Warning: illegal character in charset '$name'. — 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. Cast by encode()
  • 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. Yes really, it says mutulate. Cast by consume()
  • Warning: illegal character in language '$name'. — 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. Cast by encode()
  • Warning: illegal encoding '$name', using 'q'. — the RFCs only permit base64 ("b " or "B ") or quoted-printable ("q" or "Q") encoding. Other than these four options are illegal. Cast by encode()
  • Error: no attributes for Authentication-Results. — is is not possible to add attributes to this field. Cast by addAttribute()

⭐ SEE ALSO

This module is part of Mail-Message version 4.04, built on February 04, 2026. Website: http://perl.overmeer.net/CPAN/ 🌐

💖 LICENSE 💖

okay so bestie, the legal tea ☕ — if you're one of the gorgeous humans who contributed to this, peep the file ChangeLog for the receipts 🫶

This software is copyright (c) 2001-2026 by Mark Overmeer. yep, that's the whole glow-up era, two decades plus of main character energy 👑

It's free software babes ✨ — you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. that's it, that's the vibe. no cap, no secret fine print, just the classic Perl license situation 💅

ngl that's the whole page — you ate it, you finished it, iconic behavior fr fr 🎀

so yeah, this was Mail::M...hResults(3), brought to you by perl v5.42.0 and dated 2026-02-05. go forth and slay, bestie 🌸🦋💜

📦 where this page comes from