Skip to main content

A Python package that provides an easy-to-use interface for creating and managing email addresses

Project description

Logo

Mail-generator

GitHub Workflow Status (with event) Static Badge

Description

Mail-Generator is a Python package that provides an easy-to-use interface for creating and managing email addresses using the MailSlurp API. With Mail-Generator, you can quickly create new email addresses, read emails from an inbox, and more.

Installation

pip install mail-generator

Usage

# Import the MailGenerator class
from mail_generator import MailGenerator
# Create a MailGenerator object with your MailSlurp API key
client = MailGenerator(<api_key>)

You can find your MailSlurp API key here.

Features

Create an email address

email_id = client.create_email() #  Returns the ID of the email address created.
print(email_id + "@mailslurp.com")

Get emails from an inbox

emails = client.get_email_data(email_id) # Returns a list of emails in the inbox.

Example:

[
    {
        'id': 'adde245b-fa00-48cd-8a31-77f42737006e',
        'domain_id': None,
        'subject': 'Test',
        'to': ['example@mailslurp.com'],
        '_from': 'example@email.com',
        'bcc': [],
        'cc': [],
        'created_at': datetime.datetime(2023, 7, 13, 11, 28, 7, tzinfo=tzutc()),
        'read': True,
        'attachments': [],
        'body': '<div dir="ltr">Hello World<br></div>\r\n'
    }, 
    {
        'id': 'ede7bb4f-8a47-4631-9ca1-78389a55cced',
        'domain_id': None,
        'subject': 'Hi there',
        'to': ['example@mailslurp.com'],
        '_from': 'example@email.com',
        'bcc': [],
        'cc': [],
        'created_at': datetime.datetime(2023, 7, 13, 11, 29, 33, 473000, tzinfo=tzutc()),
        'read': True,
        'attachments': ['1689251504-9e7166b2-b96c-44cd-8e2a-95500df5c0ac'],
        'body': '<div dir="ltr">This is also a hello world<br></div>\r\n'
    }
]

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

mail-Generator-0.2.2.tar.gz (15.4 kB view hashes)

Uploaded Source

Built Distribution

mail_Generator-0.2.2-py3-none-any.whl (16.0 kB view hashes)

Uploaded Python 3

Supported by

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