{ "info": { "author": "Denis Karanja", "author_email": "dee.caranja@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Build Tools" ], "description": "Gmail API Wrapper For Python\n============================\n\nThis is a wrapper for the `google-api-python-client` library by Google.\n\n\nBehind the scenes\n----------------\n\n * *Language*: Python_\n * *Testing*: Tox_, Pytest_, Coverage_, Flake8_\n * *Deploying*: Ansible_\n * *CI*: CircleCI_\n * *Code*: Github_\n\n\nInstallation\n------------\n\n.. code:: bash\n\n pip install --upgrade gmail-api-wrapper\n\n\nSetup\n-----\n\n`gmail-api-wrapper` uses OAuth authentication\n\nGenerate a client ID and client secret Here_ under section\n**Step 1: Turn on the Gmail API**. Follow steps **a** to **h**.\n\nAfter you have downloaded the `client_secret.json` file,\nmove it to the `~/.credentials/` directory in your home directory.\n\n\nEnv Variables\n----------------------------------------------\n\nSet the following `env` variables.\n\n- Get scopes from GMAIL_SCOPES_\n\n.. code:: bash\n\n # Space delimited string\n export GAW_SCOPES=\"'gmail-scopes-1 'gmail-scope-2'\"\n\n # client_secret json file path\n\n # If you're using custom SSL certs, set GAW_CA_CERTS_PEM_FILE env variable\n export GAW_CA_CERTS_PEM_FILE=\n\n # The user Id to use. Default to 'me'. A special identifier for gmail\n # that refers to the email address used to do OAuth2 handshake\n export GAW_USER_ID=\n\n # Your preferred application name. Defaults to 'Gmail API Wrapper'\n export GAW_APPLICATION_NAME=\n\n # Disable ssl certs validation. Defaults to False\n export GAW_DISABLE_SSL_CERTS=True\n\n\n- View the permissions_granted_ to you application\n\n\n\nUsage - READ\n------------\n\n.. code:: python\n\n from gmail_api_wrapper.crud.read import GmailAPIReadWrapper\n\n\n gmail_api = GmailAPIReadWrapper()\n\n\n # Check unread messages. Returns a list of dicts in the below format\n gmail_api.check_new_mail()\n\n >>> [\n\n {\n 'subject': 'Sample Subject',\n 'base64_msg_body': 'base64string',\n 'from:' 'exapmle@mail_server.com'\n 'date': '2017-09-16T10:57:12.4323'\n },\n ]\n\n # Check new mail from specific sender. Returns a list of dicts above\n gmail_api.check_new_mail(sender='example@mail_server.com')\n\n\n\n # Alternatively, you get all unread messages from a specific sender\n gmail_api.get_unread_messages(sender='example@mail_server.com')\n\n >>> [\n\n {\n 'subject': 'Sample Subject',\n 'base64_msg_body': 'base64string',\n 'from:' 'exapmle@mail_server.com'\n 'date': '2017-09-16T10:57:12.4323'\n },\n ]\n\n\n\n\n # Get all labels present. Returns a list of strings\n gmail_api.get_labels()\n\n >>> ['INBOX', 'UNREAD', 'SPAM', 'DRAFTS']\n\n\n\n # Get total message count. Returns a formatted json object\n gmail_api.get_total_messages()\n\n >>> {\n 'Total Messages': 2017,\n 'Total Threads': 123,\n 'Email Address': 'example@mail_server.com'\n }\n\n\n # Get a list of messages. Defaults to INBOX if no label is specified\n gmail_api.list_messages()\n\n >>> [\n\n {\n 'subject': 'Sample Subject',\n 'base64_msg_body': 'base64string',\n 'from:' 'exapmle@mail_server.com'\n 'date': '2017-09-16T10:57:12.4323'\n },\n ]\n\n\n # Get a list of messages in DRAFTS and SPAM\n gmail_api.list_messages(labels=['DRAFTS', 'SPAM'])\n\n >>> [\n\n {\n 'subject': 'Sample Subject',\n 'base64_msg_body': 'base64string',\n 'from:' 'exapmle@mail_server.com'\n 'date': '2017-09-16T10:57:12.4323'\n },\n ]\n\n\n # Get a specific message. `message_id` passed must be a google message id object\n gmail_api.get_message('message_id')\n\n\nUsage - WRITE\n-------------\n\n.. code:: python\n\n from gmail_api_wrapper.crud.write import GmailAPIWriteWrapper\n\n api = GmailAPIWriteWrapper()\n\n\n # compose new mail\n api.compose_mail(subject='API Wrapper', body='Py client', to='email1,email2')\n\n >>> {\n 'id': 'blah-blah',\n 'labelsIds': ['INBOX', 'SENT', 'UNREAD'],\n 'threadId': 'blah-blah'\n }\n\n # compose new mail with cc and bcc\n api.compose_mail(subject='API Wrapper', body='Py client', to='email1,email2', cc='email1,email2', bcc='email1,email2')\n\n >>> {\n 'id': 'blah-blah',\n 'labelsIds': ['INBOX', 'SENT', 'UNREAD'],\n 'threadId': 'blah-blah'\n }\n\n # create new label\n api.create_label(name='Integrations')\n\n >>> {\n 'id': 'blah-blah',\n 'labelListVisibility': 'labelShow',\n 'messageListVisibility': 'show',\n 'name': 'Integrations'\n }\n\n\nAuthors\n-------\n\n* yoda \n\n\n.. _Python: https://www.python.org/\n.. _Tox: https://tox.readthedocs.io/en/latest/\n.. _Pytest: http://doc.pytest.org/en/latest/\n.. _Coverage: https://coverage.readthedocs.io/en/coverage-4.2/\n.. _Flake8: http://flake8.pycqa.org/en/latest/\n.. _Ansible: http://docs.ansible.com/ansible/index.html\n.. _CircleCI: https://circleci.com/gh/yoda-yoda/gmail-api-wrapper\n.. _Github: https://github.com/yoda-yoda/gmail-api-wrapper\n.. _Here: https://developers.google.com/gmail/api/quickstart/python\n.. _GMAIL_SCOPES: https://developers.google.com/gmail/api/auth/scopes/\n.. _permissions_granted: https://accounts.google.com/b/0/IssuedAuthSubTokens\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/yoda-yoda/gmail-api-wrapper/", "keywords": "gmail-api-wrapper,gmail python client", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "gmail-api-wrapper", "package_url": "https://pypi.org/project/gmail-api-wrapper/", "platform": "", "project_url": "https://pypi.org/project/gmail-api-wrapper/", "project_urls": { "Homepage": "https://github.com/yoda-yoda/gmail-api-wrapper/" }, "release_url": "https://pypi.org/project/gmail-api-wrapper/0.1.1a3/", "requires_dist": [ "google-api-python-client (==1.6.3)", "python-dateutil" ], "requires_python": "", "summary": "Gmail API Wrapper - Python Client", "version": "0.1.1a3" }, "last_serial": 4462368, "releases": { "0.0.1a10": [ { "comment_text": "", "digests": { "md5": "2c6d5e810bebec4bd3b95e92acf67db6", "sha256": "81939409c07ed3705c4597d763e6c02909f5caef7f2ed56c8013c17c70e759f1" }, "downloads": -1, "filename": "gmail_api_wrapper-0.0.1a10-py3-none-any.whl", "has_sig": true, "md5_digest": "2c6d5e810bebec4bd3b95e92acf67db6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8044, "upload_time": "2017-09-15T11:07:15", "url": "https://files.pythonhosted.org/packages/90/32/8ca04df77c41979181ac87a24a35e6546611705170ad6f7de0705e23f98a/gmail_api_wrapper-0.0.1a10-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "90227db081943f6de5980af10d5b716f", "sha256": "a80839a3ff7c92543460d33e2c912a24a536207d480e7a1158cc2544c62e7e48" }, "downloads": -1, "filename": "gmail-api-wrapper-0.0.1a10.tar.gz", "has_sig": true, "md5_digest": "90227db081943f6de5980af10d5b716f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5107, "upload_time": "2017-09-15T11:07:45", "url": "https://files.pythonhosted.org/packages/40/73/3dbaaea659b91ab995c69ba5a45b8102b770b8e1b236d71d9cace82905ac/gmail-api-wrapper-0.0.1a10.tar.gz" } ], "0.0.1a11": [ { "comment_text": "", "digests": { "md5": "d1977895a9f9c22a1ece9609d9f04bdf", "sha256": "4f01b36e2bbe112dffeadaeef954f12c2761a33dcfe6a5ef59b17ac4d74f341f" }, "downloads": -1, "filename": "gmail_api_wrapper-0.0.1a11-py3-none-any.whl", "has_sig": true, "md5_digest": "d1977895a9f9c22a1ece9609d9f04bdf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11812, "upload_time": "2017-09-18T07:42:42", "url": "https://files.pythonhosted.org/packages/64/eb/c5c93069d9cefdbb0c7bcb697dbb5f304ec3a7ed8f673258732c1a415946/gmail_api_wrapper-0.0.1a11-py3-none-any.whl" } ], "0.0.1a4": [ { "comment_text": "", "digests": { "md5": "fa842472bee57af02f5557abe7051257", "sha256": "c1422fa16605bab4395c6436bf9cd7ebe5b5d8a7f5c71767c10c620338a4899e" }, "downloads": -1, "filename": "gmail-api-wrapper-0.0.1a4.tar.gz", "has_sig": true, "md5_digest": "fa842472bee57af02f5557abe7051257", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5167, "upload_time": "2017-09-10T17:14:07", "url": "https://files.pythonhosted.org/packages/8a/cd/fed294a0e2c2f9f8418ee55a059f4e3d79fdedd0418c8761315325c5c266/gmail-api-wrapper-0.0.1a4.tar.gz" } ], "0.0.1a5": [ { "comment_text": "", "digests": { "md5": "3c319448c9c1c83e08aa67d206b3de7c", "sha256": "144cb6fe8c8ba60ac74ad9c6503f66502ee919f6dcffc60053bd4cc5f2725974" }, "downloads": -1, "filename": "gmail_api_wrapper-0.0.1a5-py3-none-any.whl", "has_sig": false, "md5_digest": "3c319448c9c1c83e08aa67d206b3de7c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8077, "upload_time": "2017-09-10T17:46:22", "url": "https://files.pythonhosted.org/packages/8c/da/3b412d11b3f78761b2cbb478eecccde6412f560a1183f961276d8bcb55a6/gmail_api_wrapper-0.0.1a5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7705855be739c5240d1a8f5c6f5501f5", "sha256": "93bae1355dc3d1dd9ed8a9c881c1ebd452085bd387735baeaea641fc2430faf1" }, "downloads": -1, "filename": "gmail-api-wrapper-0.0.1a5.tar.gz", "has_sig": true, "md5_digest": "7705855be739c5240d1a8f5c6f5501f5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5148, "upload_time": "2017-09-10T17:24:45", "url": "https://files.pythonhosted.org/packages/f5/77/b034cabe256ac1d5e05890091a2b96d7b71af85547373734aecc3df6ed08/gmail-api-wrapper-0.0.1a5.tar.gz" } ], "0.0.1a6": [ { "comment_text": "", "digests": { "md5": "df7ee7ba2421ae730ee98cbc308d568b", "sha256": "58b2e296e3b1eef7f71b2329a1aed60d9f06df5d25c25b267debac59020e8e83" }, "downloads": -1, "filename": "gmail_api_wrapper-0.0.1a6-py3-none-any.whl", "has_sig": true, "md5_digest": "df7ee7ba2421ae730ee98cbc308d568b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8032, "upload_time": "2017-09-11T11:37:14", "url": "https://files.pythonhosted.org/packages/d0/28/735e33d4d22c4d24d311f883a87176a9eedc6a28db650a0ea00ae232304f/gmail_api_wrapper-0.0.1a6-py3-none-any.whl" } ], "0.0.1a7": [ { "comment_text": "", "digests": { "md5": "cb1ebbe17777313cfceebeec8598d057", "sha256": "fa9ae5c17118f4551dbeafe1024abc0a5db6bd8f70d3eb1f971c5389cb8e99b1" }, "downloads": -1, "filename": "gmail_api_wrapper-0.0.1a7-py3-none-any.whl", "has_sig": true, "md5_digest": "cb1ebbe17777313cfceebeec8598d057", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8073, "upload_time": "2017-09-11T14:26:47", "url": "https://files.pythonhosted.org/packages/0a/5c/00dde8fb144ec24a506a65695d84b0f86d51a2693ae08e0bb647ad2f7e0b/gmail_api_wrapper-0.0.1a7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "02060f32609ec73b532525ff70ab254b", "sha256": "36000acb41568d3ca767f799e2c3af913891656497e91dbce347f0c85f8f3159" }, "downloads": -1, "filename": "gmail-api-wrapper-0.0.1a7.tar.gz", "has_sig": true, "md5_digest": "02060f32609ec73b532525ff70ab254b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5134, "upload_time": "2017-09-11T14:28:23", "url": "https://files.pythonhosted.org/packages/ad/1b/8d648aa95f36d1900956e90062760422d2938228f2e0e9f2e03cee798cc0/gmail-api-wrapper-0.0.1a7.tar.gz" } ], "0.0.1a8": [ { "comment_text": "", "digests": { "md5": "1fd5bbc0c7875ad45e83a2018cc6a1d6", "sha256": "4807e1644c7cf976386aeaf0c47dc74eb31917edd7f66923f05ad1d221d267d6" }, "downloads": -1, "filename": "gmail_api_wrapper-0.0.1a8-py3-none-any.whl", "has_sig": false, "md5_digest": "1fd5bbc0c7875ad45e83a2018cc6a1d6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8054, "upload_time": "2017-09-15T10:27:31", "url": "https://files.pythonhosted.org/packages/23/d1/a6c5756bdb30803cbe97f95cf7aa72fc84b6de05fafe0256c08fb332aa05/gmail_api_wrapper-0.0.1a8-py3-none-any.whl" } ], "0.1.1a1": [ { "comment_text": "", "digests": { "md5": "6a323c45c9cb9badcb9b5ae67816f90e", "sha256": "8f1b78f49fbc5e03361e0fd0219508b9dc952c379a055228ad502dd7f987eaa2" }, "downloads": -1, "filename": "gmail_api_wrapper-0.1.1a1-py3-none-any.whl", "has_sig": true, "md5_digest": "6a323c45c9cb9badcb9b5ae67816f90e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12502, "upload_time": "2017-09-19T06:26:20", "url": "https://files.pythonhosted.org/packages/bf/94/43ee5ba72ce342c221ff9cc60550ba027c9ebe78251ceb2e811ff64b3ae3/gmail_api_wrapper-0.1.1a1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ddef9ddf923de471a383b3aaf0b940b5", "sha256": "ce9407629b528b2e7b2c5189d142889db02a91f5a632befebedf62f8e716629c" }, "downloads": -1, "filename": "gmail-api-wrapper-0.1.1a1.tar.gz", "has_sig": true, "md5_digest": "ddef9ddf923de471a383b3aaf0b940b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10124, "upload_time": "2017-09-19T06:26:51", "url": "https://files.pythonhosted.org/packages/fa/e3/d48073604688d4af82facbc92ac6abae9abbc5cfb49c74fd2638fc06cc4c/gmail-api-wrapper-0.1.1a1.tar.gz" } ], "0.1.1a2": [ { "comment_text": "", "digests": { "md5": "d6f0e5c1ccd70b3e420f4d875078e2a0", "sha256": "148eb36d2b222914e54ebff57c5604661777fadd24a6011d4020cfff5a2bb107" }, "downloads": -1, "filename": "gmail_api_wrapper-0.1.1a2-py3-none-any.whl", "has_sig": true, "md5_digest": "d6f0e5c1ccd70b3e420f4d875078e2a0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12898, "upload_time": "2017-09-19T14:04:42", "url": "https://files.pythonhosted.org/packages/a9/aa/d0adf252beace98161a4e54882abe582eaca7480c0b6aa1d2961be0cf23b/gmail_api_wrapper-0.1.1a2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1f80964a52addf4d6fdc4d1b83c293db", "sha256": "d6ec4c60c96fe38c828ac3fa6e404221a37384224e36fec2d95208990a2b22c7" }, "downloads": -1, "filename": "gmail-api-wrapper-0.1.1a2.tar.gz", "has_sig": true, "md5_digest": "1f80964a52addf4d6fdc4d1b83c293db", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10530, "upload_time": "2017-09-19T14:04:06", "url": "https://files.pythonhosted.org/packages/72/01/88a030248dedad79d4af660c085804f9c2f20e1c0521189933dbffe1fb71/gmail-api-wrapper-0.1.1a2.tar.gz" } ], "0.1.1a3": [ { "comment_text": "", "digests": { "md5": "832d53a7c5986be572635ac48d7d19c8", "sha256": "a40379783cc771e72faceff0fb95394a96e6f304f03604689dd7de9fcf74c2a8" }, "downloads": -1, "filename": "gmail_api_wrapper-0.1.1a3-py3-none-any.whl", "has_sig": false, "md5_digest": "832d53a7c5986be572635ac48d7d19c8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15040, "upload_time": "2018-11-07T17:34:43", "url": "https://files.pythonhosted.org/packages/65/29/eb200eeed6403d96dd86f037021e77ccb282da565b906784dd4d787091b5/gmail_api_wrapper-0.1.1a3-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "832d53a7c5986be572635ac48d7d19c8", "sha256": "a40379783cc771e72faceff0fb95394a96e6f304f03604689dd7de9fcf74c2a8" }, "downloads": -1, "filename": "gmail_api_wrapper-0.1.1a3-py3-none-any.whl", "has_sig": false, "md5_digest": "832d53a7c5986be572635ac48d7d19c8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15040, "upload_time": "2018-11-07T17:34:43", "url": "https://files.pythonhosted.org/packages/65/29/eb200eeed6403d96dd86f037021e77ccb282da565b906784dd4d787091b5/gmail_api_wrapper-0.1.1a3-py3-none-any.whl" } ] }