Mail::Message::Field::DKIM(3pm)

1Mail::Message::Field::DUKsIeMr(3C)ontributed Perl DocumeMnatialt:i:oMnessage::Field::DKIM(3)
2
3
4

NAME

6       Mail::Message::Field::DKIM - message header field for dkim signatures
7

INHERITANCE

9        Mail::Message::Field::DKIM
10          is a Mail::Message::Field::Structured
11          is a Mail::Message::Field::Full
12          is a Mail::Message::Field
13          is a Mail::Reporter
14

SYNOPSIS

16        my $f = Mail::Message::Field->new('DKIM-Signature' => '...');
17
18        my $g = Mail::Message::Field->new('DKIM-Signature');
19        $g->add...
20

DESCRIPTION

22       Decode the information contained in a DKIM header.  You can also
23       construct DKIM-Signature headers this way.  However, verification and
24       signing is not yet implemented.
25
26       This implementation is based on RFC6376.
27
28       Extends "DESCRIPTION" in Mail::Message::Field::Structured.
29

OVERLOADED

31       Extends "OVERLOADED" in Mail::Message::Field::Structured.
32
33       overload: ""
34           Inherited, see "OVERLOADED" in Mail::Message::Field
35
36       overload: 0+
37           Inherited, see "OVERLOADED" in Mail::Message::Field
38
39       overload: <=>
40           Inherited, see "OVERLOADED" in Mail::Message::Field
41
42       overload: bool
43           Inherited, see "OVERLOADED" in Mail::Message::Field
44
45       overload: cmp
46           Inherited, see "OVERLOADED" in Mail::Message::Field
47
48       overload: stringification
49           Inherited, see "OVERLOADED" in Mail::Message::Field::Full
50

METHODS

