• NAME
• VERSION
• DESCRIPTION
• INPUTS
  • domain
  • selector
• ATTRIBUTES
  • authority
  • cache_backend
  • errors
  • is_valid
  • location
  • record_hashref
  • retrieved_domain
  • retrieved_record
  • retrieved_selector
  • version
  • warnings
• CONSUMES
• EXTENDS
• METHODS
  • cache_valid_for()
  • location_is_relevant()
  • finish()
  • app_validate()
• REQUIRES
• AUTHOR
• COPYRIGHT AND LICENSE

NAME

Mail::BIMI::Record - Class to model a BIMI record

VERSION

version 3.20231123

DESCRIPTION

Class for representing, retrieving, validating, and processing a BIMI Record

INPUTS

These values are used as inputs for lookups and verifications, they are typically set by the caller based on values found in the message being processed

domain

is=rw required

Domain the for the record

selector

is=rw

Selector used to retrieve the record; will become default if fallback was used

ATTRIBUTES

These values are derived from lookups and verifications made based upon the input values, it is however possible to override these with other values should you wish to, for example, validate a record before it is published in DNS, or validate an Indicator which is only available locally

authority

is=rw

Mail::BIMI::Record::Authority object for this record

cache_backend

is=ro

errors

is=rw

is_valid

is=rw

Is this record valid

location

is=rw

Mail::BIMI::Record::Location object for this record

record_hashref

is=rw

Hashref of record values

retrieved_domain

is=rw

Domain the record was retrieved from

retrieved_record

is=rw

Record as retrieved

retrieved_selector

is=rw

Selector the record was retrieved from

version

is=rw

BIMI Version tag

warnings

is=rw

CONSUMES

• Mail::BIMI::Role::Cacheable

• Mail::BIMI::Role::HasError

• Mail::BIMI::Role::HasError

EXTENDS

• Mail::BIMI::Base

METHODS

cache_valid_for()

How long should the cache for this class be valid

location_is_relevant()

Return true is the location is relevant to the validation of the record.

If we don't have a relevant authority, or we are checking BOTH authority and location.

finish()

Finish and clean up, write cache if enabled.

app_validate()

Output human readable validation status of this object

REQUIRES

• Mail::BIMI::Prelude

• Mail::BIMI::Record::Authority

• Mail::BIMI::Record::Location

• Mail::DMARC::PurePerl

• Moose

• Term::ANSIColor

AUTHOR

Marc Bradshaw <marc@marcbradshaw.net>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020 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.

cpanm Mail::BIMI

perl -MCPAN -e shell
install Mail::BIMI