qpsmtpd::address(3pm) [debian man page]
Qpsmtpd::Address(3pm) User Contributed Perl Documentation Qpsmtpd::Address(3pm) NAME
Qpsmtpd::Address - Lightweight E-Mail address objects DESCRIPTION
Based originally on cut and paste from Mail::Address and including every jot and tittle from RFC-2821/2822 on what is a legal e-mail address for use during the SMTP transaction. USAGE
my $rcpt = Qpsmtpd::Address->new('<email.address@example.com>'); The objects created can be used as is, since they automatically stringify to a standard form, and they have an overloaded comparison for easy testing of values. METHODS
new() Can be called two ways: o Qpsmtpd::Address->new('<full_address@example.com>') The normal mode of operation is to pass the entire contents of the RCPT TO: command from the SMTP transaction. The value will be fully parsed via the canonify method, using the full RFC 2821 rules. o Qpsmtpd::Address->new("user", "host") If the caller has already split the address from the domain/host, this mode will not canonify the input values. This is not recommended in cases of user-generated input for that reason. This can be used to generate Qpsmtpd::Address objects for accounts like "<postmaster>" or indeed for the bounce address "<>". The resulting objects can be stored in arrays or used in plugins to test for equality (like in badmailfrom). canonify() Primarily an internal method, it is used only on the path portion of an e-mail message, as defined in RFC-2821 (this is the part inside the angle brackets and does not include the "human readable" portion of an address). It returns a list of (local-part, domain). parse() Retained as a compatibility method, it is completely equivalent to new() called with a single parameter. address() Can be used to reset the value of an existing Q::A object, in which case it takes a parameter with or without the angle brackets. Returns the stringified representation of the address. NOTE: does not escape any of the characters that need escaping, nor does it include the surrounding angle brackets. For that purpose, see format. format() Returns the canonical stringified representation of the address. It does escape any characters requiring it (per RFC-2821/2822) and it does include the surrounding angle brackets. It is also the default stringification operator, so the following are equivalent: print $rcpt->format(); print $rcpt; user([$user]) Returns the "localpart" of the address, per RFC-2821, or the portion before the '@' sign. If called with one parameter, the localpart is set and the new value is returned. host([$host]) Returns the "domain" part of the address, per RFC-2821, or the portion after the '@' sign. If called with one parameter, the domain is set and the new value is returned. notes($key[,$value]) Get or set a note on the address. This is a piece of data that you wish to attach to the address and read somewhere else. For example you can use this to pass data between plugins. COPYRIGHT
Copyright 2004-2005 Peter J. Holzer. See the LICENSE file for more information. perl v5.14.2 2009-04-02 Qpsmtpd::Address(3pm)
Check Out this Related Man Page
Mail::SPF::Request(3pm) User Contributed Perl Documentation Mail::SPF::Request(3pm) NAME
Mail::SPF::Request - SPF request class SYNOPSIS
use Mail::SPF; my $request = Mail::SPF::Request->new( versions => [1, 2], # optional scope => 'mfrom', # or 'helo', 'pra' identity => 'fred@example.com', ip_address => '192.168.0.1', helo_identity # optional, => 'mta.example.com' # for %{h} macro expansion ); my @versions = $request->versions; my $scope = $request->scope; my $authority_domain = $request->authority_domain; my $identity = $request->identity; # 'localpart@domain' or 'domain' my $domain = $request->domain; my $localpart = $request->localpart; my $ip_address = $request->ip_address; # IPv4 or IPv6 address my $ip_address_v6 # native IPv6 address or = $request->ip_address_v6; # IPv4-mapped IPv6 address my $helo_identity # additional HELO identity = $request->helo_identity; # for non-HELO scopes my $record = $request->record; # the record selected during processing of the request, may be undef $request->state(field => 'value'); my $value = $request->state('field'); DESCRIPTION
An object of class Mail::SPF::Request represents an SPF request. Constructors The following constructors are provided: new(%options): returns Mail::SPF::Request Creates a new SPF request object. The request is considered the root-request for any subsequent sub-requests (see the "new_sub_request" constructor). %options is a list of key/value pairs representing any of the following options: versions A reference to an array of integers listing the versions of SPF records that may be used for the SPF check. Only those record versions that cover the desired scope will actually be used. At least one applicable version must be specified. For a single record version, a simple scalar may be specified instead of an array-ref. Defaults to all versions that cover the desired scope (see below); defaults to [1, 2] for the default scope of 'mfrom'. The following versions are supported: 1 Use "v=spf1" records. 2 Use "spf2.0" records. Example: A value of 1 (or [1]) means that only "v=spf1" records should be used for the SPF check. If at the same time a scope of 'pra' is specified, a Mail::SPF::EInvalidScope exception will be thrown as "v=spf1" records do not cover the PRA scope. scope A string denoting the authorization scope of the identity that should be checked. Defaults to 'mfrom'. The following scope values are supported: 'helo' The given identity is the "HELO" parameter of an SMTP transaction (RFC 2821) and should be checked against SPF records that cover the "helo" scope ("v=spf1"). See the SPFv1 specification (RFC 4408) for the formal definition of the "HELO" scope. 'mfrom' The given identity is the "MAIL FROM" parameter of an SMTP transaction (RFC 2821), and should be checked against SPF records that cover the "mfrom" scope ("v=spf1" and "spf2.0/mfrom"). See the SPFv1 specification (RFC 4408) for the formal definition of the "MAIL FROM" scope. Note: In the case of an empty "MAIL FROM" SMTP transaction parameter ("MAIL FROM:<>"), you should perform a check with the "helo" scope instead. 'pra' The given identity is the "Purported Responsible Address" of an internet message (RFC 2822) and should be checked against SPF records that cover the "pra" scope ("spf2.0/pra"). See the PRA specification (RFC 4407) for the formal definition of the PRA scope. authority_domain A string denoting the domain name that should be queried for sender policy records. Defaults to the domain of the "identity" option. There is usually no need to specify the "authority_domain" option. identity Required. A string denoting the sender identity whose authorization should be checked. This is a domain name for the "helo" scope, and an e-mail address for the "mfrom" and "pra" scopes. Note: An empty identity must not be passed. In the case of an empty "MAIL FROM" SMTP transaction parameter, you should perform a check with the "helo" scope instead. ip_address Required for checks with the "helo", "mfrom", and "pra" scopes. Either a string or a NetAddr::IP object denoting the IP address of the host claiming the identity that is being checked. Can be either an IPv4 or an IPv6 address. An IPv4-mapped IPv6 address (e.g. '::ffff:192.168.0.1') is treated as an IPv4 address. helo_identity A string denoting the "HELO" SMTP transaction parameter in the case that the main identity is of a scope other than "helo". This identity is then used merely for the expansion of "%{h}" macros during the policy evaluation of the main identity. Defaults to undef, which will be expanded to 'unknown'. If the main identity is of the "helo" scope, this option is unused. new_sub_request(%options): returns Mail::SPF::Request Must be invoked on an existing request object. Creates a new sub-request object by cloning the invoked request, which is then considered the new request's super-request. Any specified options (see the "new" constructor) override the parameters of the super- request. There is usually no need to specify any options besides the "authority_domain" option. Instance methods The following instance methods are provided: root_request: returns Mail::SPF::Request Returns the root of the request's chain of super-requests. Specifically, returns the request itself if it has no super-requests. super_request: returns Mail::SPF::Request Returns the super-request of the request, or undef if there is none. versions: returns list of string Returns a list of the SPF record versions that are used for request. See the description of the "new" constructor's "versions" option. scope: returns string Returns the scope of the request. See the description of the "new" constructor's "scope" option. authority_domain: returns string Returns the authority domain of the request. See the description of the "new" constructor's "authority_domain" option. identity: returns string Returns the identity of the request. See the description of the "new" constructor's "identity" option. domain: returns string Returns the identity domain of the request. See the description of the "new" constructor's "identity" option. localpart: returns string Returns the identity localpart of the request. See the description of the "new" constructor's "identity" option. ip_address: returns NetAddr::IP Returns the IP address of the request as a NetAddr::IP object. See the description of the "new" constructor's "ip_address" option. ip_address_v6: returns NetAddr::IP Like the "ip_address" method, however, an IPv4 address is returned as an IPv4-mapped IPv6 address (e.g. '::ffff:192.168.0.1') to facilitate uniform processing. helo_identity: returns string Returns the "HELO" SMTP transaction parameter of the request. See the description of the "new" constructor's "helo_identity" option. record: returns Mail::SPF::Record Returns the SPF record selected during the processing of the request, or undef if there is none. state($field): returns anything state($field, $value): returns anything Provides an interface for storing temporary state information with the request object. This is primarily meant to be used internally by Mail::SPF::Server and other Mail::SPF classes. If $value is specified, stores it in a state field named $field. Returns the current (new) value of the state field named $field. This method may be used as an lvalue. SEE ALSO
Mail::SPF, Mail::SPF::Server <http://tools.ietf.org/html/rfc4408> For availability, support, and license information, see the README file included with Mail::SPF. AUTHORS
Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org> perl v5.14.2 2012-01-30 Mail::SPF::Request(3pm)