.. memoryhole documentation master file, created by
   sphinx-quickstart on Thu Jul  7 14:53:06 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

memoryhole
======================================

memoryhole is a library that sends email metadata down the memory hole.

Quickstart guide
-----------------

To protect a message::

  protect(msg)

To unprotect::

  unwrap(msg)

Options
--------

You can pass some options to the public api::

  opts = Options(blah)


Contents
--------

.. toctree::
   :maxdepth: 2



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`