| Name | gmail-connector JSON |
| Version |
1.0
JSON |
| download |
| home_page | |
| Summary | Python module to, send SMS, emails and read emails |
| upload_time | 2023-10-27 00:14:16 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2020 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
gmail
smtp
imap
tls
ssl
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[][pypi]
[](https://www.python.org/)
[][gha-pg]
[][gha-pypi]
[][gha-md]
[][pypi-files]
[][pypi]
[][dependants]
[][api-repo]
[][api-repo]
[][api-repo]
# Gmail Connector
Python module to send SMS, emails and read emails in any folder.
> As of May 30, 2022, Google no longer supports third party applications accessing Google accounts only using username
> and password (which was originally available through [lesssecureapps](https://myaccount.google.com/lesssecureapps))
> <br>
> An alternate approach is to generate [apppasswords](https://myaccount.google.com/apppasswords) instead.<br>
> **Reference:** https://support.google.com/accounts/answer/6010255
## Installation
```shell
pip install gmail-connector
```
## Env Vars
Environment variables can be loaded from any `.env` file.
```bash
GMAIL_USER='username@gmail.com',
GMAIL_PASS='<ACCOUNT_PASSWORD>'
```
<details>
<summary><strong>Env variable customization</strong></summary>
To load a custom `.env` file, set the filename as the env var `env_file` before importing `gmailconnector`
```python
import os
os.environ['env_file'] = 'custom' # to load a custom .env file
import gmailconnector as gc
```
To avoid using env variables, arguments can be loaded during object instantiation.
```python
import gmailconnector as gc
kwargs = dict(gmail_user='EMAIL_ADDRESS',
gmail_pass='PASSWORD',
encryption=gc.Encryption.SSL,
timeout=5)
email_obj = gc.SendEmail(**kwargs)
```
</details>
## Usage
### [Send SMS][send-sms]
```python
import gmailconnector as gc
sms_object = gc.SendSMS()
# sms_object = gc.SendSMS(encryption=gc.Encryption.SSL) to use SSL
auth = sms_object.authenticate # Authentication happens before sending SMS if not instantiated separately
assert auth.ok, auth.body
response = sms_object.send_sms(phone='1234567890', country_code='+1', message='Test SMS using gmail-connector',
sms_gateway=gc.SMSGateway.verizon, delete_sent=True) # set as False to keep the SMS sent
assert response.ok, response.json()
print(response.body)
```
<details>
<summary><strong>
More on <a href="https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_sms.py">Send SMS</a>
</strong></summary>
:warning: Gmail's SMS Gateway has a payload limit. So, it is recommended to break larger messages into multiple SMS.
###### Additional args:
- **subject:** Subject of the message. Defaults to `Message from email address`
- **sms_gateway:** SMS gateway of the carrier. Defaults to `tmomail.net`
- **delete_sent:** Boolean flag to delete the outbound email from SentItems. Defaults to `False`
> Note: If known, using the `sms_gateway` will ensure proper delivery of the SMS.
</details>
### [Send Email][send-email]
```python
import gmailconnector as gc
mail_object = gc.SendEmail()
# mail_object = gc.SendEmail(encryption=gc.Encryption.SSL) to use SSL
auth = mail_object.authenticate # Authentication happens in send_email if not instantiated beforehand
assert auth.ok, auth.body
# Send a basic email
response = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!')
assert response.ok, response.json()
print(response.body)
```
**To verify recipient email before sending. Authentication not required, uses SMTP port `25`**
```python
import gmailconnector as gc
validation_result = gc.validate_email(email_address='someone@example.com')
if validation_result.ok is True:
print('valid') # Validated and found the recipient address to be valid
elif validation_result.ok is False:
print('invalid') # Validated and found the recipient address to be invalid
else:
print('validation incomplete') # Couldn't validate (mostly because port 25 is blocked by ISP)
```
<details>
<summary><strong>
More on <a href="https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_email.py">Send Email
</a></strong></summary>
```python
import os
import gmailconnector as gc
mail_object = gc.SendEmail()
auth = mail_object.authenticate # Authentication happens in send_email if not instantiated beforehand
assert auth.ok, auth.body
# Different use cases to add attachments with/without custom filenames to an email
images = [os.path.join(os.getcwd(), 'images', image) for image in os.listdir('images')]
names = ['Apple', 'Flower', 'Balloon']
# Use case 1 - Send an email with attachments but no custom attachment name
response = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!',
attachment=images)
assert response.ok, response.body
print(response.json())
# Use case 2 - Use a dictionary of attachments and custom attachment names
response = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!',
custom_attachment=dict(zip(images, names)))
assert response.ok, response.body
print(response.json())
# Use case 3 - Use list of attachments and list of custom attachment names
response = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!',
attachment=[images], filename=[names])
assert response.ok, response.body
print(response.json())
# Use case 4 - Use a single attachment and a custom attachment name for it
response = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!',
attachment=os.path.join('images', 'random_apple_xroamutiypa.jpeg'), filename='Apple')
assert response.ok, response.body
print(response.json())
```
###### Additional args:
- **body:** Body of the email. Defaults to blank.
- **html_body:** Body of the email formatted as HTML. Supports inline images with a public `src`.
- **attachment:** Filename(s) that has to be attached.
- **filename:** Custom name(s) for the attachment(s). Defaults to the attachment name itself.
- **sender:** Name that has to be used in the email.
- **cc:** Email address of the recipient to whom the email has to be CC'd.
- **bcc:** Email address of the recipient to whom the email has to be BCC'd.
> Note: To send email to more than one recipient, wrap `recipient`/`cc`/`bcc` in a list.
>
> `recipient=['username1@gmail.com', 'username2@gmail.com']`
</details>
### [Read Email][read-email]
```python
import datetime
import gmailconnector as gc
reader = gc.ReadEmail(folder=gc.Folder.all)
filter1 = gc.Condition.since(since=datetime.date(year=2010, month=5, day=1))
filter2 = gc.Condition.subject(subject="Security Alert")
filter3 = gc.Condition.text(reader.env.gmail_user)
filter4 = gc.Category.not_deleted
response = reader.instantiate(filters=(filter1, filter2, filter3, filter4)) # Apply multiple filters
assert response.ok, response.body
for each_mail in reader.read_mail(messages=response.body, humanize_datetime=False): # False to get datetime object
print(each_mail.date_time.date())
print("[%s] %s" % (each_mail.sender_email, each_mail.sender))
print("[%s] - %s" % (each_mail.subject, each_mail.body))
```
### Linting
`PreCommit` will ensure linting, and the doc creation are run on every commit.
**Requirement**
```shell
pip install sphinx==5.1.1 pre-commit==2.20.0 recommonmark==0.7.1
```
**Usage**
```shell
pre-commit run --all-files
```
### [Release Notes][release-notes]
**Requirement**
```shell
python -m pip install gitverse
```
**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```
### Pypi Module
[][packaging]
[https://pypi.org/project/gmail-connector/][pypi]
### Runbook
[][sphinx]
[https://thevickypedia.github.io/gmail-connector/][runbook]
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[api-repo]: https://api.github.com/repos/thevickypedia/gmail-connector
[read-email]: https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/read_email.py
[send-email]: https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_email.py
[send-sms]: https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_sms.py
[release-notes]: https://github.com/thevickypedia/gmail-connector/blob/master/release_notes.rst
[license]: https://github.com/thevickypedia/gmail-connector/blob/master/LICENSE
[pypi]: https://pypi.org/project/gmail-connector/
[pypi-files]: https://pypi.org/project/gmail-connector/#files
[runbook]: https://thevickypedia.github.io/gmail-connector/
[packaging]: https://packaging.python.org/tutorials/packaging-projects/
[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
[gha-md]: https://github.com/thevickypedia/gmail-connector/actions/workflows/markdown-validation.yml
[gha-pg]: https://github.com/thevickypedia/gmail-connector/actions/workflows/pages/pages-build-deployment
[gha-pypi]: https://github.com/thevickypedia/gmail-connector/actions/workflows/python-publish.yml
[dependants]: https://github.com/thevickypedia/gmail-connector/network/dependents
Raw data
{
"_id": null,
"home_page": "",
"name": "gmail-connector",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "gmail,smtp,imap,tls,ssl",
"author": "",
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": "",
"platform": null,
"description": "[][pypi]\n[](https://www.python.org/)\n\n[][gha-pg]\n[][gha-pypi]\n[][gha-md]\n\n[][pypi-files]\n[][pypi]\n[][dependants]\n\n[][api-repo]\n[][api-repo]\n[][api-repo]\n\n# Gmail Connector\nPython module to send SMS, emails and read emails in any folder.\n\n> As of May 30, 2022, Google no longer supports third party applications accessing Google accounts only using username \n> and password (which was originally available through [lesssecureapps](https://myaccount.google.com/lesssecureapps))\n> <br>\n> An alternate approach is to generate [apppasswords](https://myaccount.google.com/apppasswords) instead.<br>\n> **Reference:** https://support.google.com/accounts/answer/6010255\n\n## Installation\n```shell\npip install gmail-connector\n```\n\n## Env Vars\nEnvironment variables can be loaded from any `.env` file.\n```bash\nGMAIL_USER='username@gmail.com',\nGMAIL_PASS='<ACCOUNT_PASSWORD>'\n```\n\n<details>\n<summary><strong>Env variable customization</strong></summary>\n\nTo load a custom `.env` file, set the filename as the env var `env_file` before importing `gmailconnector`\n```python\nimport os\nos.environ['env_file'] = 'custom' # to load a custom .env file\nimport gmailconnector as gc\n```\nTo avoid using env variables, arguments can be loaded during object instantiation.\n```python\nimport gmailconnector as gc\nkwargs = dict(gmail_user='EMAIL_ADDRESS',\n gmail_pass='PASSWORD',\n encryption=gc.Encryption.SSL,\n timeout=5)\nemail_obj = gc.SendEmail(**kwargs)\n```\n</details>\n\n## Usage\n### [Send SMS][send-sms]\n```python\nimport gmailconnector as gc\n\nsms_object = gc.SendSMS()\n# sms_object = gc.SendSMS(encryption=gc.Encryption.SSL) to use SSL\nauth = sms_object.authenticate # Authentication happens before sending SMS if not instantiated separately\nassert auth.ok, auth.body\nresponse = sms_object.send_sms(phone='1234567890', country_code='+1', message='Test SMS using gmail-connector',\n sms_gateway=gc.SMSGateway.verizon, delete_sent=True) # set as False to keep the SMS sent\nassert response.ok, response.json()\nprint(response.body)\n```\n<details>\n<summary><strong>\nMore on <a href=\"https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_sms.py\">Send SMS</a>\n</strong></summary>\n\n:warning: Gmail's SMS Gateway has a payload limit. So, it is recommended to break larger messages into multiple SMS.\n\n###### Additional args:\n- **subject:** Subject of the message. Defaults to `Message from email address`\n- **sms_gateway:** SMS gateway of the carrier. Defaults to `tmomail.net`\n- **delete_sent:** Boolean flag to delete the outbound email from SentItems. Defaults to `False`\n\n> Note: If known, using the `sms_gateway` will ensure proper delivery of the SMS.\n</details>\n\n### [Send Email][send-email]\n```python\nimport gmailconnector as gc\n\nmail_object = gc.SendEmail()\n# mail_object = gc.SendEmail(encryption=gc.Encryption.SSL) to use SSL\nauth = mail_object.authenticate # Authentication happens in send_email if not instantiated beforehand\nassert auth.ok, auth.body\n\n# Send a basic email\nresponse = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!')\nassert response.ok, response.json()\nprint(response.body)\n```\n\n**To verify recipient email before sending. Authentication not required, uses SMTP port `25`**\n```python\nimport gmailconnector as gc\n\nvalidation_result = gc.validate_email(email_address='someone@example.com')\nif validation_result.ok is True:\n print('valid') # Validated and found the recipient address to be valid\nelif validation_result.ok is False:\n print('invalid') # Validated and found the recipient address to be invalid\nelse:\n print('validation incomplete') # Couldn't validate (mostly because port 25 is blocked by ISP)\n```\n\n<details>\n<summary><strong>\nMore on <a href=\"https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_email.py\">Send Email\n</a></strong></summary>\n\n```python\nimport os\nimport gmailconnector as gc\n\nmail_object = gc.SendEmail()\nauth = mail_object.authenticate # Authentication happens in send_email if not instantiated beforehand\nassert auth.ok, auth.body\n\n# Different use cases to add attachments with/without custom filenames to an email\nimages = [os.path.join(os.getcwd(), 'images', image) for image in os.listdir('images')]\nnames = ['Apple', 'Flower', 'Balloon']\n\n# Use case 1 - Send an email with attachments but no custom attachment name\nresponse = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!',\n attachment=images)\nassert response.ok, response.body\nprint(response.json())\n\n# Use case 2 - Use a dictionary of attachments and custom attachment names\nresponse = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!',\n custom_attachment=dict(zip(images, names)))\nassert response.ok, response.body\nprint(response.json())\n\n# Use case 3 - Use list of attachments and list of custom attachment names\nresponse = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!',\n attachment=[images], filename=[names])\nassert response.ok, response.body\nprint(response.json())\n\n# Use case 4 - Use a single attachment and a custom attachment name for it\nresponse = mail_object.send_email(recipient='username@gmail.com', subject='Howdy!',\n attachment=os.path.join('images', 'random_apple_xroamutiypa.jpeg'), filename='Apple')\nassert response.ok, response.body\nprint(response.json())\n```\n\n###### Additional args:\n- **body:** Body of the email. Defaults to blank.\n- **html_body:** Body of the email formatted as HTML. Supports inline images with a public `src`.\n- **attachment:** Filename(s) that has to be attached.\n- **filename:** Custom name(s) for the attachment(s). Defaults to the attachment name itself.\n- **sender:** Name that has to be used in the email.\n- **cc:** Email address of the recipient to whom the email has to be CC'd.\n- **bcc:** Email address of the recipient to whom the email has to be BCC'd.\n\n> Note: To send email to more than one recipient, wrap `recipient`/`cc`/`bcc` in a list.\n>\n> `recipient=['username1@gmail.com', 'username2@gmail.com']`\n</details>\n\n### [Read Email][read-email]\n```python\nimport datetime\n\nimport gmailconnector as gc\n\nreader = gc.ReadEmail(folder=gc.Folder.all)\nfilter1 = gc.Condition.since(since=datetime.date(year=2010, month=5, day=1))\nfilter2 = gc.Condition.subject(subject=\"Security Alert\")\nfilter3 = gc.Condition.text(reader.env.gmail_user)\nfilter4 = gc.Category.not_deleted\nresponse = reader.instantiate(filters=(filter1, filter2, filter3, filter4)) # Apply multiple filters\nassert response.ok, response.body\nfor each_mail in reader.read_mail(messages=response.body, humanize_datetime=False): # False to get datetime object\n print(each_mail.date_time.date())\n print(\"[%s] %s\" % (each_mail.sender_email, each_mail.sender))\n print(\"[%s] - %s\" % (each_mail.subject, each_mail.body))\n```\n\n### Linting\n`PreCommit` will ensure linting, and the doc creation are run on every commit.\n\n**Requirement**\n```shell\npip install sphinx==5.1.1 pre-commit==2.20.0 recommonmark==0.7.1\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n### [Release Notes][release-notes]\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n### Pypi Module\n[][packaging]\n\n[https://pypi.org/project/gmail-connector/][pypi]\n\n### Runbook\n[][sphinx]\n\n[https://thevickypedia.github.io/gmail-connector/][runbook]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[api-repo]: https://api.github.com/repos/thevickypedia/gmail-connector\n[read-email]: https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/read_email.py\n[send-email]: https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_email.py\n[send-sms]: https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_sms.py\n[release-notes]: https://github.com/thevickypedia/gmail-connector/blob/master/release_notes.rst\n[license]: https://github.com/thevickypedia/gmail-connector/blob/master/LICENSE\n[pypi]: https://pypi.org/project/gmail-connector/\n[pypi-files]: https://pypi.org/project/gmail-connector/#files\n[runbook]: https://thevickypedia.github.io/gmail-connector/\n[packaging]: https://packaging.python.org/tutorials/packaging-projects/\n[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html\n[gha-md]: https://github.com/thevickypedia/gmail-connector/actions/workflows/markdown-validation.yml\n[gha-pg]: https://github.com/thevickypedia/gmail-connector/actions/workflows/pages/pages-build-deployment\n[gha-pypi]: https://github.com/thevickypedia/gmail-connector/actions/workflows/python-publish.yml\n[dependants]: https://github.com/thevickypedia/gmail-connector/network/dependents\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Python module to, send SMS, emails and read emails",
"version": "1.0",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/gmail-connector/issues",
"Docs": "https://thevickypedia.github.io/gmail-connector/",
"Homepage": "https://github.com/thevickypedia/gmail-connector",
"Release Notes": "https://github.com/thevickypedia/gmail-connector/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/gmail-connector"
},
"split_keywords": [
"gmail",
"smtp",
"imap",
"tls",
"ssl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ebafa781ccffc4cf82339dcd7f74c1827905b630794dc41c1693430f7e4c724",
"md5": "43a4a7fa4c35c7e467e297dad48302a8",
"sha256": "521198148d6f3551515e150a64c1ce663a48c9d124f0cd1873dc39ad2a693048"
},
"downloads": -1,
"filename": "gmail_connector-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43a4a7fa4c35c7e467e297dad48302a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22269,
"upload_time": "2023-10-27T00:14:16",
"upload_time_iso_8601": "2023-10-27T00:14:16.256008Z",
"url": "https://files.pythonhosted.org/packages/0e/ba/fa781ccffc4cf82339dcd7f74c1827905b630794dc41c1693430f7e4c724/gmail_connector-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-27 00:14:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "gmail-connector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gmail-connector"
}
