emailfly 1.0.0

Simple library to write python emails

Mailer Module

Overview

The Mailer module is a configurable Python class that handles email functionalities across an application. It provides robust features for sending emails with HTML templates, attachments, and scheduling, as well as reading emails with advanced filtering capabilities.

Features

• Send emails with HTML templates
• Dynamic HTML template rendering
• Attachment support
• CC and BCC email support
• Email validation
• Email scheduling
• Email reading with filtering
• IMAP and SMTP support

Installation

Dependencies

• Python 3.7+
• Required libraries:
  • Pillow (PIL)
  • beautifulsoup4

Install dependencies using pip:

pip install Pillow beautifulsoup4

Usage

Initializing the Mailer

from emailfly import Emailer

mailer = Mailer(
    sender_email="[e-mail]",
    password="your_password",
    sender_name="Your Name",
    port=587,
    smtp_server="smtp.gmail.com"
)

Sending an Email

result = mailer.send_email(
    subject="Welcome",
    html_template="app/templates/welcome",
    recipients=["[e-mail]"],
    data={"name": "John Doe"},
    cc_email=["[e-mail]"],
    bcc_email=["[e-mail]"]
)

Scheduling an Email

result = mailer.schedule_email(
    subject="Delayed Notification",
    html_template="app/templates/notification",
    recipients=["[e-mail]"],
    delay_seconds=3600  # Send after 1 hour
)

Reading Emails

emails = mailer.read_emails(
    username="[e-mail]",
    password="your_password",
    folder="INBOX",
    limit=5,
    filter_criteria={
        "from": "[e-mail]",
        "subject": "Important"
    },
    mark_as_read=True
)

Important Notes

• Use app-specific passwords for Gmail
• Ensure HTML templates are properly formatted
• Handle exceptions when sending or reading emails

Security

• Never hardcode sensitive information like passwords
• Use environment variables or secure credential management

Limitations

• Requires internet connectivity
• Email sending/reading depends on SMTP/IMAP server availability

Contributing

Contributions are welcome! Please submit pull requests or open issues on the project repository.

License

[Add your project's license information]