Skip to main content

An app for relaying Eve mails to Discord.

Project description

Mailrelay

An app for relaying Eve mails to Discord.

release python django pipeline codecov license pre-commit Code style: black chat

Contents

Overview

This app can automatically forwards eve mails to Discord channels. This can e.g. be useful to include people in all hands communications, who do not check their eve mails that often, but still can be reached via Discord.

You can choose to just forward corporation or alliance mails only or all mails that a character receives.

This app is an add-on to Member Audit and requires you to have Member Audit installed and running. You can choose to forward mails from any character that is registered on Member Audit.

Installation

Step 1 - Check preconditions

Please make sure you have the following applications installed and running before attempting to install the Mail Relay app:

Step 2 - Install app

Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:

pip install aa-mailrelay

Step 3 - Configure settings

Configure your Auth settings (local.py) as follows:

  • Add 'mailrelay' to INSTALLED_APPS
  • Add below lines to your settings file:
CELERYBEAT_SCHEDULE['mailrelay_forward_new_mails'] = {
    'task': 'mailrelay.tasks.forward_new_mails',
    'schedule': crontab(minute='*/5'),
}
  • Optional: Add additional settings if you want to change any defaults. See Settings for the full list.

Step 4 - Finalize installation

Run migrations & copy static files

python manage.py migrate
python manage.py collectstatic

Restart your supervisor services for Auth

...

Step 5 - Setup mail relays

To setup your first mail relay go to the admin site / Mail Relay / RelayConfig.

Update the known Discord channels by clicking the button: "UPDATE DISCORD CHANNELS".

Click on "ADD RELAY CONFIG" to create your first mail relay configuration.

Settings

Here is a list of available settings for this app. They can be configured by adding them to your AA settings file (local.py).

Note that all settings are optional and the app will use the documented default settings if they are not used.

Name Description Default
DISCORDPROXY_HOST Port used to communicate with Discord Proxy. localhost
DISCORDPROXY_PORT Host used to communicate with Discord Proxy. 50051
MAILRELAY_DISCORDPROXY_TIMEOUT Timeout for sending request to DISCORDPROXY in seconds. 30
MAILRELAY_OLDEST_MAIL_HOURS Oldest mail to be forwarded in hours. Set to 0 to disable. 2
MAILRELAY_RELAY_GRACE_MINUTES Max time in minutes since last successful relay before service is reported as down. 30

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aa_mailrelay-1.4.0.tar.gz (20.4 kB view details)

Uploaded Source

Built Distribution

aa_mailrelay-1.4.0-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file aa_mailrelay-1.4.0.tar.gz.

File metadata

  • Download URL: aa_mailrelay-1.4.0.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.14

File hashes

Hashes for aa_mailrelay-1.4.0.tar.gz
Algorithm Hash digest
SHA256 f1e9267d766866ea9bac80ad8d83d417cd87cbce93ada5fa071ebca9d1f6d8c2
MD5 dd97cf367bc04a0850093b219d565f51
BLAKE2b-256 f8c9da539b52ae606fa4d0cbb106278eed76895ef3e7417521a1be755fefc839

See more details on using hashes here.

File details

Details for the file aa_mailrelay-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: aa_mailrelay-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 28.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.14

File hashes

Hashes for aa_mailrelay-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee886225e125609a5c50d94e3e8a9a566258754444df0c5c5967175119b97b45
MD5 7f9cf1a1d69b53954a791c3e4824e4cd
BLAKE2b-256 3cc104428cadfca83ceb82a864554a0fe9d496b14566be403ac4d31a59fe3aff

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page