The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

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

VERSION

version 1.20180113

METHODS

new()

Return a new instance of this class

set_key( $key )

Set the key for this instance.

Croaks if $key is invalid.

key()

Return the current key for this instance.

Croaks if this instance type can not have a key.

safe_set_value( $value )

Set the value for this instance.

Munges the value to remove invalid characters before setting.

set_value( $value )

Set the value for this instance.

Croaks if the value contains invalid characters.

value()

Returns the current value for this instance.

stringify( $value )

Returns $value with stringify rules applied.

children()

Returns a listref of this instances children.

Croaks is this instance type can not have children.

add_parent( $parent )

Sets the parent for this instance to the supplied object.

Croaks is the relationship between $parent and $self is not valid.

parent()

Returns the parent object for this instance.

add_child( $child )

Adds $child as a child of this instance.

Croaks is the relationship between $child and $self is not valid.

as_string()

Returns this instance as a string.

search( $search )

Apply search rules in $search to this instance and return a Mail::AuthenticationResults::Header::Group object containing the matches.

$search is a HASHREF with the following possible key/value pairs

key

Match if the instance key matches the supplied value (string or regex)

value

Match if the instance value matches the supplied value (string or regex)

isa

Match is the instance class typs matches the supplied value. This is a lowercase version of the class type, (comment,entry,subentry,etc))

AUTHOR

Marc Bradshaw <marc@marcbradshaw.net>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by Marc Bradshaw.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.