2019-12-02 18:51:11 -05:00
|
|
|
# 🤖 Commands
|
|
|
|
|
2020-05-25 16:55:50 -04:00
|
|
|
## Table of contents
|
2020-05-25 16:56:48 -04:00
|
|
|
* [Inside a Modmail thread](#inside-a-modmail-thread)
|
2020-05-25 16:55:50 -04:00
|
|
|
* [Anywhere on the inbox server](#anywhere-on-the-inbox-server)
|
|
|
|
* [Snippets (canned messages)](#snippets-canned-messages)
|
|
|
|
|
2020-05-25 16:56:48 -04:00
|
|
|
## Inside a Modmail thread
|
|
|
|
These commands can only be used inside a Modmail thread's channel on the inbox server.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
### `!reply <text>` / `!r <text>`
|
|
|
|
Send a reply to the user.
|
|
|
|
|
|
|
|
**Example:** `!r How can I help you?`
|
|
|
|
|
|
|
|
To reply automatically without using `!reply`, [enable `alwaysReply` in bot settings](configuration.md).
|
|
|
|
|
|
|
|
### `!anonreply <text>` / `!ar <text>`
|
|
|
|
Send an anonymous reply to the user. Anonymous replies only show the moderator's role in the reply.
|
|
|
|
|
2020-05-25 16:56:48 -04:00
|
|
|
**Example:** `!ar Please only use Modmail for serious messages`
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
### `!close`
|
2020-05-25 16:56:48 -04:00
|
|
|
Close the Modmail thread.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
### `!close <time>`
|
2020-05-25 16:56:48 -04:00
|
|
|
Close the Modmail thread after a timer. Sending a message to the user or receiving a message from the user will cancel scheduled closing.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
**Example:** `!close 15m`
|
|
|
|
|
|
|
|
### `!close cancel`
|
|
|
|
Cancel a timed close.
|
|
|
|
|
|
|
|
### `!logs`
|
2020-05-25 16:56:48 -04:00
|
|
|
List previous Modmail logs with the user.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
### `!block`
|
2020-05-25 16:56:48 -04:00
|
|
|
Block the user from using Modmail.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
### `!block <time>`
|
2020-05-25 16:56:48 -04:00
|
|
|
Block the user from using Modmail for a specified time.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
**Example:** `!block 7d`
|
|
|
|
|
|
|
|
### `!unblock`
|
2020-05-25 16:56:48 -04:00
|
|
|
Unblock the user, allowing them to use Modmail again.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
### `!move <category>`
|
2020-05-25 16:56:48 -04:00
|
|
|
Move the Modmail thread to a different category.
|
2020-05-25 16:55:50 -04:00
|
|
|
Requires `allowMove` to be enabled in the bot's settings.
|
|
|
|
|
|
|
|
### `!suspend`
|
|
|
|
Suspend the thread.
|
|
|
|
The thread will act as closed and will not receive any messages until unsuspended via `!unsuspend`.
|
|
|
|
|
|
|
|
### `!unsuspend`
|
|
|
|
Unsuspend the thread. See `!suspend` above.
|
|
|
|
|
|
|
|
### `!alert`
|
|
|
|
Pings you when the thread gets a new reply.
|
|
|
|
|
|
|
|
### `!alert cancel`
|
|
|
|
Cancel the ping set by `!alert`.
|
|
|
|
|
2020-08-16 17:39:50 -04:00
|
|
|
### `!edit <number> <new text>`
|
|
|
|
Edit your own previous reply sent with `!reply`.
|
2020-08-16 18:43:36 -04:00
|
|
|
`<number>` is the message number shown in front of staff replies in the thread channel.
|
2020-08-16 17:39:50 -04:00
|
|
|
|
|
|
|
### `!delete <number>`
|
|
|
|
Delete your own previous reply sent with `!reply`.
|
2020-08-16 18:43:36 -04:00
|
|
|
`<number>` is the message number shown in front of staff replies in the thread channel.
|
2020-08-16 17:39:50 -04:00
|
|
|
|
2020-05-25 16:55:50 -04:00
|
|
|
### `!loglink`
|
2020-05-25 16:56:48 -04:00
|
|
|
Get a link to the open Modmail thread's log.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
### `!loglink -s`
|
2020-05-25 16:56:48 -04:00
|
|
|
Get a link to the open Modmail thread's log, only showing messages to/from the user (ignores mod chatter within the thread).
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
### `!loglink -v`
|
2020-05-25 16:56:48 -04:00
|
|
|
Get a link to the open Modmail thread's log, showing extra details about channel and message IDs between the bot and the user.
|
2020-05-25 16:55:50 -04:00
|
|
|
This is mainly useful when reporting messages to Discord's Trust & Safety team.
|
|
|
|
|
|
|
|
### `!id`
|
|
|
|
Prints the user's ID.
|
|
|
|
|
2020-08-16 17:39:39 -04:00
|
|
|
### `!dm_channel_id`
|
|
|
|
Prints the ID of the current DM channel with the user
|
|
|
|
|
|
|
|
### `!message <number>`
|
|
|
|
Shows the DM channel ID, DM message ID, and message link of the specified user reply.
|
2020-08-16 18:43:36 -04:00
|
|
|
`<number>` is the message number shown in front of staff replies in the thread channel.
|
2020-08-16 17:39:39 -04:00
|
|
|
|
2019-12-02 18:51:11 -05:00
|
|
|
## Anywhere on the inbox server
|
2020-05-25 16:56:48 -04:00
|
|
|
These commands can be used anywhere on the inbox server, even outside Modmail threads.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
### `!newthread <userID>`
|
2020-05-25 16:56:48 -04:00
|
|
|
Open a Modmail thread with a user.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
**Example:** `!newthread 106391128718245888`
|
|
|
|
|
|
|
|
### `!logs <userID>`
|
2020-05-25 16:56:48 -04:00
|
|
|
List previous Modmail logs with the specified user.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
**Example:** `!logs 106391128718245888`
|
|
|
|
|
|
|
|
### `!block <userID>`
|
2020-05-25 16:56:48 -04:00
|
|
|
Block the specified user from Modmail.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
**Example:** `!block 106391128718245888`
|
|
|
|
|
|
|
|
### `!block <userID> <time>`
|
2020-05-25 16:56:48 -04:00
|
|
|
Block the specified user from Modmail for a specified time.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
**Example:** `!block 106391128718245888 7d`
|
|
|
|
|
|
|
|
### `!unblock <userID>`
|
2020-05-25 16:56:48 -04:00
|
|
|
Unblock the specified user, allowing them to use Modmail again.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
**Example:** `!unblock 106391128718245888`
|
|
|
|
|
|
|
|
### `!is_blocked <userID>`
|
|
|
|
Check if the specified user is blocked.
|
|
|
|
|
|
|
|
**Example:** `!is_blocked 106391128718245888`
|
|
|
|
|
|
|
|
### `!version`
|
2020-05-25 16:56:48 -04:00
|
|
|
Show the Modmail bot's version.
|
2020-05-25 16:55:50 -04:00
|
|
|
|
|
|
|
## Snippets (canned messages)
|
|
|
|
See the [📋 Snippets](snippets.md) page for more information!
|