A utility designed to simplify the process of sending formatted emails through an SMTP server.
Project description
📧 MailBuddy
Welcome to the MailBuddy Library! This is a Python utility designed to make sending formatted emails a breeze! With support for both plain text and HTML email bodies, dynamic content injection, and easy SMTP server configuration, MailBuddy takes the hassle out of email composition. 🎉
🚀 Features
- SMTP Server Configuration: Easily set up your SMTP server with the
host
andport
parameters. - Flexible Email Body Input: Add email bodies as plain text, HTML, or even read from files.
- Dynamic Content Injection: Use format variables to personalize your email content.
- Easy Email Sending: Send emails with a single method call.
🛠️ Installation
Clone the repository:
git clone https://github.com/daftscientist/MailBuddy.git
Navigate to the project directory:
cd MailBuddy
🌟 Usage
Here's a quick example to get you started:
from MailBuddy import Email
# Create an email object
email = Email(
host='smtp.example.com',
port=587,
sender='sender@example.com'
)
# Add email body
email.add_plain_body('Hello, {name}!')
email.add_html_body('<h1>Hello, {name}!</h1>')
email.add_format_variables({'name': 'Alice'})
# Send the email
email.send(
recipient='recipient@example.com',
subject='Greetings'
)
📋 Method Details
Email(host: str, port: int, sender: str)
: Initializes theEmail
object with SMTP server details and the sender's email address.add_html_body_from_file(file_path: str)
: Adds an HTML body to the email from a file.add_format_variables(format_variables: dict)
: Adds a dictionary of variables for formatting the email body, with the item to be replaced as the key.add_html_body(html_body: str)
: Adds an HTML body to the email.add_plain_body(self, plain_body: str)
: Adds a plain text body to the email.send(self, recipient: str, subject: str)
: Composes and sends the email. Therecipient
parameter is the email address of the person receiving the email.
💬 Contributing
We welcome contributions! Feel free to open issues or submit pull requests. Let's make MailBuddy even better together! 🤝
📜 License
This project is licensed under the MIT License. See the LICENSE file for details.
📧 Contact
For any questions or suggestions, feel free to open an issue or reach out via email at contact@leojohnston.tech .
Happy emailing! 🚀📧✨
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mailbuddy-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e01d4be51c63af3e245e2fcd149013f72a99eb2cc9186545cb441537ff1afc0b |
|
MD5 | a2f7ca983fd85f9e9c1a35f097c75686 |
|
BLAKE2b-256 | 7add382e7fd7978ac40aa441b17a2fc55db09a430bddae7f4aa36e398bc4ba31 |