Python API wrapper for mail.tm
Project description
MailTM
Description
Asynchronous API wrapper for https://docs.mail.tm/
Navigation
Setup
pip install MailTMAPI
Usage example
import asyncio
from mailtmapi import MailTM
async def main() -> None:
mailtm = MailTM()
temp_mail = await mailtm.get_account()
print(temp_mail)
if __name__ == '__main__':
loop = asyncio.new_event_loop()
loop.run_until_complete(main())
API methods
A list of all available methods with their parameters and response.
Authentication
await get_account_token(address, password)
Parameter | Type | Description |
---|---|---|
address |
string |
Account's address. Example: user@example.com |
password |
string |
Account's password |
Returns token and id after successful authorization.
Get domains list
await get_domains()
Description |
---|
Doesn't take parameters |
Returns a list of domains.
Get domain by id
await get_domain(domain_id)
Parameter | Type | Description |
---|---|---|
domain_id |
string |
The domain you want to get with id |
Returns a domain by its id (Useful for deleted/private domains).
Get account
await get_account(address, password)
Parameter | Type | Description |
---|---|---|
address |
string |
Account's address. Example: user@example.com |
password |
string |
Account's password |
Creates an Account resource (Registration).
Get account by id
await get_account_by_id(account_id, token)
Parameter | Type | Description |
---|---|---|
account_id |
string |
Account's address. Example: user@example.com |
token |
string |
Account's token |
Get an Account resource by its id (Obviously, the Bearer token needs to be the one of the account you are trying to retrieve).
Delete account by id
await delete_account_by_id(account_id, token)
Parameter | Type | Description |
---|---|---|
account_id |
string |
The account you want to delete by id |
token |
string |
Account's token |
Deletes the Account resource.
Get me
await get_me(token)
Parameter | Type | Description |
---|---|---|
token |
string |
Account's token |
Returns the Account resource that matches the Bearer token that sent the request.
Get messages
await get_messages(token, page)
Parameter | Type | Description |
---|---|---|
token |
string |
Account's token |
page |
int |
The collection page number |
Returns all the Message resources of a given page.
Get message by id
await get_message_by_id(message_id, token)
Parameter | Type | Description |
---|---|---|
message_id |
string |
The message you want to get by id |
token |
string |
Account's token |
Retrieves a Message resource with a specific id.
Delete message by id
await delete_message_by_id(message_id, token)
Parameter | Type | Description |
---|---|---|
message_id |
string |
The message you want to delete's id |
token |
string |
Account's token |
Deletes the Message resource.
Set read message by id
await set_read_message_by_id(message_id, token)
Parameter | Type | Description |
---|---|---|
message_id |
string |
The message you want to read's id |
token |
string |
Account's token |
Marks a Message resource as read.
Get message source by id
await get_message_source_by_id(message_id, token)
Parameter | Type | Description |
---|---|---|
message_id |
string |
The source you want to get by id |
token |
string |
Account's token |
Gets a Message's Source resource.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for mailtmapi-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 680637c495897b59d85455b2e4e702cecc9e1261f3f9c2c6a01192b7edc292db |
|
MD5 | 9ce4f7e4fb1812ce18c10d6738788b5b |
|
BLAKE2b-256 | ab88f3a7cf54d81b13909c6608c701106c6b0090829d0f908077306bfdb8326a |