Skip to content

Commit

Permalink
add gmail_api example to README.md (#518)
Browse files Browse the repository at this point in the history
  • Loading branch information
yjszk authored May 22, 2024
1 parent 6e96b88 commit 20f4511
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/source/example.ini
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,11 @@ index = email

[s3]
bucket = my-bucket
path = parsedmarc
path = parsedmarc

[gmail_api]
credentials_file = /etc/example/credentials.json
token_file = /etc/example/token.json
include_spam_trash = True
paginate_messages = True
scopes = https://www.googleapis.com/auth/gmail.modify
4 changes: 4 additions & 0 deletions docs/source/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,10 @@ The full set of configuration options are:
credentials, None to disable (Default: `None`)
- `token_file` - str: Path to save the token file
(Default: `.token`)
:::{note}
credentials_file and token_file can be got with [quickstart](https://developers.google.com/gmail/api/quickstart/python).Please change the scope to `https://www.googleapis.com/auth/gmail.modify`.
:::
- `include_spam_trash` - bool: Include messages in Spam and
Trash when searching reports (Default: `False`)
- `scopes` - str: Comma separated list of scopes to use when
Expand Down

0 comments on commit 20f4511

Please sign in to comment.