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

Uploaded Python 3

File details

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

File metadata

  • Download URL: azrmail-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 f28eca83946f5f36e6f7e412036b1973b66e8db6ec0fc8f4b9554dea1dd87670
MD5 a14b949107f2fdf95688d69c87e93a6e
BLAKE2b-256 4379764d0b0981285200e264a87627fcfdc5bbe9cb4a695c8c27bec234107d86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: azrmail-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7489a1d32d14a5528ac5d40b78681c0ddcf035106c158365db3d962fac945dfd
MD5 4239042fd643e4787705074f673f559b
BLAKE2b-256 05817aceea90e325db19a134a96c1b72837d4ceea83fee92d4ced97f40229117

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