|
| 1 | +## Rustmail Commands |
| 2 | + |
| 3 | +This document provides a comprehensive list of commands available in Rustmail. All commands can be used as slash |
| 4 | +commands or textual commands (with a configurable prefix for textual commands, default is `!`). |
| 5 | + |
| 6 | +### Table of Contents |
| 7 | + |
| 8 | +- [Slash Commands](#slash-commands) |
| 9 | +- [Textual Commands](#textual-commands) |
| 10 | + |
| 11 | +### Slash Commands |
| 12 | + |
| 13 | +| Command | Description | Usage | |
| 14 | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| |
| 15 | +| `/help` | Displays a list of available commands. | `/help` | |
| 16 | +| `/new_thread` | Creates a new support ticket. | `/new_thread <user_id>` | |
| 17 | +| `/close` | Closes the current ticket. You can schedule the closing with the `time_to_close` option. You can close the ticket silently with the `silent` option. And you can cancel a scheduled closure with `cancel` option. | `/close <time_to_close> <silent> <cancel>` | |
| 18 | +| `/force_close` | Closes an orphaned ticket (which the user are no longer on the discord server). | `/force_close` | |
| 19 | +| `/reply` | Reply in a ticket channel. You can add an attachments to your message with `attachment` option. You can send your message as anonymous with the `anonymous` option. | `/reply <content> <attachment> <anonymous>` | |
| 20 | +| `/add_reminder` | Add a reminder that will ping you when the time is reached. You can set a custom content with the `content` option. | `/add_reminder <time> <content>` | |
| 21 | +| `/remove_reminder` | Remove a scheduled reminder by giving the id of the reminder. | `/remove_reminder <reminder_id>` | |
| 22 | +| `/add_staff` | Add a staff to a ticket to which he does not have access. | `/add_staff <user_id>` | |
| 23 | +| `/remove_staff` | Remove a staff from a ticket. | `/remove_staff <user_id>` | |
| 24 | +| `/alert` | Set an alert on the current ticket to be pinged when it receives a new response. You can cancel an alert by using the `cancel` option. | `/alert <cancel>` | |
| 25 | +| `/delete` | You can delete a response that you have made in a ticket with the rustmail message ID of your message (see footer of the message) | `/delete <message_id>` | |
| 26 | +| `/edit` | You can edit a response that you have made in a ticket with the rustmail message ID of your message (see footer of the message) and the new content. | `/edit <message_id> <new_content>` | |
| 27 | +| `/id` | Show the ID of the user in the current ticket. | `/id` | |
| 28 | +| `/move_thread` | Move a ticket in a different category. | `/move_thread <category_name>` | |
| 29 | +| `/recover` | Recover messages received during bot downtime. This process is automatic. | `/set_topic <topic>` | |
| 30 | + |
| 31 | +### Textual Commands |
| 32 | + |
| 33 | +Here, the prefix for textual commands is assumed to be `!`. You can change it in the configuration file. |
| 34 | + |
| 35 | +| Command | Description | Usage | |
| 36 | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| |
| 37 | +| `!help` | Displays a list of available commands. | `!help` | |
| 38 | +| `!new_thread` | Creates a new support ticket. | `!new_thread <user_id>` | |
| 39 | +| `!close` | Closes the current ticket. You can schedule the closing by adding duration (ex: 1s, 1m, 1h, 1d). You can close the ticket silently with the `--silent (or -s)` flag. And you can cancel a scheduled closure with `--cancel (or -c or cancel)` flag. | `!close <time_to_close> <cancel>` | |
| 40 | +| `!force_close` | Closes an orphaned ticket (which the user are no longer on the discord server). | `!force_close` | |
| 41 | +| `!reply` | Reply in a ticket channel. You can add an attachments to your message by adding files with the Discord Client. | `!reply <content>` | |
| 42 | +| `!anonreply` | Same behaviour as reply command but anonymously. | `!anonreply <content>` | |
| 43 | +| `!add_reminder` | Add a reminder that will ping you when the time is reached. | `!add_reminder <time> <content>` | |
| 44 | +| `!remove_reminder` | Remove a scheduled reminder by giving the id of the reminder. | `!remove_reminder <reminder_id>` | |
| 45 | +| `!add_staff` | Add a staff to a ticket to which he does not have access. | `!add_staff <user_id>` | |
| 46 | +| `!remove_staff` | Remove a staff from a ticket. | `!remove_staff <user_id>` | |
| 47 | +| `!alert` | Set an alert on the current ticket to be pinged when it receives a new response. You can cancel an alert by using the `cancel` flag. | `!alert <cancel>` | |
| 48 | +| `!delete` | You can delete a response that you have made in a ticket with the rustmail message ID of your message (see footer of the message) | `!delete <message_id>` | |
| 49 | +| `!edit` | You can edit a response that you have made in a ticket with the rustmail message ID of your message (see footer of the message) and the new content. | `!edit <message_id> <new_content>` | |
| 50 | +| `!id` | Show the ID of the user in the current ticket. | `!id` | |
| 51 | +| `!move_thread` | Move a ticket in a different category. | `!move_thread <category_name>` | |
| 52 | +| `!recover` | Recover messages received during bot downtime. This process is automatic. | `!set_topic <topic>` | |
0 commit comments