Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

Email2SlackBot

Checks IMAP server for new mail and posts it in a Slack channel

How to use:

  1. Create a new Incoming Webhook custom integration for your Slack channel (https://slack.com/apps/A0F7XDUAZ-incoming-webhooks)
  2. $ git clone https://github.com/isiah-lloyd/Email2SlackBot.git
  3. $ virtualenv venv
  4. $ source venv/bin/activate
  5. $ pip install -r requirements.txt
  6. Enter your Webhook URL from Slack into the settings.example.ini file along with your email server configuration
  7. Rename settings.example.ini to settings.ini
  8. $ python main.py
  9. The program is now setup and will check for new mail and post it to slack on subsequent runs
  10. Run python main.py using a cron job

Do not modify last_uid.txt created by the program but if you are encountering issues it maybe a good idea to regenerate the file by deleting it.

Storage Options

By default, the bot stores the last uid in last_uid.txt on your local machine. However, by setting storage_location = s3 and setting aws_access_key_id, aws_secret_access_key, and aws_s3_bucket_name in your settings.ini you can use Amazon S3 for storage.

Ensure your aws_s3_bucket_name exists on S3.

Serverless Function

Deploying to AWS Lambda or other serverless service is an option. Deploying to AWS Lambda is painless with Serverless.

Node.js is required for Serverless deployment. Install Serverless with npm install -g serverless. Then install the devDependencies with npm install. Finally, deploy with serverless deploy.

After deployment, ensure all necessary environment variables are included with your function. You can do this on the AWS console or with the AWS cli.

All serverless configuration is handled in serverless.yml. By default, serverless.yml configures the bot to run every 10 minutes.

Quick serverless commands:

  • Deploy: serverless deploy
  • Manually invoke a function: serverless invoke -f run -s [STAGE] -r [REGION] -l
  • View the logs for a function: serverless logs -f run

Note: use --aws-profile [PROFILE] with these commands if you have more than one set of AWS credentials in your ~/.aws/credentials file

About

Checks IMAP server for new mail and posts it in a Slack channel

Topics

Resources

Releases

No releases published

Packages

No packages published

Languages