Metadata-Version: 2.0
Name: python-guerrillamail
Version: 0.2.0
Summary: Client for the Guerrillamail temporary email server
Home-page: https://github.com/ncjones/python-guerrillamail
Author: Nathan Jones
Author-email: UNKNOWN
License: GPL3
Keywords: guerrillamail email client cli
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
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 :: 3.5
Requires-Dist: requests

Python Guerrillamail
====================

Python Guerrillamail is a Python client API and command line interface for
interacting with a `Guerrillamail`_ temporary email server.

.. image:: https://travis-ci.org/ncjones/python-guerrillamail.svg?branch=master
    :target: https://travis-ci.org/ncjones/python-guerrillamail
    :alt: Build Status


Installation
------------

.. code-block:: sh

    pip install python-guerrillamail


Example Usage
-------------

Create session using auto-assigned email address, print email address and print
id of first message in inbox:

.. code-block:: python

    from guerrillamail import GuerrillaMailSession
    session = GuerrillaMailSession()
    print session.get_session_state()['email_address']
    print session.get_email_list()[0].guid


Example CLI Usage
-----------------

Set email address:

.. code-block::

    $ guerrillamail setaddr john.doe
    $ guerrillamail info
    Email: john.doe@guerrillamailblock.com


List inbox contents:

.. code-block::

    $ guerrillamail list
    (*) 48859781  23:45:27+00:00  spam@example.com
    Example messsage 2

    (*) 48859574  09:25:01+00:00  spam@example.com
    Example message

    ( ) 1         00:00:00+00:00  no-reply@guerrillamail.com
    Welcome to Guerrilla Mail


Read email message:

.. code-block::

    $ guerrillamail get 48859781
    From: spam@example.com
    Date: 2016-06-11 23:45:27+00:00
    Subject: Example message 2

    Example Guerrillamail message body.


Using Alternative Guerrillamail Server
--------------------------------------

By default, ``http://api.guerrillamail.com`` is used as the base URL for
Guerrillamail API calls. This can be overridden by providing the ``base_url``
property when constructing a GuerrillaMailSession instance. When using the CLI
the ``base_url`` property can be defined in the ``~/.guerrillamail`` JSON
config file, for example:

.. code-block:: json

    {
        "base_url": "https://api.guerrillamail.com"
    }


License
-------

Python Guerrilla Mail is free software, licensed under the GPLv3.


.. _Guerrillamail: https://www.guerrillamail.com/


Change History
--------------

0.2.0
+++++

 + Add support for Python 3.3, 3.4 and 3.5.
 + Add "guerrillamail" executable.


0.1.2
+++++

 + Fix mail "excerpt" property.


0.1.1
+++++

 + Remove version restriction on Requests dependency.


0.1.0
+++++

 + Initial release.


