https://github.com/daleal/mailer
Generic mailer microservice
https://github.com/daleal/mailer
docker-image mailer microservice
Last synced: about 1 month ago
JSON representation
Generic mailer microservice
- Host: GitHub
- URL: https://github.com/daleal/mailer
- Owner: daleal
- License: mit
- Created: 2019-12-13T20:01:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T21:18:24.000Z (about 3 years ago)
- Last Synced: 2025-09-11T07:16:35.411Z (10 months ago)
- Topics: docker-image, mailer, microservice
- Language: Python
- Homepage: https://hub.docker.com/r/daleal/mailer
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mailer
This module is a generic mailer API created only to serve as a microservice.
## Usage
```bash
cp .env.example .env # change env variables
docker-compose build
docker-compose up # The API can be found at port 5000
```
## Testing
To test the mailer, a sample script has been provided. To execute it, just run
```bash
python3 ghost_client.py [COMMAND] [*ARGS]
```
Where `[COMMAND]` is the name of the desired command and `[*ARGS]` corresponds to the arguments of the desired command separated by spaces. If a command has no arguments, `[*ARGS]` can be ignored. To see a list of every possible command, execute:
```bash
python3 ghost_client.py
```
Keep in mind that some API methods will require a `KEY`, so remember to have the same `KEY` environmental variable in the API server and in the script machine. The script automatically loads variables from a `.env` file, so putting the `KEY` in a `.env` file should be enough.