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.2.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.2-py3-none-any.whl (2.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: azrmail-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 1e7041800018555cf447f04ea2c6acdb66aea2906ef854306c00342a8de7e8cd
MD5 c6f8fbab1db363d0296a011a48407598
BLAKE2b-256 351f9ef307a3f4b668f25bbb5f93f4bb565d8df0889fd409b3fa3e9c0f275c32

See more details on using hashes here.

File details

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

File metadata

  • Download URL: azrmail-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d6996da26f244d06c6d64296569ad07d2f70e385a02210c2dd7a22d9e6a92bae
MD5 bca08e6d309a5d1f979bdf24df016323
BLAKE2b-256 b4a127eb299a32ce2c7d6b547e3d5652f3b39834bf3bea4f987fcead808fa6c6

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