Omnimail is a custom Frappe application designed to connect to Amazon Web Services (AWS) for sending emails and tracking various email events such as bounces, complaints, opens, and clicks. This README file provides an overview of the application and guides you through its setup and usage.
Omnimail offers the following features:
- Sending emails using the AWS Simple Email Service (SES).
- Tracking email bounces to monitor failed delivery attempts.
- Tracking email complaints to identify potential issues with email content or delivery.
- Tracking email opens and clicks to measure recipient engagement.
Before installing Omnimail, make sure you have the following prerequisites in place:
- A Frappe or ERPNext instance set up and running.
- An AWS account with access to the Simple Email Service (SES) and Simple Notification Service (SNS).
- AWS API credentials (access key and secret key) with appropriate permissions for SES and SNS.
To install Omnimail, follow these steps:
-
Clone the Omnimail repository to your Frappe or ERPNext instance's
appsdirectory:$ cd /path/to/frappe/apps
$ git clone https://github.com/your-username/omnimail.git
-
Install the application using the Frappe Bench command:
$ cd /path/to/frappe
$ bench --site your-site-name install-app omnimail
After installing Omnimail, you need to configure it to connect to your AWS account. Follow these steps to set up the necessary configurations:
- Open the Omnimail application in your Frappe or ERPNext instance.
- Navigate to the AWS Settings page.
- Enter your AWS API credentials (access key and secret key).
- Save the configuration.
Omnimail provides an intuitive user interface within your Frappe or ERPNext instance for managing email sending and tracking. Here's how to get started:
- Log in to your Frappe or ERPNext instance.
- Open the Omnimail application.
- Use the provided options to compose and send emails using AWS SES.
- Access the relevant sections to track and analyze email bounces, complaints, opens, and clicks.
We welcome contributions to enhance Omnimail and address issues. If you'd like to contribute, please follow these steps:
- Fork the Omnimail repository.
- Create a new branch for your feature or bug fix.
- Make the necessary changes.
- Test your changes thoroughly.
- Submit a pull request explaining your changes and the problem they solve.
Omnimail is open-source software licensed under the MIT License. You are free to modify and distribute it as per the terms of the license.
Omnimail utilizes the following doctypes to track and manage email events:
-
Email Status: Represents the status of an email sent through AWS SES, including information such as the AWS message ID, status (e.g., bounced, delivered, opened), and associated bounces, complaints, opens, and clicks.
-
Email Bounce: Captures details about bounced emails, including the email ID, bounce type, sub-type, and the email addresses of recipients who experienced the bounce.
-
Email Complaint: Tracks complaints received for emails, including the email ID, complaint feedback type (e.g., abuse, not-spam), and the email addresses of recipients who made the complaint.
-
Email Open Event: Records events when recipients open emails, storing the email ID, the IP address of the recipient who opened the email, and the date and time of the open event.
-
Email Click Event: Captures events when recipients click on links within emails, storing the email ID, the IP address of the recipient who clicked the link, the URL of the clicked link, and the date and time of the click event.
These doctypes enable tracking and analysis of email events and recipient engagement within Omnimail.
If you encounter any issues or have questions regarding Omnimail, please feel free to open an issue in the GitHub repository. We'll be glad to assist you.
Thank you for using Omnimail!