# [Mailme API](http://mailme-api.hive.pt)
API Python client for the Mailme service.
## 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
[![Build Status](https://app.travis-ci.com/hivesolutions/mailme-api.svg?branch=master)](https://travis-ci.com/github/hivesolutions/mailme-api)
[![Build Status GitHub](https://github.com/hivesolutions/mailme-api/workflows/Main%20Workflow/badge.svg)](https://github.com/hivesolutions/mailme-api/actions)
[![Coverage Status](https://coveralls.io/repos/hivesolutions/mailme-api/badge.svg?branch=master)](https://coveralls.io/r/hivesolutions/mailme-api?branch=master)
[![PyPi Status](https://img.shields.io/pypi/v/mailme-api.svg)](https://pypi.python.org/pypi/mailme-api)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/)
Raw data
{
"_id": null,
"home_page": "http://mailme-api.hive.pt",
"name": "mailme-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "mailme api",
"author": "Hive Solutions Lda.",
"author_email": "development@hive.pt",
"download_url": "https://files.pythonhosted.org/packages/cb/2f/08f2f97b415f30eb7d29d0c1f31eb405cb8431d314d5d5d0c6a72875241f/mailme-api-0.2.1.tar.gz",
"platform": null,
"description": "# [Mailme API](http://mailme-api.hive.pt)\n\nAPI Python client for the Mailme service.\n\n## Configuration\n\n| Name | Type | Default | Description |\n| ------------------- | ----- | -------------------------------- | ------------------------------------------------------- |\n| **MAILME_BASE_URL** | `str` | `https://mailme.bemisc.com/api/` | The base URL for the Mailme API requests. |\n| **MAILME_KEY** | `str` | `None` | The secret key to be used to authenticate API requests. |\n\n## Installation\n\n```bash\npip install mailme-api\n```\n\n## Usage\n\n```bash\nRECEIVERS=\"receiver@domain.com\" \\\nCONTENTS=\"Hello World\" \\\npython -m mailme.scripts.sender\n```\n\n## License\n\nMailme API is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).\n\n## Build Automation\n\n[![Build Status](https://app.travis-ci.com/hivesolutions/mailme-api.svg?branch=master)](https://travis-ci.com/github/hivesolutions/mailme-api)\n[![Build Status GitHub](https://github.com/hivesolutions/mailme-api/workflows/Main%20Workflow/badge.svg)](https://github.com/hivesolutions/mailme-api/actions)\n[![Coverage Status](https://coveralls.io/repos/hivesolutions/mailme-api/badge.svg?branch=master)](https://coveralls.io/r/hivesolutions/mailme-api?branch=master)\n[![PyPi Status](https://img.shields.io/pypi/v/mailme-api.svg)](https://pypi.python.org/pypi/mailme-api)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/)\n\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Mailme API Client",
"version": "0.2.1",
"project_urls": {
"Homepage": "http://mailme-api.hive.pt"
},
"split_keywords": [
"mailme",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6eac0c092bc1022fb31006cb4e96dd87f0c465f36bfd891d14f0e016be9bf417",
"md5": "fc034c5d80427a8454fc2e0f2256da6b",
"sha256": "d26e3b4779954b5c890155a4cee15ba16bd3e3ed3fc72a730ba0be336519ec1e"
},
"downloads": -1,
"filename": "mailme_api-0.2.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc034c5d80427a8454fc2e0f2256da6b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6039,
"upload_time": "2024-04-30T14:56:29",
"upload_time_iso_8601": "2024-04-30T14:56:29.494147Z",
"url": "https://files.pythonhosted.org/packages/6e/ac/0c092bc1022fb31006cb4e96dd87f0c465f36bfd891d14f0e016be9bf417/mailme_api-0.2.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb2f08f2f97b415f30eb7d29d0c1f31eb405cb8431d314d5d5d0c6a72875241f",
"md5": "fd2482a96251880437855182ebf82b9d",
"sha256": "b00c2d7d17eb49be7d2eb33bd241d2cc4803e87e7b8a482c609b3c92c22d5486"
},
"downloads": -1,
"filename": "mailme-api-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "fd2482a96251880437855182ebf82b9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3781,
"upload_time": "2024-04-30T14:56:30",
"upload_time_iso_8601": "2024-04-30T14:56:30.552724Z",
"url": "https://files.pythonhosted.org/packages/cb/2f/08f2f97b415f30eb7d29d0c1f31eb405cb8431d314d5d5d0c6a72875241f/mailme-api-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 14:56:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mailme-api"
}