1secMail 1.2.0

📧 Simple and intuitive, yet full featured API wrapper for www.1secmail.com, supporting both synchronous and asynchronous operations.

An API wrapper for www.1secmail.com written in Python.

About

This is an easy to use yet full-featured Python API wrapper for www.1secmail.com ↗ using the official 1secMail API. It allows you to easily create temporary email addresses for testing, verification, or other purposes where you need a disposable email address.

Asynchronous operations are also supported!:thumbsup:

Install

To install the package, you'll need Python 3.8 or above installed on your computer. From your command line:

pip install 1secMail

Note If you're willing to install the development version, do the following:

git clone https://github.com/qvco/1secMail-Python.git

cd 1secMail-Python

pip install -r requirements.txt

pip install -e .

Usage

Generating Email Addresses

To generate a list of random email addresses, use the random_email() method:

import secmail

client = secmail.Client()

client.random_email(amount=3)
>>> ['[e-mail]', '[e-mail]', '[e-mail]']

You can also generate a custom email address by specifying the username and domain:

Note Specifying a domain is optional!

client.custom_email(username="bobby-bob", domain="kzccv.com")
>>> '[e-mail]'

Receiving Messages

To wait until a new message is received, use the await_new_message() method:

message = client.await_new_message("[e-mail]")

To check all messages received on a particular email address, use the get_inbox() method and pass the email address:

inbox = client.get_inbox("[e-mail]")
for message in inbox:
    print(message.id)
    print(message.from_address)
    print(message.subject)
    print(message.date)

You can also fetch a single message using the get_message() method and passing the email address and message ID:

message = client.get_message(address="[e-mail]", message_id=235200687)
print(message.id)
print(message.subject)
print(message.body)
print(message.text_body)
print(message.html_body)
print(message.attachments)
print(message.date)

Downloading an attachment

You can download an attachment from a message in the inbox of a specified email address using the download_attachment method like this:

client.download_attachment(address, message_id, attachment_filename)
>>> 'Path: (C:\Users\user\path/config/rocket.png), Size: 49071B'

Asynchronous Client

Generating Email Addresses

To generate a list of random email addresses, use the random_email() method:

import asyncio
import secmail

async def main():
    client = secmail.AsyncClient()
    email_addresses = await client.random_email(amount=3)
    print(email_addresses)

asyncio.run(main())
>>> ['[e-mail]', '[e-mail]', '[e-mail]']

You can also generate a custom email address by specifying the username and domain:

Note Specifying a domain is optional!

await client.custom_email(username="bobby-bob", domain="kzccv.com")
>>> '[e-mail]'

Receiving Messages

To wait until a new message is received, use the await_new_message() method:

import asyncio
import secmail

async def main():
    client = secmail.AsyncClient()
    message = await client.await_new_message("[e-mail]")
    print(f"{message.from_address}: {message.subject}")

asyncio.run(main())

To check all messages received on a particular email address, use the get_inbox() method and pass the email address:

import asyncio
import secmail

async def main():
    client = secmail.AsyncClient()
    inbox = await client.get_inbox("[e-mail]")
    print(f"You have {len(inbox)} messages in your inbox.")

    for message in inbox:
        print(message.id)
        print(message.from_address)
        print(message.subject)
        print(message.date)

asyncio.run(main())

You can also fetch a single message using the get_message() method and passing the email address and message ID:

import asyncio
import secmail

async def main():
    client = secmail.AsyncClient()
    address = "[e-mail]"
    inbox = await client.get_inbox(address)
    message_id = inbox[0].id
    message = await client.get_message(address, message_id)

    print(message.id)
    print(message.subject)
    print(message.body)
    print(message.text_body)
    print(message.html_body)
    print(message.attachments)
    print(message.date)

asyncio.run(main())

Downloading an attachment

You can download an attachment from a message in the inbox of a specified email address using the download_attachment method like this:

import asyncio
import secmail

async def main():
    client = secmail.AsyncClient()
    address = "[e-mail]"
    inbox = await client.get_inbox(address)
    message_id = inbox[0].id
    message = await client.get_message(address, message_id)
    attachment_filename = message.attachments[0].filename
    await client.download_attachment(address, message_id, attachment_filename)

asyncio.run(main())

>>> 'Path: (C:\Users\user\path/config/rocket.png), Size: 49071B'

Licnese

This software is licensed under the MIT © Qvco.