| Name | salty-gmailer JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | A python package to manage and automate your personal Gmail account. |
| upload_time | 2023-08-16 03:32:27 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
gmail
email automation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Salty Gmailer
Salty Gmailer is a configuration based Gmail automation tool. Configuration is based off of YAML files that utilize
the Gmail search query (`q=...`) and the addition and subtraction of labels to manage emails.
See [here](https://support.google.com/mail/answer/7190?hl=en) for the library of search operators supported.
## Usage
```
usage: gmailer [-h] [paths ...]
Configuration based automation for gmail.
positional arguments:
paths path containing the rule.yaml files
options:
-h, --help show this help message and exit
```
Currently, the only arguments are locations of YAML configuration files.
For example, if you YAML configuration files were in a relative path to your current
location named `rules`, you would execute the program as
`gmailer ./rules`
## Configuration
See the following example of a YAML rule:
```
name: Trash
description: Sends messages to trash
search:
- older_than: 1m
- from: "github_ OR"
- from: notifications-noreply@linkedin.com
add_labels:
- TRASH
remove_labels:
```
Currently, name and description are for logging purposes only.
`search` takes a list of key/value pairs to filter email messages to act on. These are taken directly from the Gmail search
query operators.
`add_labels` is a list of labels to add that match the search criteria, while its inverse `remove_labels` will remove labels that match any search criteria.
This rule will find all emails older than 1 month that are from 'github_' or 'notifications-noreply@linkedin.com
' and adds the label 'TRASH' to any emails that match, trashing the emails.
## TODO - Add Tox
Raw data
{
"_id": null,
"home_page": "",
"name": "salty-gmailer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "gmail,email automation",
"author": "",
"author_email": "Ryan Long <ryanlong1004@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/41/24/b069985bfd9361fee765ea8a95230a60dabd219fb9cfb079d3e835d53724/salty_gmailer-0.0.2.tar.gz",
"platform": null,
"description": "# Salty Gmailer\r\n\r\n\r\nSalty Gmailer is a configuration based Gmail automation tool. Configuration is based off of YAML files that utilize\r\nthe Gmail search query (`q=...`) and the addition and subtraction of labels to manage emails.\r\n\r\nSee [here](https://support.google.com/mail/answer/7190?hl=en) for the library of search operators supported.\r\n\r\n## Usage\r\n```\r\nusage: gmailer [-h] [paths ...]\r\n\r\nConfiguration based automation for gmail.\r\n\r\npositional arguments:\r\npaths path containing the rule.yaml files\r\n\r\noptions:\r\n-h, --help show this help message and exit\r\n```\r\n\r\nCurrently, the only arguments are locations of YAML configuration files.\r\n\r\nFor example, if you YAML configuration files were in a relative path to your current\r\nlocation named `rules`, you would execute the program as\r\n`gmailer ./rules`\r\n\r\n## Configuration\r\nSee the following example of a YAML rule:\r\n\r\n```\r\nname: Trash\r\ndescription: Sends messages to trash\r\nsearch:\r\n- older_than: 1m\r\n- from: \"github_ OR\"\r\n- from: notifications-noreply@linkedin.com\r\n add_labels:\r\n- TRASH\r\n remove_labels:\r\n```\r\n\r\nCurrently, name and description are for logging purposes only. \r\n\r\n`search` takes a list of key/value pairs to filter email messages to act on. These are taken directly from the Gmail search\r\nquery operators.\r\n\r\n`add_labels` is a list of labels to add that match the search criteria, while its inverse `remove_labels` will remove labels that match any search criteria.\r\nThis rule will find all emails older than 1 month that are from 'github_' or 'notifications-noreply@linkedin.com\r\n' and adds the label 'TRASH' to any emails that match, trashing the emails. \r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n## TODO - Add Tox\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A python package to manage and automate your personal Gmail account.",
"version": "0.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/ryanlong1004/gmailer/issues",
"Homepage": "https://github.com/ryanlong1004/gmailer"
},
"split_keywords": [
"gmail",
"email automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c74d429d6151e06e30618cda48c4a3c4238ff04adf57eb5cf4e30bb9e4b19e7",
"md5": "79ec56d5821cfd3ba636bc1397b3fbd3",
"sha256": "f3e4924935d7971a20d9a3c6d41a7906877d4087680e1d32c0f4d0a84c861899"
},
"downloads": -1,
"filename": "salty_gmailer-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79ec56d5821cfd3ba636bc1397b3fbd3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7324707,
"upload_time": "2023-08-16T03:32:23",
"upload_time_iso_8601": "2023-08-16T03:32:23.768728Z",
"url": "https://files.pythonhosted.org/packages/2c/74/d429d6151e06e30618cda48c4a3c4238ff04adf57eb5cf4e30bb9e4b19e7/salty_gmailer-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4124b069985bfd9361fee765ea8a95230a60dabd219fb9cfb079d3e835d53724",
"md5": "81d5dd30d221ab47b21b9539f84a4574",
"sha256": "b21cdba04f31d3095d8ceba9ef4edf7c73e98f9733465719a707b3cb13437fd2"
},
"downloads": -1,
"filename": "salty_gmailer-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "81d5dd30d221ab47b21b9539f84a4574",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5996203,
"upload_time": "2023-08-16T03:32:27",
"upload_time_iso_8601": "2023-08-16T03:32:27.824128Z",
"url": "https://files.pythonhosted.org/packages/41/24/b069985bfd9361fee765ea8a95230a60dabd219fb9cfb079d3e835d53724/salty_gmailer-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-16 03:32:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ryanlong1004",
"github_project": "gmailer",
"github_not_found": true,
"lcname": "salty-gmailer"
}
