Skip to main content

A Python wrapper for AZRMail API

Project description

AZRMail API Wrapper

AZRMail is a simple Python wrapper for interacting with the AZRMail API, allowing users to generate temporary email addresses and fetch received emails effortlessly.

Installation

Ensure you have Python installed, then install the required dependencies:

pip install azrmail

Usage

Below is an example demonstrating how to use the AZRMail API wrapper in Python:

from azrmail import Email

# Initialize Email API with your API key
mail = Email(api_key="API_KEY")

# Generate a temporary email address
email, inboxId = mail.generate()

# Retrieve emails from the generated inbox ID
emails = Email.getmail("inboxId")

# Print generated email and inbox ID
print(email, inboxId)

# Print received emails
print(emails)

Features

  • Generate temporary email addresses
  • Retrieve received emails from a specific inbox

API Reference

Email(api_key: str)

Initializes the email API wrapper with your provided API key.

generate()

Generates a new temporary email address and returns the email and inboxId.

getmail(inboxId: str)

Retrieves all received emails from the specified inbox ID.

License

This project is licensed under the MIT License.

Contributing

Feel free to open issues or contribute by submitting pull requests!

Project details


Download files

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

Source Distribution

azrmail-0.1.1.tar.gz (2.4 kB view details)

Uploaded Source

Built Distribution

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

azrmail-0.1.1-py3-none-any.whl (2.5 kB view details)

Uploaded Python 3

File details

Details for the file azrmail-0.1.1.tar.gz.

File metadata

  • Download URL: azrmail-0.1.1.tar.gz
  • Upload date:
  • Size: 2.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for azrmail-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b81bca16ab92f59db59b5a15c87e80c98175e6423928af1dc74a77593bf110ab
MD5 a0c78122bc46a1bf13a01bd83f226d99
BLAKE2b-256 2ded0eccbff7b543b12f0dbd94cb82bb0411e5c1081a553574af968170ca9458

See more details on using hashes here.

File details

Details for the file azrmail-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: azrmail-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 2.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for azrmail-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8c6217d5f6baf857e5371304d5b5de2f87b3bca504ac1e1de39c6dba04aec2c9
MD5 2a9bc1bcbbb356b29b2bfce4cff08c38
BLAKE2b-256 6343e25b6be40b04f924737fad9d70813527c789b1acd620d125eccd8f1b55d7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page