Metadata-Version: 1.1
Name: gs.dmarc
Version: 1.0.0
Summary: Look up and report on the DMARC status of a domain.
Home-page: https://source.iopen.net/groupserver/gs.dmarc/
Author: Michael JasonSmith
Author-email: mpj17@onlinegroups.net
License: ZPL 2.1
Description: ============
        ``gs.dmarc``
        ============
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        Look up and report on the DMARC status of a domain
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        :Author: `Michael JasonSmith`_
        :Contact: Michael JasonSmith <mpj17@onlinegroups.net>
        :Date: 2014-04-23
        :Organization: `GroupServer.org`_
        :Copyright: This document is licensed under a
          `Creative Commons Attribution-Share Alike 4.0 International License`_
          by `OnlineGroups.net`_.
        
        Introduction
        ============
        
        This product allows systems look up and report on the DMARC
        (Domain-based Message Authentication, Reporting and Conformance)
        status of a domain [#dmarc]_. DMARC allows the owner of a domain
        to publish a key that is used to verify if an email message
        actually originated from the domain, and to publish what to do if
        the verification fails. It is an extension of DKIM (DomainKeys
        Identified Mail [#dkim]_) and SPF (Sender Policy Framework
        [#spf]_).
        
        Specifically this product supplies support for enumerating the
        different DMARC policies_, and the `lookup_receiver_policy`_
        function for querying the policy for a given domain.
        
        Policies
        ========
        
        There are three DMARC policies:
        
        #. ``none`` does nothing, and domain verification is skipped.
        #. ``reject`` causes the system that is receiving the message to
           reject the message if the verification fails [#reject]_.
        #. ``quarantine`` generally causes the message to be marked as
           *spam* if verification fails.
        
        These three policies are represented by the
        ``gs.dmarc.ReceiverPolicy`` enumeration [#enum34]_.
        
        ``lookup_receiver_policy``
        ==========================
        
        Query the DMARC receiver policy for a host
        
        Synopsis
        --------
        
        ::
        
          gs.dmarc.lookup_receiver_policy(host)
        
        Description
        -----------
        
        The ``gs.dmarc.lookup_receiver_policy`` function queries up the
        policy for receiving messages from a host, and reports back the
        policy.
        
        Arguments
        ---------
        
        ``host``:
          The host to query. The *actual* host that is queried has
          ``_dmarc.`` prepended to it.
        
        Returns
        -------
        
        It returns a value from the ``gs.dmarc.ReceiverPolicy``
        enumeration (see Policies_). If the host does not exist, or there
        is no published DMARC policy then
        ``gs.dmarc.ReceiverPolicy.none`` is returned.
        
        Resources
        =========
        
        - Code repository: https://source.iopen.net/groupserver/gs.dmarc
        - Questions and comments to http://groupserver.org/groups/development
        - Report bugs at https://redmine.iopen.net/projects/groupserver
        
        .. [#dmarc] See `the internet-draft`_ Domain-based Message
                    Authentication, Reporting and Conformance (DMARC)
        .. _the internet-draft: https://datatracker.ietf.org/doc/draft-kucherawy-dmarc-base/?include_text=1
        .. [#dkim] See `RFC 6376`_: DomainKeys Identified Mail (DKIM) Signatures
        .. _RFC 6376: http://tools.ietf.org/html/rfc6376
        .. [#spf] See `RFC 4408`_: Sender Policy Framework (SPF) for
                  Authorizing Use of Domains in E-Mail, Version 1
        .. _RFC 4408: http://tools.ietf.org/html/rfc4408
        .. [#reject] Quite what "reject" means is a discussion for
                     another time. Suffice it to say, it is bad.
        .. [#enum34] `The enum34 package`_ is used to provide `Enum`_
                   support for releases of Python prior to 3.4.
        .. _The enum34 package: https://pypi.python.org//pypi/enum34
        .. _Enum: https://docs.python.org/3/library/enum.html
        .. _GroupServer: http://groupserver.org/
        .. _GroupServer.org: http://groupserver.org/
        .. _OnlineGroups.Net: https://onlinegroups.net
        .. _Michael JasonSmith: http://groupserver.org/p/mpj17
        ..  _Creative Commons Attribution-Share Alike 4.0 International License:
            http://creativecommons.org/licenses/by-sa/4.0/
        
        ..  LocalWords:  DMARC DKIM DomainKeys dkim groupserver spf enum
        ..  LocalWords:  lookup
        
        Changelog
        =========
        
        1.0.0 (2014-04-24)
        ------------------
        
        - Initial release
        
Keywords: DKIM,SPF,DMARC,email
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
