1Mail::Message::Field::AUustehrReCsounlttrsi(b3u)ted PerlMaDiolc:u:mMeenstsaatgieo:n:Field::AuthResults(3)
2
6 Mail::Message::Field::AuthResults - message header field authentication
7 result
8
10 Mail::Message::Field::AuthResults
11 is a Mail::Message::Field::Structured
12 is a Mail::Message::Field::Full
13 is a Mail::Message::Field
14 is a Mail::Reporter
15
17 my $f = Mail::Message::Field->new('Authentication-Results' => '...');
18 my $g = Mail::Message::Field->new('Authentication-Results');
20 $g->addResult(method => 'dkim', result => 'fail');
21
23 Mail Transfer Agents may check the authenticity of an incoming message.
24 They add 'Authentication-Results' headers, maybe more than one. This
25 implementation is based on RFC7601.
26 Extends "DESCRIPTION" in Mail::Message::Field::Structured.
28
30 Extends "OVERLOADED" in Mail::Message::Field::Structured.
31 overload: ""
33 Inherited, see "OVERLOADED" in Mail::Message::Field
34 overload: 0+
36 Inherited, see "OVERLOADED" in Mail::Message::Field
37 overload: <=>
39 Inherited, see "OVERLOADED" in Mail::Message::Field
40 overload: bool
42 Inherited, see "OVERLOADED" in Mail::Message::Field
43 overload: cmp
45 Inherited, see "OVERLOADED" in Mail::Message::Field
46 overload: stringification
48 Inherited, see "OVERLOADED" in Mail::Message::Field::Full
49
51 Extends "METHODS" in Mail::Message::Field::Structured.
52 Constructors
54 Extends "Constructors" in Mail::Message::Field::Structured.
55 $obj->clone()
57 Inherited, see "Constructors" in Mail::Message::Field
58 Mail::Message::Field::AuthResults->from($field, %options)
60 Inherited, see "Constructors" in Mail::Message::Field::Full
61 Mail::Message::Field::AuthResults->new($data)
63 -Option --Defined in --Default
64 attributes Mail::Message::Field::Structured <ignored>
65 charset Mail::Message::Field::Full undef
66 datum Mail::Message::Field::Structured undef
67 encoding Mail::Message::Field::Full 'q'
68 force Mail::Message::Field::Full false
69 language Mail::Message::Field::Full undef
70 log Mail::Reporter 'WARNINGS'
71 results []
72 server <required>
73 trace Mail::Reporter 'WARNINGS'
74 version undef
75 attributes => ATTRS
77 charset => STRING
78 datum => STRING
79 encoding => 'q'|'Q'|'b'|'B'
80 force => BOOLEAN
81 language => STRING
82 log => LEVEL
83 results => ARRAY
84 Each authentication method is represented by a HASH, which
85 contains the 'method' and 'result' keys. Sometimes, there is a
86 'comment'. Properties of form 'ptype.pname' will be there as
87 well.
88 server => DOMAIN
90 Where the authentication tool ran. This should be your local
91 service, otherwise you may accept spoofed headers!
92 trace => LEVEL
94 version => INTEGER
95 The field
97 Extends "The field" in Mail::Message::Field::Structured.
98 $obj->isStructured()
100 Mail::Message::Field::AuthResults->isStructured()
101 Inherited, see "The field" in Mail::Message::Field
102 $obj->length()
104 Inherited, see "The field" in Mail::Message::Field
105 $obj->nrLines()
107 Inherited, see "The field" in Mail::Message::Field
108 $obj->print( [$fh] )
110 Inherited, see "The field" in Mail::Message::Field
111 $obj->size()
113 Inherited, see "The field" in Mail::Message::Field
114 $obj->string( [$wrap] )
116 Inherited, see "The field" in Mail::Message::Field
117 $obj->toDisclose()
119 Inherited, see "The field" in Mail::Message::Field
120 Access to the name
122 Extends "Access to the name" in Mail::Message::Field::Structured.
123 $obj->Name()
125 Inherited, see "Access to the name" in Mail::Message::Field
126 $obj->name()
128 Inherited, see "Access to the name" in Mail::Message::Field
129 $obj->wellformedName( [STRING] )
131 Inherited, see "Access to the name" in Mail::Message::Field
132 Access to the body
134 Extends "Access to the body" in Mail::Message::Field::Structured.
135 $obj->body()
137 Inherited, see "Access to the body" in Mail::Message::Field
138 $obj->decodedBody(%options)
140 Inherited, see "Access to the body" in Mail::Message::Field::Full
141 $obj->folded()
143 Inherited, see "Access to the body" in Mail::Message::Field
144 $obj->foldedBody( [$body] )
146 Inherited, see "Access to the body" in Mail::Message::Field
147 $obj->stripCFWS( [STRING] )
149 Mail::Message::Field::AuthResults->stripCFWS( [STRING] )
150 Inherited, see "Access to the body" in Mail::Message::Field
151 $obj->unfoldedBody( [$body, [$wrap]] )
153 Inherited, see "Access to the body" in Mail::Message::Field
154 Access to the content
156 Extends "Access to the content" in Mail::Message::Field::Structured.
157 $obj->addAttribute(...)
159 Attributes are not supported here.
160 $obj->addResult(HASH|PAIRS)
162 Add new results to this header. Invalid results are ignored.
163 $obj->addresses()
165 Inherited, see "Access to the content" in Mail::Message::Field
166 $obj->attrPairs()
168 Inherited, see "Access to the content" in
169 Mail::Message::Field::Structured
170 $obj->attribute( $object|<STRING, %options>|<$name,$value,%options> )
172 Inherited, see "Access to the content" in
173 Mail::Message::Field::Structured
174 $obj->attributes()
176 Inherited, see "Access to the content" in
177 Mail::Message::Field::Structured
178 $obj->beautify()
180 Inherited, see "Access to the content" in
181 Mail::Message::Field::Full
182 $obj->comment( [STRING] )
184 Inherited, see "Access to the content" in Mail::Message::Field
185 $obj->createComment(STRING, %options)
187 Mail::Message::Field::AuthResults->createComment(STRING, %options)
188 Inherited, see "Access to the content" in
189 Mail::Message::Field::Full
190 $obj->createPhrase(STRING, %options)
192 Mail::Message::Field::AuthResults->createPhrase(STRING, %options)
193 Inherited, see "Access to the content" in
194 Mail::Message::Field::Full
195 $obj->results()
197 Returns a LIST of result HASHes. Each HASH at least contains keys
198 'method', 'method_version', and 'result'.
199 $obj->server()
201 The hostname which ran this authentication tool.
202 $obj->study()
204 Inherited, see "Access to the content" in Mail::Message::Field
205 $obj->toDate( [$time] )
207 Mail::Message::Field::AuthResults->toDate( [$time] )
208 Inherited, see "Access to the content" in Mail::Message::Field
209 $obj->toInt()
211 Inherited, see "Access to the content" in Mail::Message::Field
212 $obj->version()
214 The version of the 'Authentication-Results' header, which may be
215 different from '1' (default) for successors of RFC7601.
216 Other methods
218 Extends "Other methods" in Mail::Message::Field::Structured.
219 $obj->dateToTimestamp(STRING)
221 Mail::Message::Field::AuthResults->dateToTimestamp(STRING)
222 Inherited, see "Other methods" in Mail::Message::Field
223 Internals
225 Extends "Internals" in Mail::Message::Field::Structured.
226 $obj->consume( $line | <$name,<$body|$objects>> )
228 Inherited, see "Internals" in Mail::Message::Field
229 $obj->decode(STRING, %options)
231 Mail::Message::Field::AuthResults->decode(STRING, %options)
232 Inherited, see "Internals" in Mail::Message::Field::Full
233 $obj->defaultWrapLength( [$length] )
235 Inherited, see "Internals" in Mail::Message::Field
236 $obj->encode(STRING, %options)
238 Inherited, see "Internals" in Mail::Message::Field::Full
239 $obj->fold( $name, $body, [$maxchars] )
241 Mail::Message::Field::AuthResults->fold( $name, $body, [$maxchars] )
242 Inherited, see "Internals" in Mail::Message::Field
243 $obj->setWrapLength( [$length] )
245 Inherited, see "Internals" in Mail::Message::Field
246 $obj->stringifyData(STRING|ARRAY|$objects)
248 Inherited, see "Internals" in Mail::Message::Field
249 $obj->unfold(STRING)
251 Inherited, see "Internals" in Mail::Message::Field
252 Parsing
254 Extends "Parsing" in Mail::Message::Field::Structured.
255 $obj->consumeComment(STRING)
257 Mail::Message::Field::AuthResults->consumeComment(STRING)
258 Inherited, see "Parsing" in Mail::Message::Field::Full
259 $obj->consumeDotAtom(STRING)
261 Inherited, see "Parsing" in Mail::Message::Field::Full
262 $obj->consumePhrase(STRING)
264 Mail::Message::Field::AuthResults->consumePhrase(STRING)
265 Inherited, see "Parsing" in Mail::Message::Field::Full
266 $obj->datum( [$value] )
268 Inherited, see "Parsing" in Mail::Message::Field::Structured
269 $obj->parse(STRING)
271 Inherited, see "Parsing" in Mail::Message::Field::Full
272 $obj->produceBody()
274 Inherited, see "Parsing" in Mail::Message::Field::Full
275 Error handling
277 Extends "Error handling" in Mail::Message::Field::Structured.
278 $obj->AUTOLOAD()
280 Inherited, see "Error handling" in Mail::Reporter
281 $obj->addReport($object)
283 Inherited, see "Error handling" in Mail::Reporter
284 $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
286 $callback] )
287 Mail::Message::Field::AuthResults->defaultTrace( [$level]|[$loglevel,
288 $tracelevel]|[$level, $callback] )
289 Inherited, see "Error handling" in Mail::Reporter
290 $obj->errors()
292 Inherited, see "Error handling" in Mail::Reporter
293 $obj->log( [$level, [$strings]] )
295 Mail::Message::Field::AuthResults->log( [$level, [$strings]] )
296 Inherited, see "Error handling" in Mail::Reporter
297 $obj->logPriority($level)
299 Mail::Message::Field::AuthResults->logPriority($level)
300 Inherited, see "Error handling" in Mail::Reporter
301 $obj->logSettings()
303 Inherited, see "Error handling" in Mail::Reporter
304 $obj->notImplemented()
306 Inherited, see "Error handling" in Mail::Reporter
307 $obj->report( [$level] )
309 Inherited, see "Error handling" in Mail::Reporter
310 $obj->reportAll( [$level] )
312 Inherited, see "Error handling" in Mail::Reporter
313 $obj->trace( [$level] )
315 Inherited, see "Error handling" in Mail::Reporter
316 $obj->warnings()
318 Inherited, see "Error handling" in Mail::Reporter
319 Cleanup
321 Extends "Cleanup" in Mail::Message::Field::Structured.
322 $obj->DESTROY()
324 Inherited, see "Cleanup" in Mail::Reporter
325
327 Extends "DETAILS" in Mail::Message::Field::Structured.
328
330 Warning: Field content is not numerical: $content
331 The numeric value of a field is requested (for instance the "Lines"
332 or "Content-Length" fields should be numerical), however the data
333 contains weird characters.
334 Warning: Illegal character in charset '$charset'
336 The field is created with an utf8 string which only contains data
337 from the specified character set. However, that character set can
338 never be a valid name because it contains characters which are not
339 permitted.
340 Warning: Illegal character in field name $name
342 A new field is being created which does contain characters not
343 permitted by the RFCs. Using this field in messages may break
344 other e-mail clients or transfer agents, and therefore mutulate or
345 extinguish your message.
346 Warning: Illegal character in language '$lang'
348 The field is created with data which is specified to be in a
349 certain language, however, the name of the language cannot be
350 valid: it contains characters which are not permitted by the RFCs.
351 Warning: Illegal encoding '$encoding', used 'q'
353 The RFCs only permit base64 ("b " or "B ") or quoted-printable ("q"
354 or "Q") encoding. Other than these four options are illegal.
355 Error: No attributes for Authentication-Results
357 Is is not possible to add attributes to this field.
358 Error: Package $package does not implement $method.
360 Fatal error: the specific package (or one of its superclasses) does
361 not implement this method where it should. This message means that
362 some other related classes do implement this method however the
363 class at hand does not. Probably you should investigate this and
364 probably inform the author of the package.
365
367 This module is part of Mail-Message distribution version 3.007, built
368 on September 03, 2018. Website: http://perl.overmeer.net/CPAN/
369
371 Copyrights 2001-2018 by [Mark Overmeer <markov@cpan.org>]. For other
372 contributors see ChangeLog.
373 This program is free software; you can redistribute it and/or modify it
375 under the same terms as Perl itself. See http://dev.perl.org/licenses/
376perl v5.28.0 2018-09-0M3ail::Message::Field::AuthResults(3)