# jodev_emailpy
**A Python package that helps you send and recieve email directly using emailjs restful service**
## Getting Started
To install into your python environment use
`pip install jodev-emailpy`
On successfull installation , you are ready to start using jodev_emailpy to start recieving and sending email directly from your client side application no backend server needed
# Useage
To send a message to your configured email
```python
from jodev_emailpy import EmailPy
PUBLIC_KEY :str = "YOUR-PUBLIC-KEY-FROM-EMAILJS"
SERVICE_ID : str = "YOUR-SERVICE-ID-FROM-EMAILJS"
TEMPLATE_ID :str = "YOUR-TEMPLATE-ID-FROM-EMAILJS"
TEMPLATE_PARAMS : dict = {
# customize to fit as per your template variables requirement e.g
"email_id" : "jodek@gmail.com",
"message": "hello test mssg"
}
# input your public_key to initialize the client
client = EmailPy(PUBLIC_KEY)
client.send(service_id=SERVICE_ID, template_id=TEMPLATE_ID,
template_params=TEMPLATE_PARAMS)
```
To retrieve a list of email history
```python
ACCESS_TOKEN = "YOUR-ACCESS-TOKEN-SECRET-KEY"
response = client.get_history(access_token=ACCESS_TOKEN)
```
Other optional arguments to pass to get_history method are :
* count : int #this is the count of email history to retrieve
* page : int default is 1 . this helps for pagination
> note access token can then be omitted for successive call of get_history()
if response status is 200 without error you should be able to retrieve email history
```python
print(response.json()['rows'])
```
> *ensure you have signed up on emailjs website so as to have access to credentials needed*. if not, here is their website link to sign up [https://dashboard.emailjs.com/sign-up](https://dashboard.emailjs.com/sign-up)
Raw data
{
"_id": null,
"home_page": "https://github.com/joelwry/jodev_emailpy",
"name": "jodev-emailpy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "emailjs,email,email sender,email reciever",
"author": "joelwry",
"author_email": "joelwryjolomi@gemail.com",
"download_url": "https://files.pythonhosted.org/packages/8d/93/d985ea01635df1979f85473f13c706fc3eb657424cad1776edb87455fbf9/jodev_emailpy-0.1.1.tar.gz",
"platform": null,
"description": "\r\n# jodev_emailpy\r\n**A Python package that helps you send and recieve email directly using emailjs restful service**\r\n\r\n## Getting Started\r\nTo install into your python environment use \r\n`pip install jodev-emailpy`\r\n\r\nOn successfull installation , you are ready to start using jodev_emailpy to start recieving and sending email directly from your client side application no backend server needed\r\n\r\n# Useage\r\nTo send a message to your configured email\r\n```python\r\nfrom jodev_emailpy import EmailPy\r\n\r\nPUBLIC_KEY :str = \"YOUR-PUBLIC-KEY-FROM-EMAILJS\"\r\nSERVICE_ID : str = \"YOUR-SERVICE-ID-FROM-EMAILJS\"\r\nTEMPLATE_ID :str = \"YOUR-TEMPLATE-ID-FROM-EMAILJS\"\r\nTEMPLATE_PARAMS : dict = {\r\n # customize to fit as per your template variables requirement e.g\r\n \"email_id\" : \"jodek@gmail.com\",\r\n \"message\": \"hello test mssg\"\r\n \r\n}\r\n# input your public_key to initialize the client\r\nclient = EmailPy(PUBLIC_KEY)\r\n\r\nclient.send(service_id=SERVICE_ID, template_id=TEMPLATE_ID, \r\ntemplate_params=TEMPLATE_PARAMS)\r\n\r\n```\r\n\r\nTo retrieve a list of email history \r\n\r\n```python\r\nACCESS_TOKEN = \"YOUR-ACCESS-TOKEN-SECRET-KEY\"\r\nresponse = client.get_history(access_token=ACCESS_TOKEN)\r\n```\r\nOther optional arguments to pass to get_history method are :\r\n* count : int #this is the count of email history to retrieve\r\n* page : int default is 1 . this helps for pagination\r\n\r\n> note access token can then be omitted for successive call of get_history()\r\n\r\nif response status is 200 without error you should be able to retrieve email history\r\n```python\r\nprint(response.json()['rows'])\r\n```\r\n\r\n> *ensure you have signed up on emailjs website so as to have access to credentials needed*. if not, here is their website link to sign up [https://dashboard.emailjs.com/sign-up](https://dashboard.emailjs.com/sign-up)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python library for recieving email directly in your application using emailjs",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/joelwry/jodev_emailpy"
},
"split_keywords": [
"emailjs",
"email",
"email sender",
"email reciever"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c8bce996fdf8105fd198d2ff15b097fe90783e9fcac579909e28e4a000a0da2",
"md5": "5f0ee3a911876841e608f19009b5a7c7",
"sha256": "ee946108ca1c9d393a8eda70e23b353e616ce7a2cff1e1ee9ed834821f87eb58"
},
"downloads": -1,
"filename": "jodev_emailpy-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f0ee3a911876841e608f19009b5a7c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5039,
"upload_time": "2023-12-17T03:29:07",
"upload_time_iso_8601": "2023-12-17T03:29:07.124890Z",
"url": "https://files.pythonhosted.org/packages/3c/8b/ce996fdf8105fd198d2ff15b097fe90783e9fcac579909e28e4a000a0da2/jodev_emailpy-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d93d985ea01635df1979f85473f13c706fc3eb657424cad1776edb87455fbf9",
"md5": "8bf07f6455b62fe1613cfac54a90a478",
"sha256": "6400cd94af62249c1dd6638c8974d2e467e0a96a5958eeadbb12201f382c639d"
},
"downloads": -1,
"filename": "jodev_emailpy-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "8bf07f6455b62fe1613cfac54a90a478",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4313,
"upload_time": "2023-12-17T03:29:09",
"upload_time_iso_8601": "2023-12-17T03:29:09.433882Z",
"url": "https://files.pythonhosted.org/packages/8d/93/d985ea01635df1979f85473f13c706fc3eb657424cad1776edb87455fbf9/jodev_emailpy-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-17 03:29:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joelwry",
"github_project": "jodev_emailpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "jodev-emailpy"
}
JSON
