Modmail bot

Modmail bot 3.2.2

No permission to download
What is Modmail?
Modmail is similar to Reddit's Modmail both in functionality and purpose. It serves as a shared inbox for server staff to communicate with their users in a seamless way.

This bot is free for everyone and always will be. If you like this project and would like to show your appreciation, you can support us on Patreon, cool benefits included!

How does it work?
When a member sends a direct message to the bot, Modmail will create a channel or "thread" within an isolated category. All further DM messages will automatically relay to that channel, for any available staff can respond within the channel.

All threads are logged and you can view previous threads through their corresponding log link. Here is an example.

Features
Highly Customisable
:

Bot activity, prefix, category, log channel, etc.
Command permission system.
Interface elements (color, responses, reactions, etc).
Snippets and command aliases.
Minimum duration for accounts to be created before allowed to contact Modmail (account_age).
Minimum duration for members to be in the guild before allowed to contact Modmail (guild_age).
Advanced Logging Functionality:

When you close a thread, Modmail will generate a log link and post it to your log channel.
Native Discord dark-mode feel.
Markdown/formatting support.
Login via Discord to protect your logs (premium Patreon feature).
See past logs of a user with ?logs.
Searchable by text queries using ?logs search.
Robust implementation:

Schedule tasks in human time, e.g. ?close in 2 hours silently.
Editing and deleting messages are synced.
Support for the diverse range of message contents (multiple images, files).
Paginated commands interfaces via reactions.
This list is ever-growing thanks to active development and our exceptional contributors. See a full list of documented commands by using the ?help command.

Installation
Where can I find the Modmail bot invite link?

Unfortunately, due to how this bot functions, it cannot be invited. This is to ensure the individuality to your server and grant you full control over your bot and data. Nonetheless, you can easily obtain a free copy of Modmail for your server by following one of the methods listed below (roughly takes 15 minutes of your time)...

Heroku
This bot can be hosted on Heroku.

Installation via Heroku is possible with your web browser alone. The installation guide (which includes a video tutorial!) will guide you through the entire installation process. If you run into any problems, join our Modmail Discord Server for help and support.

Locally
Local hosting of Modmail is also possible, first you will need Python 3.7.

Follow the installation guide and disregard deploying the Heroku bot application. If you run into any problems, join our Modmail Discord Server

Clone the repo:

$ git clone https://github.com/kyb3r/modmail
$ cd modmail
Install dependencies:

$ pipenv install
Rename the .env.example to .env and fill out the fields. If .env.example is nonexistent (hidden), create a text file named .env and copy the contents of .env.example then modify the values.

Finally, start Modmail.

$ pipenv run bot
Docker
This repo supplies a Dockerfile for simplified deployment.

You can build your own Docker image:

$ docker build . --tag=modmail
or run directly from a pre-built version from https://hub.docker.com/. Currently there are two community release of Modmail:

Kyber's:
$ docker pull kyb3rr/modmail
Taku's:
$ docker pull taaku18/modmail
# You can also choose one of the following:
$ docker pull taaku18/modmail:dev
$ docker pull taaku18/modmail:<version> (<version> ex: 3.2.0, 3.2, etc.)
And to run your docker image:

$ docker run --env-file .env user/modmail
Replace user/modmail with kyb3rr/modmail, taaku18/modmail, taaku18/modmail:3.2, etc as above.
.env should be the path to your env file, you can also supply a path: /path/to/.env.
Author
Fennec
Downloads
1
Views
117
First release
Last update
Rating
0.00 star(s) 0 ratings

Top