`_ for
additional information on authentication.
- Slack has rate limits on all its endpoints.
.. toctree::
:maxdepth: 1
**********
QuickStart
**********
To call the Slack class you can either store the api key as an environment
variable `SLACK_API_TOKEN` or pass it in as an argument.
.. code-block:: python
from parsons import Slack
slack = Slack() # Initiate class via environment variable api token
slack = Slack(api_key='my-api-tkn') # Pass api token directly
You can then send messages:
.. code-block:: python
from parsons import Slack
slack = Slack()
# send a simple messsage
slack.message_channel("my_channel", "Hello from python script")
# share a file
slack.upload_file(["channel_1", "channel_2"], "my_slack_file.txt")
***
API
***
.. autoclass:: parsons.Slack
:inherited-members:
==========
Gmail
==========
********
Overview
********
The Gmail module leverages the Gmail API and provides an way to easily send
notifications through email. It is recommended that you reference the
`Gmail API documentation `_ for
additional details and information.
.. note::
Credentials and token
- Credentials are required to use the class
- You will need to pass in the path to the credentials and to where a
generated token will be saved. Typically you’ll get the credentials from
the Google Developer Console (look for the “Gmail API”).
.. note::
6MB Attachment Size Limit
- Currently there is a limit of 6MB when sending attachments.
.. toctree::
:maxdepth: 1
**********
QuickStart
**********
To call the Gmail class you will need to pass in the path to a
`credentials.json` and the path to `tokens.json`.
.. code-block:: python
from parsons import Gmail
gmail = Gmail(
creds_path="~/secret_location/credentials.json",
token_path="~/secret_location/token.json")
The easiest way to send a message:
.. code-block:: python
gmail.send_email(
"sender@email.com",
"recipient@email.com",
"The Subject",
"This is the text body of the email")
The current version also supports sending html emails and emails with
attachments.
.. code-block:: python
gmail.send_email(
"sender@email.com",
"recipient@email.com",
"An html email with attachments",
"This is the text body of the email",
html="This is the html part of the email
",
files=['file1.txt', 'file2.txt'])
Additionally, you can create a raw email messages and send it. See below for
more details.
***
API
***
.. autoclass:: parsons.Gmail
:inherited-members: