Modmail bot 3.4.0

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 [cur]command aliases[/cur].
  • Minimum duration for accounts to be created before allowed to contact Modmail
    Code:

    account_age

  • Minimum duration for members to be in the guild before allowed to contact Modmail
    Code:

    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
    Code:

    ?logs

  • Searchable by text queries using
    Code:

    ?logs search

• Robust implementation:
  • Schedule tasks in human time, e.g.
    Code:

    ?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
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.

To configure automatic updates:
- Login to GitHub and verify your account.
- Fork the repo.
- Install the Pull app for your fork.
- Then go to the Deploy tab in your Heroku account of your bot app, select GitHub and connect your fork (usually by typing "Modmail").
- Turn on auto-deploy for the branch.

Hosting for Patreons

If you don't want to go through the trouble of setting up your very own Modmail bot, and/or want to support this project, we offer the all inclusive installation, hosting and maintenance of your Modmail with Patreon. Join our Modmail Discord Server for more info!

Locally

Local hosting of Modmail is also possible, first you will need

Code:

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 for help and support.

Clone the repo:
Install dependencies:
Rename the to and fill out the fields. If is nonexistent (hidden), create a text file named and copy the contents of

Code:

.env.example

then modify the values.

Finally, start Modmail.

Docker

This repo supplies a Dockerfile for simplified deployment.

You can build your own Docker image:
or run directly from a pre-built version from https://hub.docker.com/. Currently there are two community release of Modmail:

• Kyber's:
  
  Code:

  $ docker pull kyb3rr/modmail

• Taku's:
  
  Code:

  $ 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:
  
  Code:

  $ docker run --env-file .env user/modmail

  - Replace
  Code:

  user/modmail

  with
  Code:

  kyb3rr/modmail

  ,
  Code:

  taaku18/modmail

  ,
  Code:

  taaku18/modmail:3.2

  , etc as above.
• Code:

  .env

  should be the path to your env file, you can also supply a path:
  Code:

  /path/to/.env

Plugins

Modmail supports the use of third-party plugins to extend or add functionalities to the bot.
This allows niche features as well as anything else outside of the scope of the core functionality of Modmail.

A list of third-party plugins can be found using the command or visit the Unofficial List of Plugins for a list of plugins contributed by the community.

To develop your own, check out the plugins documentation.

Plugins requests and support is available in our Modmail Plugins Server.

Contributing

Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our contribution guidelines before you get started.

If you like this project and would like to show your appreciation, support us on Patreon!