Metadata-Version: 1.0
Name: django-cloudmailin
Version: 0.1
Summary: Client for CloudMailin incoming email service
Home-page: http://github.com/sunlightlabs/django-cloudmailin/
Author: Jeremy Carbaugh
Author-email: jcarbaugh@sunlightfoundation.com
License: BSD License
Description: ==================
        django-cloudmailin
        ==================
        
        http://cloudmailin.com/
        
        ------------
        Requirements
        ------------
        
        * django >= 1.2.0
        
        -------------
        Configuration
        -------------
        
        settings.py
        ===========
        
        Add to *INSTALLED_APPS*::
        
            'cloudmailin'
        
        Usage
        =====
        
        MailHandler is a class based view. Since an application may have multiple
        email addresses, they have to be registered with their own secret key and
        callbacks. The callbacks can be reused if you want the same functionality for
        different email addresses.
        
        ::
        
            from cloudmailin.views import MailHandler
        
            mail_handler = MailHandler()
            mail_handler.register_address(
                address='mysecretemail@cloudmailin.net',
                secret='mysupersecretkey',
                callback=my_callback_function
            )
        
        The callback will receive the HTTP post variables as keyword arguments::
        
            def my_callback_function(**kwargs):
                # kwargs is a dict of cloudmailin post params
                pass
        
        Then, in urls.py, register a URL pattern to act as the endpoint::
        
            url(r'^receive/mail/here/$', mail_handler)
        
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Environment :: Web Environment
