feat: thread_min_characters config.

Added
- Config option `thread_min_characters` to require a minimum number of characters in the initial message to create a thread.
- Configurable error message options: `thread_min_characters_title`, `thread_min_characters_response`, and `thread_min_characters_footer`.

Author: lorenzo132

cogs/modmail.py

@@ -1637,6 +1637,7 @@ async def contact(
             creator=creator,
             category=category,
             manual_trigger=manual_trigger,
+            # The minimum character check is enforced in ThreadManager.create
         )
 
         if thread.cancelled:

core/config.py

@@ -129,6 +129,11 @@ class ConfigManager:
         # regex
         "use_regex_autotrigger": False,
         "use_hoisted_top_role": True,
+        # Minimum characters for thread creation
+        "thread_min_characters": 0,
+        "thread_min_characters_title": "Message too short",
+        "thread_min_characters_response": "Your message is too short to create a thread. Please provide more details.",
+        "thread_min_characters_footer": "Minimum {min_characters} characters required.",
     }
 
     private_keys = {

core/config_help.json

@@ -12,7 +12,7 @@
   },
   "main_category_id": {
     "default": "`Modmail` (created with `{prefix}setup`)",
-    "description": "This is the category where all new threads will be created.\n\nTo change the Modmail category, you will need to find the [category’s ID](https://support.discordapp.com/hc/en-us/articles/206346498).",
+    "description": "This is the category where all new threads will be created.\n\nTo change the Modmail category, you will need to find the [category's ID](https://support.discordapp.com/hc/en-us/articles/206346498).",
     "examples": [
       "`{prefix}config set main_category_id 9234932582312` (`9234932582312` is the category ID)"
     ],
@@ -24,7 +24,7 @@
   },
   "fallback_category_id": {
     "default": "`Fallback Modmail` (created when the main category is full)",
-    "description": "This is the category that will hold the threads when the main category is full.\n\nTo change the Fallback category, you will need to find the [category’s ID](https://support.discordapp.com/hc/en-us/articles/206346498).",
+    "description": "This is the category that will hold the threads when the main category is full.\n\nTo change the Fallback category, you will need to find the [category's ID](https://support.discordapp.com/hc/en-us/articles/206346498).",
     "examples": [
       "`{prefix}config set fallback_category_id 9234932582312` (`9234932582312` is the category ID)"
     ],
@@ -88,7 +88,7 @@
   },
   "user_typing": {
     "default": "Enabled",
-    "description": "When this is set to `yes`, whenever the recipient user starts to type in their DM channel, the moderator will see “{bot.user.display_name} is typing…” in the thread channel.",
+    "description": "When this is set to `yes`, whenever the recipient user starts to type in their DM channel, the moderator will see "{bot.user.display_name} is typing..." in the thread channel.",
     "examples": [
       "`{prefix}config set user_typing yes`",
       "`{prefix}config set user_typing no`"
@@ -151,7 +151,7 @@
   },
   "mod_typing": {
     "default": "Disabled",
-    "description": "When this is set to `yes`, whenever a moderator starts to type in the thread channel, the recipient user will see \"{bot.user.display_name} is typing…\" in their DM channel.",
+    "description": "When this is set to `yes`, whenever a moderator starts to type in the thread channel, the recipient user will see "{bot.user.display_name} is typing..." in their DM channel.",
     "examples": [
       "`{prefix}config set mod_typing yes`",
       "`{prefix}config set mod_typing no`"
@@ -219,7 +219,7 @@
   },
   "log_channel_id": {
     "default": "`#bot-logs` (created with `{prefix}setup`)",
-    "description": "This is the channel where all log messages will be sent (ie. thread close message, update message, etc.).\n\nTo change the log channel, you will need to find the [channel’s ID](https://support.discordapp.com/hc/en-us/articles/206346498). The channel doesn’t necessary have to be under the `main_category`.",
+    "description": "This is the channel where all log messages will be sent (ie. thread close message, update message, etc.).\n\nTo change the log channel, you will need to find the [channel's ID](https://support.discordapp.com/hc/en-us/articles/206346498). The channel doesn't necessary have to be under the `main_category`.",
     "examples": [
       "`{prefix}config set log_channel_id 9234932582312` (9234932582312 is the channel ID)"
     ],
@@ -704,7 +704,7 @@
   },
   "mod_tag": {
     "default": "The moderator's highest role",
-    "description": "This is the name tag in the “footer” section of the embeds sent by moderators in the recipient DM and thread channel.",
+    "description": "This is the name tag in the "footer" section of the embeds sent by moderators in the recipient DM and thread channel.",
     "examples": [
       "`{prefix}config set mod_tag Moderator`"
     ],
@@ -715,7 +715,7 @@
   },
   "anon_username": {
     "default": "Fallback on `mod_tag`",
-    "description": "This is the name in the “author” section of the embeds sent by anonymous moderators in the recipient DM.",
+    "description": "This is the name in the "author" section of the embeds sent by anonymous moderators in the recipient DM.",
     "examples": [
       "`{prefix}config set anon_username Incognito Mod`"
     ],
@@ -737,7 +737,7 @@
   },
   "anon_tag": {
     "default": "\"Response\"",
-    "description": "This is the name tag in the “footer” section of the embeds sent by anonymous moderators in the recipient DM.",
+    "description": "This is the name tag in the "footer" section of the embeds sent by anonymous moderators in the recipient DM.",
     "examples": [
       "`{prefix}config set anon_tag Support Agent`"
     ],
@@ -976,7 +976,7 @@
     ],
     "notes": [
       "The private_ variant is used when sending to the new user.",
-      "See also: `private_removed_from_group_title`, `private_removed_from_group_title`"
+      "See also: `private_removed_from_group_title`, `private_removed_from_group_title`
     ]
   },
   "public_removed_from_group_response": {
@@ -1222,5 +1222,48 @@
       "If this configuration is enabled, only roles that are hoisted (displayed seperately in member list) will be used. If a user has no hoisted roles, it will return 'None'.",
       "If you would like to display the top role of a user regardless of if it's hoisted or not, disable `use_hoisted_top_role`."
     ]
+  },
+  "thread_min_characters": {
+    "default": "0",
+    "description": "The minimum number of characters required in the initial message to create a thread. Set to 0 to disable.",
+    "examples": [
+      "`{prefix}config set thread_min_characters 20`"
+    ],
+    "notes": [
+      "If a user tries to create a thread with a message shorter than this, an error will be shown.",
+      "See also: `thread_min_characters_title`, `thread_min_characters_response`, `thread_min_characters_footer`."
+    ]
+  },
+  "thread_min_characters_title": {
+    "default": "Message too short",
+    "description": "The title of the error embed when a user tries to create a thread with too few characters.",
+    "examples": [
+      "`{prefix}config set thread_min_characters_title Too short!`"
+    ],
+    "notes": [
+      "See also: `thread_min_characters`, `thread_min_characters_response`, `thread_min_characters_footer`."
+    ]
+  },
+  "thread_min_characters_response": {
+    "default": "Your message is too short to create a thread. Please provide more details.",
+    "description": "The description of the error embed when a user tries to create a thread with too few characters.",
+    "examples": [
+      "`{prefix}config set thread_min_characters_response Please write a longer message.`"
+    ],
+    "notes": [
+      "You can use `{min_characters}` as a placeholder for the minimum required characters.",
+      "See also: `thread_min_characters`, `thread_min_characters_title`, `thread_min_characters_footer`."
+    ]
+  },
+  "thread_min_characters_footer": {
+    "default": "Minimum {min_characters} characters required.",
+    "description": "The footer of the error embed when a user tries to create a thread with too few characters.",
+    "examples": [
+      "`{prefix}config set thread_min_characters_footer At least {min_characters} characters needed.`"
+    ],
+    "notes": [
+      "You can use `{min_characters}` as a placeholder for the minimum required characters.",
+      "See also: `thread_min_characters`, `thread_min_characters_title`, `thread_min_characters_response`."
+    ]
   }
 }

core/thread.py

@@ -1406,6 +1406,27 @@ async def create(
     ) -> Thread:
         """Creates a Modmail thread"""
 
+        # Minimum character check
+        min_chars = self.bot.config.get("thread_min_characters")
+        if min_chars is None:
+            min_chars = 0
+        try:
+            min_chars = int(min_chars)
+        except Exception:
+            min_chars = 0
+        if min_chars > 0 and message is not None and message.content is not None:
+            if len(message.content.strip()) < min_chars:
+                embed = discord.Embed(
+                    title=self.bot.config.get("thread_min_characters_title", "Message too short"),
+                    description=self.bot.config.get("thread_min_characters_response", "Your message is too short to create a thread. Please provide more details.").replace("{min_characters}", str(min_chars)),
+                    color=self.bot.error_color,
+                )
+                embed.set_footer(text=self.bot.config.get("thread_min_characters_footer", "Minimum {min_characters} characters required.").replace("{min_characters}", str(min_chars)))
+                await message.channel.send(embed=embed)
+                thread = Thread(self, recipient)
+                thread.cancelled = True
+                return thread
+
         # checks for existing thread in cache
         thread = self.cache.get(recipient.id)
         if thread: