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 2.20210915
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
19       •   Mail::AuthenticationResults::Header::AuthServID represents the
20           AuthServID part of the set
21
22       •   Mail::AuthenticationResults::Header::Comment represents a comment
23
24       •   Mail::AuthenticationResults::Header::Entry represents a main entry
25
26       •   Mail::AuthenticationResults::Header::Group represents a group of
27           parts, typically as a search result
28
29       •   Mail::AuthenticationResults::Header::SubEntry represents a sub
30           entry part
31
32       •   Mail::AuthenticationResults::Header::Version represents a version
33           part
34
35           Header
36               AuthServID
37                   Version
38                   Comment
39                   SubEntry
40               Entry
41                   Comment
42               Entry
43                   Comment
44                   SubEntry
45                       Comment
46               Entry
47                   SubEntry
48                   SubEntry
49
50           Group
51               Entry
52                   Comment
53               SubEntry
54                   Comment
55               Entry
56                   SubEntry
57

METHODS

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

AUTHOR

162       Marc Bradshaw <marc@marcbradshaw.net>
163

165       This software is copyright (c) 2021 by Marc Bradshaw.
166
167       This is free software; you can redistribute it and/or modify it under
168       the same terms as the Perl 5 programming language system itself.
169
170
171
172perl v5.36.0                      2M0a2i3l-:0:1A-u2t0henticationResults::Header::Base(3)
Impressum