Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

mailmock

Mailmock API

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.1.1.dev34033334777
  • 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:

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:

import mailmock

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import mailmock

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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 PUT /email Create a new mailbox
EmailApi email_list GET /email List mailbox(es)
EmailApi email_read POST /email Fetch an email, optionally mark as read
SendApi send_aws POST /aws

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

Authorization

  • Type: Bearer authentication

Author

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mailmock-1.1.1.dev34033334777.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mailmock-1.1.1.dev34033334777-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

Details for the file mailmock-1.1.1.dev34033334777.tar.gz.

File metadata

  • Download URL: mailmock-1.1.1.dev34033334777.tar.gz
  • Upload date:
  • Size: 31.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mailmock-1.1.1.dev34033334777.tar.gz
Algorithm Hash digest
SHA256 ae19929ca5495e7e88891711ba27e6e0e523c2643ae3fc80501f4b59834c03af
MD5 ff2997e8548f9fb8794d651c4d999881
BLAKE2b-256 7818c22bcb236904f1d0bcd918422bdd3dabe9278f7c129f094c35968871153d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mailmock-1.1.1.dev34033334777.tar.gz:

Publisher: publish-sdks.yml on descope/mailmock

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mailmock-1.1.1.dev34033334777-py3-none-any.whl.

File metadata

File hashes

Hashes for mailmock-1.1.1.dev34033334777-py3-none-any.whl
Algorithm Hash digest
SHA256 465cecdbaa1eee67fbb4e9e437590163ccf15b81ef247bfdc46c119d79820c97
MD5 29a386d76fe8662e7c14851df20cb592
BLAKE2b-256 d2e1cd9169473bfd40b9ae60e0b7c037691f67705437b3d2f034d1494ed68a50

See more details on using hashes here.

Provenance

The following attestation bundles were made for mailmock-1.1.1.dev34033334777-py3-none-any.whl:

Publisher: publish-sdks.yml on descope/mailmock

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page