> For the complete documentation index, see [llms.txt](https://docs.homebots.live/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.homebots.live/modules/modmail-and-bring-in/modmail-commands.md).

# ModMail Commands

{% hint style="danger" %}
We highly recommend you read through [ModMail & Bring-in](/modules/modmail-and-bring-in.md) in its entirety first.
{% endhint %}

On this page, we'll go through all ModMail configuration commands, which are:

* [ModMail Module Configuration](#setup-modmail-setup_modmail)
* [Adding ModMail Categories](#add-modmail-category-modmail-category-add)
* [Removing ModMail Categories](#remove-modmail-category-config-modmail-remove_category)
* [Blacklisting User From ModMail](#modmail-blacklist-user-config-modmail-blacklist)
* [Unblacklisting User From ModMail](#modmail-unblacklist-user-config-modmail-unblacklist)

***

### Config ModMail Module (`/config modmail module`) <a href="#setup-modmail-setup_modmail" id="setup-modmail-setup_modmail"></a>

{% hint style="warning" %}
By default, only members with the **Administration** permission can use this command.
{% endhint %}

*Configure the ModMail module.*

**`state`**: Whether new ModMail tickets can be created or not.

**`perms_role`**: The role that will be required to execute ModMail & Bring-in ticket commands.

**`logs_channel`**: The channel where all ModMail message logs will be sent.

**`naming_type`**: The type of ModMail & Bring-in ticket channel naming; this can be `Usernames (#elysianxiv)` or `Numbers (#ticket-0297)`.

***

### Add ModMail Category (`/config modmail add_category`) <a href="#add-modmail-category-modmail-category-add" id="add-modmail-category-modmail-category-add"></a>

{% hint style="warning" %}
By default, only members with the **Administration** permission can use this command. Additionally, the ModMail module must first be configured before using this command.
{% endhint %}

*Add a new ModMail category.*

**`category`**: The category that ModMail ticket channels will be created in.

**`name`**: The name of the new category.

**`description`**: The description of the new category.

**`mentions_content`**: The mentions that will be sent when a new ticket of this category is created. Mention however many roles in like so: `<@&`**`ROLEID`**`> <@&`**`ROLEID`**`>`.

**`transcript_channel`**: The channel where all transcripts of this category's tickets will be sent.

{% hint style="info" %}
**Character Limits**

`name`: maximum of 100 characters

`description`: maximum of 400 characters

`mentions_content`: maximum of 250 characters
{% endhint %}

***

### Remove ModMail Category (`/config modmail remove_category`)

{% hint style="warning" %}
By default, only members with the **Administration** permission can use this command. Additionally, the ModMail module must first be configured before using this command.d.
{% endhint %}

*Remove an existing ModMail category.*

**`category`**: The name of the category to be removed. This is an autocomplete, so it will show you a list of all categories.

***

### ModMail Blacklist User (`/config modmail blacklist`)

{% hint style="warning" %}
By default, only members with the **Administration** permission can use this command. Additionally, the ModMail module must first be configured before using this command.
{% endhint %}

*Blacklist a user from creating ModMail tickets.*

**`user`**: The user to be blacklisted from ModMail.

***

### ModMail Unblacklist User (`/config modmail unblacklist`)

{% hint style="warning" %}
By default, only members with the **Administration** permission can use this command. Additionally, the ModMail module must first be configured before using this command.
{% endhint %}

*Unblacklist a blacklisted user from creating ModMail tickets.*

**`user`**: The user to be unblacklisted from ModMail.