52       Extends "METHODS" in Mail::Message::Field::Structured.
53
54   Constructors
55       Extends "Constructors" in Mail::Message::Field::Structured.
56
57       $obj->clone()
58           Inherited, see "Constructors" in Mail::Message::Field
59
60       Mail::Message::Field::DKIM->from($field, %options)
61           Inherited, see "Constructors" in Mail::Message::Field::Full
62
63       Mail::Message::Field::DKIM->new($data)
64            -Option    --Defined in                      --Default
65             attributes  Mail::Message::Field::Structured  <ignored>
66             charset     Mail::Message::Field::Full        undef
67             datum       Mail::Message::Field::Structured  undef
68             encoding    Mail::Message::Field::Full        'q'
69             force       Mail::Message::Field::Full        false
70             language    Mail::Message::Field::Full        undef
71             log         Mail::Reporter                    'WARNINGS'
72             trace       Mail::Reporter                    'WARNINGS'
73
74           attributes => ATTRS
75           charset => STRING
76           datum => STRING
77           encoding => 'q'|'Q'|'b'|'B'
78           force => BOOLEAN
79           language => STRING
80           log => LEVEL
81           trace => LEVEL
82
83   The field
84       Extends "The field" in Mail::Message::Field::Structured.
85
86       $obj->isStructured()
87       Mail::Message::Field::DKIM->isStructured()
88           Inherited, see "The field" in Mail::Message::Field
89
90       $obj->length()
91           Inherited, see "The field" in Mail::Message::Field
92
93       $obj->nrLines()
94           Inherited, see "The field" in Mail::Message::Field
95
96       $obj->print( [$fh] )
97           Inherited, see "The field" in Mail::Message::Field
98
99       $obj->size()
100           Inherited, see "The field" in Mail::Message::Field
101
102       $obj->string( [$wrap] )
103           Inherited, see "The field" in Mail::Message::Field
104
105       $obj->toDisclose()
106           Inherited, see "The field" in Mail::Message::Field
107
108   Access to the name
109       Extends "Access to the name" in Mail::Message::Field::Structured.
110
111       $obj->Name()
112           Inherited, see "Access to the name" in Mail::Message::Field
113
114       $obj->name()
115           Inherited, see "Access to the name" in Mail::Message::Field
116
117       $obj->wellformedName( [STRING] )
118           Inherited, see "Access to the name" in Mail::Message::Field
119
120   Access to the body
121       Extends "Access to the body" in Mail::Message::Field::Structured.
122
123       $obj->body()
124           Inherited, see "Access to the body" in Mail::Message::Field
125
126       $obj->decodedBody(%options)
127           Inherited, see "Access to the body" in Mail::Message::Field::Full
128
129       $obj->folded()
130           Inherited, see "Access to the body" in Mail::Message::Field
131
132       $obj->foldedBody( [$body] )
133           Inherited, see "Access to the body" in Mail::Message::Field
134
135       $obj->stripCFWS( [STRING] )
136       Mail::Message::Field::DKIM->stripCFWS( [STRING] )
137           Inherited, see "Access to the body" in Mail::Message::Field
138
139       $obj->unfoldedBody( [$body, [$wrap]] )
140           Inherited, see "Access to the body" in Mail::Message::Field
141
142   Access to the content
143       Extends "Access to the content" in Mail::Message::Field::Structured.
144
145       $obj->addAttribute(...)
146           Attributes are not supported here.
147
148       $obj->addTag($name, $value|@values)
149           Add a tag to the set.  When the tag already exists, it is replaced.
150           Names are (converted to) lower-case.  When multiple values are
151           given, they will be concatenated with a blank (and may get folded
152           there later)
153
154       $obj->addresses()
155           Inherited, see "Access to the content" in Mail::Message::Field
156
157       $obj->attrPairs()
158           Inherited, see "Access to the content" in
159           Mail::Message::Field::Structured
160
161       $obj->attribute( $object|<STRING, %options>|<$name,$value,%options> )
162           Inherited, see "Access to the content" in
163           Mail::Message::Field::Structured
164
165       $obj->attributes()
166           Inherited, see "Access to the content" in
167           Mail::Message::Field::Structured
168
169       $obj->beautify()
170           Inherited, see "Access to the content" in
171           Mail::Message::Field::Full
172
173       $obj->comment( [STRING] )
174           Inherited, see "Access to the content" in Mail::Message::Field
175
176       $obj->createComment(STRING, %options)
177       Mail::Message::Field::DKIM->createComment(STRING, %options)
178           Inherited, see "Access to the content" in
179           Mail::Message::Field::Full
180
181       $obj->createPhrase(STRING, %options)
182       Mail::Message::Field::DKIM->createPhrase(STRING, %options)
183           Inherited, see "Access to the content" in
184           Mail::Message::Field::Full
185
186       $obj->study()
187           Inherited, see "Access to the content" in Mail::Message::Field
188
189       $obj->tag($name)
190           Returns the value for the named tag.
191
192       $obj->toDate( [$time] )
193       Mail::Message::Field::DKIM->toDate( [$time] )
194           Inherited, see "Access to the content" in Mail::Message::Field
195
196       $obj->toInt()
197           Inherited, see "Access to the content" in Mail::Message::Field
198
199       DKIM-Signature tags
200
201       The tag methods return the tag-value content without any validation or
202       modification.  For many situations, the actual content does not need
203       (expensive) validation and interpretation.
204
205       $obj->tagAgentID()
206           The Agent or User Identifier (AUID).  Defaults to @$domain
207
208       $obj->tagAlgorithm()
209           Signature algorithm.  Should be rsa-sha(1|256): check before use.
210           Required.
211
212       $obj->tagBodyLength()
213           The number of octets which where used to calculate the hash.  By
214           default, the whole body was used.
215
216       $obj->tagC14N()
217           The canonicalization method used.  Defaults to 'simple/simple'.
218
219       $obj->tagDomain()
220           The sub-domain (SDID) which claims responsibility for this
221           signature. Required.
222
223       $obj->tagExpires()
224           The timestamp when the signature will expire.  Recommended.
225
226       $obj->tagExtract()
227           Some headers from the original message packed together.
228
229       $obj->tagQueryMethods()
230           A colon-separated list of method which can be used to retrieve the
231           public key.  The default is "dns/txt" (currently the only valid
232           option)
233
234       $obj->tagSelector()
235           The selector subdividing the $domain tag.  Required.
236
237       $obj->tagSignData()
238       $obj->tagSignature()
239           Message signature in base64, with whitespaces removed. Required.
240
241       $obj->tagSignedHeaders()
242           The colon separated list of headers which need to be included in
243           the signature.  Required.
244
245       $obj->tagTimestamp()
246           When the signature was created in UNIX-like seconds (since 1970).
247           Recommended.
248
249       $obj->tagVersion()
250           Signature header syntax version (usually 1)
251
252   Other methods
253       Extends "Other methods" in Mail::Message::Field::Structured.
254
255       $obj->dateToTimestamp(STRING)
256       Mail::Message::Field::DKIM->dateToTimestamp(STRING)
257           Inherited, see "Other methods" in Mail::Message::Field
258
259   Internals
260       Extends "Internals" in Mail::Message::Field::Structured.
261
262       $obj->consume( $line | <$name,<$body|$objects>> )
263           Inherited, see "Internals" in Mail::Message::Field
264
265       $obj->decode(STRING, %options)
266       Mail::Message::Field::DKIM->decode(STRING, %options)
267           Inherited, see "Internals" in Mail::Message::Field::Full
268
269       $obj->defaultWrapLength( [$length] )
270           Inherited, see "Internals" in Mail::Message::Field
271
272       $obj->encode(STRING, %options)
273           Inherited, see "Internals" in Mail::Message::Field::Full
274
275       $obj->fold( $name, $body, [$maxchars] )
276       Mail::Message::Field::DKIM->fold( $name, $body, [$maxchars] )
277           Inherited, see "Internals" in Mail::Message::Field
278
279       $obj->setWrapLength( [$length] )
280           Inherited, see "Internals" in Mail::Message::Field
281
282       $obj->stringifyData(STRING|ARRAY|$objects)
283           Inherited, see "Internals" in Mail::Message::Field
284
285       $obj->unfold(STRING)
286           Inherited, see "Internals" in Mail::Message::Field
287
288   Parsing
289       Extends "Parsing" in Mail::Message::Field::Structured.
290
291       $obj->consumeComment(STRING)
292       Mail::Message::Field::DKIM->consumeComment(STRING)
293           Inherited, see "Parsing" in Mail::Message::Field::Full
294
295       $obj->consumeDotAtom(STRING)
296           Inherited, see "Parsing" in Mail::Message::Field::Full
297
298       $obj->consumePhrase(STRING)
299       Mail::Message::Field::DKIM->consumePhrase(STRING)
300           Inherited, see "Parsing" in Mail::Message::Field::Full
301
302       $obj->datum( [$value] )
303           Inherited, see "Parsing" in Mail::Message::Field::Structured
304
305       $obj->parse(STRING)
306           Inherited, see "Parsing" in Mail::Message::Field::Full
307
308       $obj->produceBody()
309           Inherited, see "Parsing" in Mail::Message::Field::Full
310
311   Error handling
312       Extends "Error handling" in Mail::Message::Field::Structured.
313
314       $obj->AUTOLOAD()
315           Inherited, see "Error handling" in Mail::Reporter
316
317       $obj->addReport($object)
318           Inherited, see "Error handling" in Mail::Reporter
319
320       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
321       $callback] )
322       Mail::Message::Field::DKIM->defaultTrace( [$level]|[$loglevel,
323       $tracelevel]|[$level, $callback] )
324           Inherited, see "Error handling" in Mail::Reporter
325
326       $obj->errors()
327           Inherited, see "Error handling" in Mail::Reporter
328
329       $obj->log( [$level, [$strings]] )
330       Mail::Message::Field::DKIM->log( [$level, [$strings]] )
331           Inherited, see "Error handling" in Mail::Reporter
332
333       $obj->logPriority($level)
334       Mail::Message::Field::DKIM->logPriority($level)
335           Inherited, see "Error handling" in Mail::Reporter
336
337       $obj->logSettings()
338           Inherited, see "Error handling" in Mail::Reporter
339
340       $obj->notImplemented()
341           Inherited, see "Error handling" in Mail::Reporter
342
343       $obj->report( [$level] )
344           Inherited, see "Error handling" in Mail::Reporter
345
346       $obj->reportAll( [$level] )
347           Inherited, see "Error handling" in Mail::Reporter
348
349       $obj->trace( [$level] )
350           Inherited, see "Error handling" in Mail::Reporter
351
352       $obj->warnings()
353           Inherited, see "Error handling" in Mail::Reporter
354
355   Cleanup
356       Extends "Cleanup" in Mail::Message::Field::Structured.
357
358       $obj->DESTROY()
359           Inherited, see "Cleanup" in Mail::Reporter
360

