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: [email protected]

List inbox contents:

.. code-block::

$ guerrillamail list
(*) 48859781  23:45:27+00:00  [email protected]
Example messsage 2

(*) 48859574  09:25:01+00:00  [email protected]
Example message

( ) 1         00:00:00+00:00  [email protected]
Welcome to Guerrilla Mail

Read email message:

.. code-block::

$ guerrillamail get 48859781
From: [email protected]
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/