Metadata-Version: 2.4
Name: mailmock
Version: 1.1.1.dev34026500447
Summary: Mailmock API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/descope/mailmock
Keywords: OpenAPI,OpenAPI-Generator,Mailmock API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.6.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# mailmock
Mailmock API

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.1.1.dev34026500447
- Generator version: 7.24.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/descope/mailmock.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/descope/mailmock.git`)

Then import the package:
```python
import mailmock
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import mailmock
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import mailmock
from mailmock.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/trpc
# See configuration.py for a list of all supported configuration parameters.
configuration = mailmock.Configuration(
    host = "/api/trpc"
)



# Enter a context with an instance of the API client
with mailmock.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailmock.EmailApi(api_client)
    email_create_request = mailmock.EmailCreateRequest() # EmailCreateRequest | 

    try:
        # Create a new mailbox
        api_response = api_instance.email_create(email_create_request)
        print("The response of EmailApi->email_create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EmailApi->email_create: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to */api/trpc*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EmailApi* | [**email_create**](docs/EmailApi.md#email_create) | **PUT** /email | Create a new mailbox
*EmailApi* | [**email_list**](docs/EmailApi.md#email_list) | **GET** /email | List mailbox(es)
*EmailApi* | [**email_read**](docs/EmailApi.md#email_read) | **POST** /email | Fetch an email, optionally mark as read
*SendApi* | [**send_aws**](docs/SendApi.md#send_aws) | **POST** /aws | 


## Documentation For Models

 - [EmailCreate200Response](docs/EmailCreate200Response.md)
 - [EmailCreateRequest](docs/EmailCreateRequest.md)
 - [EmailList200ResponseInner](docs/EmailList200ResponseInner.md)
 - [EmailListDefaultResponse](docs/EmailListDefaultResponse.md)
 - [EmailListDefaultResponseIssuesInner](docs/EmailListDefaultResponseIssuesInner.md)
 - [EmailRead200Response](docs/EmailRead200Response.md)
 - [EmailRead200ResponseHeadersInner](docs/EmailRead200ResponseHeadersInner.md)
 - [EmailReadRequest](docs/EmailReadRequest.md)
 - [SendAws200Response](docs/SendAws200Response.md)
 - [SendAwsRequest](docs/SendAwsRequest.md)
 - [SendAwsRequestMail](docs/SendAwsRequestMail.md)
 - [SendAwsRequestMailCommonHeaders](docs/SendAwsRequestMailCommonHeaders.md)
 - [SendAwsRequestReceipt](docs/SendAwsRequestReceipt.md)
 - [SendAwsRequestReceiptAction](docs/SendAwsRequestReceiptAction.md)
 - [SendAwsRequestReceiptSpamVerdict](docs/SendAwsRequestReceiptSpamVerdict.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="Authorization"></a>
### Authorization

- **Type**: Bearer authentication


## Author




