Skip to content

Latest commit

 

History

History
40 lines (38 loc) · 1.98 KB

INSTALL.md

File metadata and controls

40 lines (38 loc) · 1.98 KB
Raw

Directions for install GAE Bulk Mailer

Assumes you have the Google App Engine Python SDK installed.

  1. Create an app on Google App Engine (https://appengine.google.com/start/createapp?)
  2. Clone GAE Bulk Mailer git@github.com:pizzapanther/GAE-Bulk-Mailer.git your-app-id
  3. Create your configuration files
    cd your-app-id
    cp app.yaml.example app.yaml
    cp queue.yaml.example queue.yaml
    cp cron.yaml.example cron.yaml
    touch local_settings.py
  4. Insert your app ID into app.yaml.
  5. Tweak queue.yaml depending on your send rate limits.
  6. Tweak your local_settings.py. Some settings you may wish to add:
    SUPER_ADMINS = ('your_address@gmail.com',)
    STAFF_USERS = ('staff_user@gmail.com',)
    STAFF_DOMAINS = ('gmail-app-domain.com',)
    ALLOWED_HOSTS = ('your-app-id.appspot.com', '1.your-app-id.appspot.com')
    DEFAULT_FROM_EMAIL = 'from_address@example.com'
    BASE_URL = 'https://your-app-id.appspot.com'
    REPORT_BOUNCE_URL = 'https://example.com/bounce_reporting_url'
    REPORT_UNSUBSCRIBE_URL = 'https://example.com/unsubscribe_reporting_url'
    REPORT_PAYLOAD = {'key': 'abcdefgh123456'}
    EMAILER = 'bulkmail.mailers.amazon' #Or 'bulkmail.mailers.gae'
    MAIL_SEND_RATE = 85
    MAIL_SEND_INTERVAL = 'seconds'
    AWS_KEY_ID = 'abcdefgh123456' #Needed for AWS Mailer only
    AWS_SECRET_KEY = 'abcdefgh123456'
  7. Upload your app: cd ..; appcfg.py update your-app-id
  8. Go to https://your-app-id.appspot.com/api/apikey/ to create an API Key.
  9. Implement the bounce and unsubscribe hooks you provided. See the Web Hooks Documentation for more info.

More Info