1Mail::AuthenticationResUusletrs:C:oHnetardiebruM:ta:eiBdla:sP:eeA(ru3lt)hDeonctuimceanttiaotniRoensults::Header::Base(3)
2
3
4

NAME

6       Mail::AuthenticationResults::Header::Base - Base class for modelling
7       parts of the Authentication Results Header
8

VERSION

10       version 1.20200331.1
11

DESCRIPTION

13       Set of classes representing the various parts and sub parts of
14       Authentication Results Headers.
15
16       Mail::AuthenticationResults::Header represents a complete
17       Authentication Results Header set
18       Mail::AuthenticationResults::Header::AuthServID represents the
19       AuthServID part of the set Mail::AuthenticationResults::Header::Comment
20       represents a comment Mail::AuthenticationResults::Header::Entry
21       represents a main entry Mail::AuthenticationResults::Header::Group
22       represents a group of parts, typically as a search result
23       Mail::AuthenticationResults::Header::SubEntry represents a sub entry
24       part Mail::AuthenticationResults::Header::Version represents a version
25       part
26
27       Header
28           AuthServID
29               Version
30               Comment
31               SubEntry
32           Entry
33               Comment
34           Entry
35               Comment
36               SubEntry
37                   Comment
38           Entry
39               SubEntry
40               SubEntry
41
42       Group
43           Entry
44               Comment
45           SubEntry
46               Comment
47           Entry
48               SubEntry
49

METHODS

51   new()
52       Return a new instance of this class
53
54   set_key( $key )
55       Set the key for this instance.
56
57       Croaks if $key is invalid.
58
59   key()
60       Return the current key for this instance.
61
62       Croaks if this instance type can not have a key.
63
64   safe_set_value( $value )
65       Set the value for this instance.
66
67       Munges the value to remove invalid characters before setting.
68
69       This method also removes some value characters when their inclusion
70       would be likely to break simple parsers.
71
72   set_value( $value )
73       Set the value for this instance.
74
75       Croaks if the value contains invalid characters.
76
77   value()
78       Returns the current value for this instance.
79
80   stringify( $value )
81       Returns $value with stringify rules applied.
82
83   children()
84       Returns a listref of this instances children.
85
86       Croaks if this instance type can not have children.
87
88   orphan()
89       Removes the parent for this instance.
90
91       Croaks if this instance does not have a parent.
92
93   add_parent( $parent )
94       Sets the parent for this instance to the supplied object.
95
96       Croaks if the relationship between $parent and $self is not valid.
97
98   parent()
99       Returns the parent object for this instance.
100
101   remove_child( $child )
102       Removes $child as a child of this instance.
103
104       Croaks if the relationship between $child and $self is not valid.
105
106   add_child( $child )
107       Adds $child as a child of this instance.
108
109       Croaks if the relationship between $child and $self is not valid.
110
111   ancestor()
112       Returns the top Header object and depth of this child
113
114   as_string_prefix( $header )
115       Add the prefix to as_string for this object when calledas a child of
116       another objects as_string method call.
117
118   as_json()
119       Return this instance as a JSON serialised string
120
121   as_string()
122       Returns this instance as a string.
123
124   build_string( $header )
125       Build a string using the supplied
126       Mail::AuthenticationResults::FoldableHeader object.
127
128   search( $search )
129       Apply search rules in $search to this instance and return a
130       Mail::AuthenticationResults::Header::Group object containing the
131       matches.
132
133       $search is a HASHREF with the following possible key/value pairs
134
135       key Match if the instance key matches the supplied value (string or
136           regex)
137
138       value
139           Match if the instance value matches the supplied value (string or
140           regex)
141
142       isa Match is the instance class typs matches the supplied value. This
143           is a lowercase version of the class type,
144           (comment,entry,subentry,etc))
145
146       has An arrayref of searches, match this class if the supplied search
147           queries would return at least 1 result each
148

AUTHOR

150       Marc Bradshaw <marc@marcbradshaw.net>
151

153       This software is copyright (c) 2020 by Marc Bradshaw.
154
155       This is free software; you can redistribute it and/or modify it under
156       the same terms as the Perl 5 programming language system itself.
157
158
159
160perl v5.32.0                      2M0a2i0l-:0:7A-u2t8henticationResults::Header::Base(3)
Impressum