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.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:
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
- EmailCreate200Response
- EmailCreateRequest
- EmailList200ResponseInner
- EmailListDefaultResponse
- EmailListDefaultResponseIssuesInner
- EmailRead200Response
- EmailRead200ResponseHeadersInner
- EmailReadRequest
- SendAws200Response
- SendAwsRequest
- SendAwsRequestMail
- SendAwsRequestMailCommonHeaders
- SendAwsRequestReceipt
- SendAwsRequestReceiptAction
- SendAwsRequestReceiptSpamVerdict
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mailmock-1.1.1.dev34026500447.tar.gz.
File metadata
- Download URL: mailmock-1.1.1.dev34026500447.tar.gz
- Upload date:
- Size: 31.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
54251e7236a235b0e16b103066ed06338be0a90f089a012bd570b9674fcd4d44
|
|
| MD5 |
8b6c8b21d8ca5b2414c373584b7bc4c4
|
|
| BLAKE2b-256 |
a1fb5f8471509f9d16f6eefcb18250871b6641f2e6174da197ccbc6d42dd7200
|
Provenance
The following attestation bundles were made for mailmock-1.1.1.dev34026500447.tar.gz:
Publisher:
publish-sdks.yml on descope/mailmock
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mailmock-1.1.1.dev34026500447.tar.gz -
Subject digest:
54251e7236a235b0e16b103066ed06338be0a90f089a012bd570b9674fcd4d44 - Sigstore transparency entry: 2737398361
- Sigstore integration time:
-
Permalink:
descope/mailmock@a6a44a79f7222c35672ecb20811e2150ff54d1c1 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/descope
-
Access:
internal
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-sdks.yml@a6a44a79f7222c35672ecb20811e2150ff54d1c1 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mailmock-1.1.1.dev34026500447-py3-none-any.whl.
File metadata
- Download URL: mailmock-1.1.1.dev34026500447-py3-none-any.whl
- Upload date:
- Size: 45.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0c3d201812eada356bb464c738a6a94b72df9f6fee6fb9990d34682fda786ed2
|
|
| MD5 |
a8d3faa86668ccfee71a1ded9aaaafb9
|
|
| BLAKE2b-256 |
2decc20e06c268be6eead64920940a1e0eb21dc7dcd844abf1dc41f56292c404
|
Provenance
The following attestation bundles were made for mailmock-1.1.1.dev34026500447-py3-none-any.whl:
Publisher:
publish-sdks.yml on descope/mailmock
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mailmock-1.1.1.dev34026500447-py3-none-any.whl -
Subject digest:
0c3d201812eada356bb464c738a6a94b72df9f6fee6fb9990d34682fda786ed2 - Sigstore transparency entry: 2737398394
- Sigstore integration time:
-
Permalink:
descope/mailmock@a6a44a79f7222c35672ecb20811e2150ff54d1c1 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/descope
-
Access:
internal
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-sdks.yml@a6a44a79f7222c35672ecb20811e2150ff54d1c1 -
Trigger Event:
push
-
Statement type: