https://github.com/botsarefuture/mailservice
API for sending emails
https://github.com/botsarefuture/mailservice
Last synced: 3 months ago
JSON representation
API for sending emails
- Host: GitHub
- URL: https://github.com/botsarefuture/mailservice
- Owner: botsarefuture
- Created: 2024-03-28T07:53:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T18:52:12.000Z (almost 2 years ago)
- Last Synced: 2024-09-06T22:15:00.344Z (almost 2 years ago)
- Language: Python
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Email Sending Service
## Introduction
This project provides a Flask-based email sending service that allows users to send emails from their domain using a centralized email server. The service supports user registration, login, and domain-specific email sending with SPF and DKIM authentication.
## Features
- User registration and login functionality.
- Domain-specific email sending with SPF and DKIM authentication.
- Centralized email server hosted at "mailservice.luova.club".
- API endpoints for user authentication and email sending.
- Error handling and response codes for API requests.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/your_username/email-sending-service.git
cd email-sending-service
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Configure Flask app settings in `app.py`, such as SMTP server credentials and MongoDB connection details.
4. Run the Flask app:
```bash
python app.py
```
## API Endpoints
- **Register User**: `/register` (POST)
- **Login User**: `/login` (POST)
- **Send Email**: `/send_email` (POST)
For detailed API documentation, refer to [API Guide](api_guide.md).
## Configuration Guide
To configure your domain for sending emails through the email sending service, follow the [Domain Configuration Guide](domain_configuration_guide.md).
## Contributing
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.
## License
This project is licensed under the [MIT License](LICENSE).
In addition to the main README file, you may want to include separate files for detailed API documentation (`api_guide.md`) and domain configuration guide (`domain_configuration_guide.md`). These files can provide more detailed information about API endpoints and domain configuration steps, respectively.