Taku 3 Animals edited this page Feb 11, 2019 · 33 revisions

Notable Features

Snippets and Aliases

Snippets are shortcuts for predefined messages that you can send. Add or remove snippets with the ?snippets command. Custom command aliases are also supported with the ?alias command.

Customizability

Modmail has a range of configuration variables that you can dynamically alter with the ?config command. You can use them to change the different aspects of the bot, for example, the embed color, responses, reactions, status, etc. The level of customization is ever growing thanks to our exceptional contributors. To view the full list of colors you can use for your embeds please visit this link

Linked Messages

Have you sent something with the ?reply command by accident? Don't fret, you can delete your original message, and the bot will automatically delete the corresponding message sent to the recipient of the thread! You can also use the ?edit command to edit a message you sent.

Thread Logs

Thread conversations are automatically logged with a generated viewable website of the complete thread. Logs are rendered with styled HTML and presented in an aesthetically pleasing way—it blends seamlessly with the mobile version of Discord.


Commands

In Discord, type ?help command-name for help on a specific command.

Modmail Commands

Command Name Description
setup Sets up the server for Modmail.
reply Replies to users using this command.
anonreply Replies to users anonymously.
edit Edits a message that was sent using the reply command.
contact Creates a thread with a specified member.
close Closes the current thread.
close silently Closes the current thread silently without mention.
move Moves the thread channel to a specified category.
logs Shows a list of previous Modmail thread logs of a member.
block Blocks a user from using Modmail.
unblock Unblocks a user from using Modmail.
blocked Returns a list of blocked users.
nsfw Flags a Modmail thread as nsfw.
snippets Returns a list of snippets that are currently set.
snippets del Removes a snippet from the bot config.
snippets add Adds a snippet to the bot config.

Utility Commands

Command Name Description
help Shows the help message.
update Checks for new versions and updates the bot.
github Shows the GitHub user your bot is linked to.
alias Returns a list of aliases that are currently set.
alias del Removes an alias from the bot configuration.
alias add Adds an alias to the bot configuration.
about Shows information about the bot.
activity Sets a custom activity status for the bot.
ping Pong! Returns your websocket latency.
eval Execute Python code (Bot owner only)
config Manually change configuration for the bot.
config del Deletes a key from the config.
config get Shows the configuration variables that are currently set.
config set Sets a configuration variable.
changelog Returns a list of recent changes made to the bot.
notify [role] Pings once when a new reply in the thread has been received.
sub [role] Pings for every new message until you unsubscribe.
unsub [role] Removes you from the notification list of the thread.
note Leave a note in the thread for the log history.

Configuation Variables (Config Vars)

These are currently all the valid configuration variables you can change with the config set command.

Name Description
prefix The prefix of the bot (defaults to ?).
mention The message at the start of each thread.
activity_type The activity type, accepted values: 0-3. 0: playing, 1: streaming, 2: listening, 3: watching
activity_message The activity message. (ie. playing tic-tac-toe)
twitch_url The twitch URL when activity_type is set to 1 (streaming).
disable_autoupdates Set to "true" or "yes" will disables automated updates.
log_channel_id Set the channel where bot logs will be sent.
main_category_id Set the category where new threads spawn.
sent_emoji Changes the sent emoji (defaults to ✅).
blocked_emoji Changes the blocked emoji (defaults to 🚫).
mod_tag The footer text in the mod reply embed (defaults to your highest role name).
mod_color The color of the mod reply embed in hexadecimal format or accepted color name (defaults to green - 2ecc71).
recipient_color The color of the recipient's message embed in hexadecimal format or accepted color name (defaults to gold - f1c40f).
main_color The general color of Modmail in hexadecimal format or accepted color name (defaults to blurple - 7289da).
anon_username The name of the anonymous user for use with the anonreply command (defaults to be the same as mod_tag configuration).
anon_avatar_url The icon URL in the anonymous reply embed (defaults to the guild's icon URL).

Accepted color names can be found here: https://github.com/kyb3r/modmail/wiki/Color-Names.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.