Modmail Guide: Using Snippets¶

What Are Snippets?¶

What Are Snippets?

Snippets are pre-written, reusable messages that you can send in a Modmail ticket with a simple command. Think of them as "canned responses" or templates for frequently asked questions or common situations. Using snippets helps us provide faster, more consistent answers to our community members.

How to Use Snippets¶

1. Viewing Available Snippets¶

Before you can use a snippet, you need to know what's available.

Viewing Snippets

To see a list of all snippets:
```
!snippets
```
To view a specific snippet's content: Use the !s command followed by the snippet's shortcut name.
```
!s <shortcut>
```
For example, to see the content of a snippet named hi, you would type:
```
!s hi
```

2. Sending a Snippet to a User¶

When you're ready to reply with a snippet, use two exclamation marks (!!) followed by the snippet's shortcut name. This will instantly send the pre-written message to the user.

Sending a Snippet

Format:

!!<shortcut>

For instance, if the hi snippet contains "Hello, how can we help you?", typing the following will send that message:

!!hi

No Confirmation Step

As soon as you send the command, the message is sent to the user. There is no confirmation prompt.

Managing Snippets¶

For Admins/Senior Mods Only

These commands are for creating, editing, and deleting snippets and should be used with care.

Creating a New SnippetEditing an Existing SnippetDeleting a Snippet

To create a new snippet, use the !s command followed by the desired shortcut name and then the full text of the message.

Format: !s <shortcut> <text>

!s hi Hello, how can we help you today?

If you need to update the text of a snippet, use the !edit_snippet command (or its shorter alias !es).

Format: !edit_snippet <shortcut> <text>

!es hi Hello! How may we assist you?

To permanently remove a snippet, use the !delete_snippet command followed by its shortcut name.

Format: !delete_snippet <shortcut> !delete_snippet hi !!! failure "Important: Deletion is Permanent" Deleting a snippet cannot be undone. Be certain before you remove one.