=====
Usage
=====
this library - as is Mailpit - is mostly meant for testing. Giving the url of Mailpit to a tool to send e-mail messages to and then use this client to check on the API if the mail was sent.

------
Client
------

The client itself consists of the class :py:class:`mailpit.client.api.API`, that offers methods, which query the API-Endpoints and are named respectively.
To use this class, simply try something like this.
You have to have Mailpit running on localhost for this [1]_ .

.. code-block:: python

    import mailpit.client.api
    api = mailpit.client.api.API("localhost:8025")
    messages = api.get_messages()

Additionally, there are some model-classes that wrap the API's responses.
For example with

.. code-block:: python

    messages = api.get_messages()

messages will be an instance of :py:class:`mailpit.client.models.Messages`.
The model-classes' attributes are named the same as Mailpit's responses, as documented in the API's `README.md <https://github.com/axllent/mailpit/blob/develop/docs/apiv1/README.md>`_, but as is convention in Python in Snakecase.

For examples have a look at the link:tests[tests]

.. [1] If you have it running differently, you have to adjust the URL you pass.