DETAILS

362       Extends "DETAILS" in Mail::Message::Field::Structured.
363

DIAGNOSTICS

365       Warning: Field content is not numerical: $content
366           The numeric value of a field is requested (for instance the "Lines"
367           or "Content-Length" fields should be numerical), however the data
368           contains weird characters.
369
370       Warning: Illegal character in charset '$charset'
371           The field is created with an utf8 string which only contains data
372           from the specified character set.  However, that character set can
373           never be a valid name because it contains characters which are not
374           permitted.
375
376       Warning: Illegal character in field name $name
377           A new field is being created which does contain characters not
378           permitted by the RFCs.  Using this field in messages may break
379           other e-mail clients or transfer agents, and therefore mutulate or
380           extinguish your message.
381
382       Warning: Illegal character in language '$lang'
383           The field is created with data which is specified to be in a
384           certain language, however, the name of the language cannot be
385           valid: it contains characters which are not permitted by the RFCs.
386
387       Warning: Illegal encoding '$encoding', used 'q'
388           The RFCs only permit base64 ("b " or "B ") or quoted-printable ("q"
389           or "Q") encoding.  Other than these four options are illegal.
390
391       Error: No attributes for DKIM headers
392           Is is not possible to add attributes to this field.
393
394       Error: Package $package does not implement $method.
395           Fatal error: the specific package (or one of its superclasses) does
396           not implement this method where it should. This message means that
397           some other related classes do implement this method however the
398           class at hand does not.  Probably you should investigate this and
399           probably inform the author of the package.
400

LICENSE

406       Copyrights 2001-2020 by [Mark Overmeer <markov@cpan.org>]. For other
407       contributors see ChangeLog.
408
409       This program is free software; you can redistribute it and/or modify it
410       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
411
412
413
414perl v5.32.0                      2020-07-28     Mail::Message::Field::DKIM(3)