Linux Manual Pages

Free Software * Books

Source Code

Free Media

Linux

Mail::SPF::MacroString

NAME
SYNOPSIS
DESCRIPTION
OVERLOADING
SEE ALSO
AUTHORS

NAME

Mail::SPF::MacroString − SPF record macro string class

SYNOPSIS

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;

DESCRIPTION

An object of class Mail::SPF::MacroString represents a macro string that can be expanded to a plain string in the context of an SPF request.

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:
text

Required. The unexpanded text of the new macro string.

server

The Mail::SPF::Server object that is to be used when expanding the macro string. A server object need not be attached statically to the macro string; it can be specified dynamically when calling the "expand" method.

request

The Mail::SPF::Request object that is to be used when expanding the macro string. A request object need not be attached statically to the macro string; it can be specified dynamically when calling the "expand" method.

is_explanation

A boolean denoting whether the macro string is an explanation string obtained via an "exp" modifier. If true, the "c", "r", and "t" macros may appear in the macro string, otherwise they may not, and if they do, a Mail::SPF::EInvalidMacro exception will be thrown when the macro string is expanded. Defaults to false.

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 ".

OVERLOADING

If a Mail::SPF::MacroString object is used as a string, the "stringify" method is used to convert the object into a string.

AUTHORS

Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org>

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.