Skip to main content

Mailme API Client

Project description

Mailme API

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 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 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 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

pip install mailme-api

Usage

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.

Build Automation

Build Status Coverage Status PyPi Status License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mailme-api-0.2.2.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

mailme_api-0.2.2-py2.py3-none-any.whl (6.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mailme-api-0.2.2.tar.gz.

File metadata

  • Download URL: mailme-api-0.2.2.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.8.3 requests/2.27.1 setuptools/44.1.0 requests-toolbelt/1.0.0 tqdm/4.64.1 CPython/2.7.18

File hashes

Hashes for mailme-api-0.2.2.tar.gz
Algorithm Hash digest
SHA256 b27122d9a4b1da41e35683745f2b7791893e9bec66b98672f64a402c224e85ad
MD5 d146c48e53e280076c363fcd44a31cda
BLAKE2b-256 a5eb3095f4a38e7dc8acc1d15a4576bbe8429234508ac7f6f40ee7094338a9c9

See more details on using hashes here.

File details

Details for the file mailme_api-0.2.2-py2.py3-none-any.whl.

File metadata

  • Download URL: mailme_api-0.2.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.8.3 requests/2.27.1 setuptools/44.1.0 requests-toolbelt/1.0.0 tqdm/4.64.1 CPython/2.7.18

File hashes

Hashes for mailme_api-0.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6054e8788cb836a498aff70b3b72dc0b94a0c66390be4aa8a9bb2a12eb7eaeb3
MD5 62a1fbc384bb9ba9550138a09b3af84f
BLAKE2b-256 04c2f3bcaa2c8465383a98b12d70c0acab6cf2c9c63bec4bac47b278627296d5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page