| Name | ua-email-client JSON |
| Version |
0.1.9
JSON |
| download |
| home_page | |
| Summary | Provides easy interface for sending emails through Amazons Simple Email Service. |
| upload_time | 2023-11-27 17:59:28 |
| maintainer | |
| docs_url | None |
| author | Your Name |
| requires_python | >=3.11,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# UA-Email-Client
Provides easy interface for sending emails through Amazons Simple Email Service.
## Motivation
To make a python API that could obfuscate the details of sending emails using AWS SES service.
## Code Example
```python
from ua_email_client import ua_email_client
client = ua_email_client.EmailClient(email)
# The template name given should be relative name to a file.
client.add_template("success.html")
# Destinations
client.send_email(destinations, "success.html", subject, body)
# No Template
client.send_email(destinations, None, subject, body, use_template=False)
```
## Installation
pip install --user ua-email-client
## Tests
**NOTE:** Running this test suite *WILL* send emails. Please specify an email which can receive emails. The emails can all be ignored once received.
To run the tests you will need to create a json configuration with some user-specific values. This file will be ua_email_client/tests/email_creds.json. It will be populated with:
```json
{
"email": "...",
"default_recipient": "...",
"secondary_recipient": "..."
}
```
Where `"email"` is the sending email, `"default_recipient"` is the main email you want to receive emails, and `"secondary_recipient"` is a second email to test sending emails to multiple recipients at once.
Once this file is created, just run:
```bash
cd ua_email_client/tests
nosetests test_ua_email_client.py
```
## Credits
[RyanJohannesBland](https://github.com/RyanJohannesBland)
[EtienneThompson](https://github.com/EtienneThompson)
## License
MIT
Raw data
{
"_id": null,
"home_page": "",
"name": "ua-email-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/be/ff/36687611586ba6fd12f19a60df4653034f5fdd5fab516b1acb67a54758d4/ua_email_client-0.1.9.tar.gz",
"platform": null,
"description": "# UA-Email-Client\n\nProvides easy interface for sending emails through Amazons Simple Email Service.\n\n## Motivation\n\nTo make a python API that could obfuscate the details of sending emails using AWS SES service.\n\n## Code Example\n\n```python\nfrom ua_email_client import ua_email_client\n\nclient = ua_email_client.EmailClient(email)\n# The template name given should be relative name to a file.\nclient.add_template(\"success.html\")\n\n# Destinations\nclient.send_email(destinations, \"success.html\", subject, body)\n# No Template\nclient.send_email(destinations, None, subject, body, use_template=False)\n```\n\n## Installation\n\npip install --user ua-email-client\n\n## Tests\n\n**NOTE:** Running this test suite *WILL* send emails. Please specify an email which can receive emails. The emails can all be ignored once received.\n\nTo run the tests you will need to create a json configuration with some user-specific values. This file will be ua_email_client/tests/email_creds.json. It will be populated with:\n```json\n{\n \"email\": \"...\",\n \"default_recipient\": \"...\",\n \"secondary_recipient\": \"...\"\n}\n```\n\nWhere `\"email\"` is the sending email, `\"default_recipient\"` is the main email you want to receive emails, and `\"secondary_recipient\"` is a second email to test sending emails to multiple recipients at once.\n\nOnce this file is created, just run:\n```bash\ncd ua_email_client/tests\nnosetests test_ua_email_client.py\n```\n\n## Credits\n\n[RyanJohannesBland](https://github.com/RyanJohannesBland)\n[EtienneThompson](https://github.com/EtienneThompson)\n\n## License\n\nMIT\n",
"bugtrack_url": null,
"license": "",
"summary": "Provides easy interface for sending emails through Amazons Simple Email Service.",
"version": "0.1.9",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "935fb52a29c971b325773bc1379c2a6930f7b8aad4f00aa8d3b1282b07669078",
"md5": "956065f21ad81e397234944dc5d67623",
"sha256": "1a324bc56f7d1f9fb95ffb03534d1fa6baeff9648d849cbe42aee6c6e6ef5cc3"
},
"downloads": -1,
"filename": "ua_email_client-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "956065f21ad81e397234944dc5d67623",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 6077,
"upload_time": "2023-11-27T17:53:30",
"upload_time_iso_8601": "2023-11-27T17:53:30.713078Z",
"url": "https://files.pythonhosted.org/packages/93/5f/b52a29c971b325773bc1379c2a6930f7b8aad4f00aa8d3b1282b07669078/ua_email_client-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "beff36687611586ba6fd12f19a60df4653034f5fdd5fab516b1acb67a54758d4",
"md5": "53ceab91a7d870bfe51d174c42080ddf",
"sha256": "518336b22334238e8454864489bcdc73bf2e8d9afb431761b1e9089bfcf2a4a6"
},
"downloads": -1,
"filename": "ua_email_client-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "53ceab91a7d870bfe51d174c42080ddf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 4299,
"upload_time": "2023-11-27T17:59:28",
"upload_time_iso_8601": "2023-11-27T17:59:28.912993Z",
"url": "https://files.pythonhosted.org/packages/be/ff/36687611586ba6fd12f19a60df4653034f5fdd5fab516b1acb67a54758d4/ua_email_client-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-27 17:59:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ua-email-client"
}
