https://github.com/hivesolutions/mailme-api
API Python client for the Mailme service
https://github.com/hivesolutions/mailme-api
api client mailme python rest
Last synced: 4 months ago
JSON representation
API Python client for the Mailme service
- Host: GitHub
- URL: https://github.com/hivesolutions/mailme-api
- Owner: hivesolutions
- Created: 2016-02-07T12:22:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-03-04T20:56:44.000Z (over 1 year ago)
- Last Synced: 2025-12-26T20:31:03.820Z (6 months ago)
- Topics: api, client, mailme, python, rest
- Language: Python
- Homepage: http://mailme-api.hive.pt
- Size: 96.7 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# [Mailme API](http://mailme-api.hive.pt)
**Mailme API is a Python client library that provides a simple and convenient interface for interacting with the Mailme email gateway service.** With this client, developers can seamlessly send emails, manage recipients, and integrate [Mailme](http://mailme.hive.pt) into their Python-based applications with minimal setup.
## Description
Mailme API simplifies the process of sending emails programmatically by offering a Python-based interface to the [Mailme](http://mailme.hive.pt) service. It abstracts the underlying HTTP API into a Pythonic syntax, making it easier to implement and integrate email-sending functionality into your projects.
The library supports key features of the [Mailme](http://mailme.hive.pt) service, such as:
- **Authentication**: Secure your requests with a secret API key.
- **Customizable Email Content**: Define recipients, subject lines, and HTML or plain text email content.
- **Environment Variable Configuration**: Easily manage settings through environment variables for flexibility across different deployment environments.
- **Streamlined Email Sending**: Quickly send emails with minimal boilerplate code.
This API client is particularly useful for Python developers who need a reliable way to send notifications, reports, or other automated emails without diving into the complexities of SMTP servers or manual REST API calls.
### Key Benefits
- **Ease of Use**: A straightforward interface for sending emails with a few lines of code.
- **Flexibility**: Supports customizable email parameters, including multiple recipients and formatted content.
- **Seamless Integration**: Designed to fit naturally into Python applications and scripts.
- **Open Source**: Fully open-sourced under the Apache License 2.0, encouraging collaboration and contributions.
## Configuration
| Name | Type | Default | Description |
| ------------------- | ----- | -------------------------------- | ------------------------------------------------------- |
| **MAILME_BASE_URL** | `str` | `https://mailme.bemisc.com/api/` | The base URL for the Mailme API requests. |
| **MAILME_KEY** | `str` | `None` | The secret key to be used to authenticate API requests. |
## Installation
```bash
pip install mailme-api
```
## Usage
```bash
RECEIVERS="receiver@domain.com" \
CONTENTS="Hello World" \
python -m mailme.scripts.sender
```
## License
Mailme API is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
## Build Automation
[](https://github.com/hivesolutions/mailme-api/actions)
[](https://coveralls.io/r/hivesolutions/mailme-api?branch=master)
[](https://pypi.python.org/pypi/mailme-api)
[](https://www.apache.org/licenses/)