Sha256: 67b6853cda52ea950b9609386affa61ab29763ca1882589864adbab024e44dda
Contents?: true
Size: 1.44 KB
Versions: 9
Compression:
Stored size: 1.44 KB
Contents
= SPF
The +spf+ Ruby gem, also known as +spf-ruby+, is an implementation of the Sender Policy Framework (SPF) e-mail sender
authentication system. It is closely based on the Mail::SPF Perl library at <http://search.cpan.org/~jmehnle/Mail-SPF-v2.005/>, so most of Mail::SPF's documentation is applicable.
See <http://www.openspf.org> for more information about SPF.
Note: This gem is currently very early in its lifecycle. The API is *not* guaranteed to be stable.
== Usage
require 'spf'
spf_server = SPF::Server.new
request = SPF::Request.new(
versions: [1, 2], # optional
scope: 'mfrom', # or 'helo', 'pra'
identity: 'fred@example.com',
ip_address: '192.168.0.1',
helo_identity: 'mta.example.com' # optional
)
result = spf_server.process(request)
puts result
result_code = result.code # :pass, :fail, etc.
== Copyright
Copyright 2016 Agari Data, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this software except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Version data entries
9 entries across 9 versions & 1 rubygems