Providing the expansion context early¶

    use Mail::SPF::MacroString;
    my $macrostring = Mail::SPF::MacroString->new(
        text    => '%{ir}.%{v}._spf.%{d2}',
        server  => $server,
        request => $request
    );
    my $expanded = $macrostring->expand;

Providing the expansion context late¶

    use Mail::SPF::MacroString;
    my $macrostring = Mail::SPF::MacroString->new(
        text    => '%{ir}.%{v}._spf.%{d2}'
    );
    my $expanded1 = $macrostring->expand($server, $request1);
    $macrostring->context($server, $request2);
    my $expanded2 = $macrostring->expand;

Constructor¶

The following constructor is provided:

new(%options): returns Mail::SPF::MacroString

Creates a new SPF record macro string object.

%options is a list of key/value pairs representing any of the following options:

Instance methods¶

The following instance methods are provided:

text: returns string

Returns the unexpanded text of the macro string.

context($server, $request): throws Mail::SPF::EOptionRequired

Attaches the given Mail::SPF::Server and Mail::SPF::Request objects as the context for the macro string.

expand: returns string; throws Mail::SPF::EMacroExpansionCtxRequired, Mail::SPF::EInvalidMacroString, Mail::SPF::Result::PermError

expand($server, $request): returns string; throws Mail::SPF::EMacroExpansionCtxRequired, Mail::SPF::EInvalidMacroString, Mail::SPF::Result::PermError

Expands the text of the macro string using either the context specified through an earlier call to the "context()" method, or the given context, and returns the resulting string. See RFC 4408, 8, for how macros are expanded.

is_explanation: returns boolean

Returns true if the macro string is an explanation string obtained via an "exp" modifier. See the description of the "new" constructor's "is_explanation" option.

stringify: returns string

Returns the expanded text of the macro string if a context is attached to the object. Returns the unexpanded text otherwise. You can simply use a Mail::SPF::MacroString object as a string for the same effect, see "OVERLOADING".