Set Up Language Filters from a Chat Client

Chat Service includes a set of in-band commands for configuring and managing the Profanity Filter extension from a chat client.

The in-band commands listed below cover:

• Displaying the Current Filters List
• Creating and Deleting Filters
• Adding and Deleting Words and Expressions
• Applying Filters
• Starting and Stopping Profanity Filtering on the Server

Important   To use these commands, you log on to the chat client as an administrator.

Displaying the Current Filters List

To display all of the filter lists that are currently set, from a chat client, type the following command:

EXTMSG PFILTER DUMP

Creating and Deleting Filters

To create a new filter on the server, from a chat client, type the following command:

EXTMSG PFILTER ADD LIST=filter_name

To delete a filter, from a chat client, type the following command:

EXTMSG PFILTER REMOVE LIST=filter_name

Adding and Deleting Words and Expressions

To add a word to a filter, from a chat client, type the following command:

EXTMSG PFILTER ADD LIST=filter_name BWORD=word

To add a word to a filter and set the reply message to it, from a chat client, type the following command:

EXTMSG PFILTER ADD LIST=filter_name BWORD=word REPLY=message

To add a wildcard expression to a filter, from a chat client, type the following command:

EXTMSG PFILTER ADD LIST=filter_name REG=expression

To add a wildcard expression to a filter and set the reply message to it, from a chat client, type the following command:

EXTMSG PFILTER ADD LIST=filter_name REG=expression REPLY=message

To add a word to a filter's exception list, from a chat client, type the following command:

EXTMSG PFILTER ADD LIST=filter_name GWORD=word

To delete a word from a filter, from a chat client, type the following command:

EXTMSG PFILTER REMOVE LIST=filter_name BWORD=word

To delete a wildcard expression from a filter, from a chat client, type the following command:

EXTMSG PFILTER REMOVE LIST=filter_name REG=expression

To delete a word from a filter's exception list, from a chat client, type the following command:

EXTMSG PFILTER REMOVE LIST=filter_name GWORD=word

Applying Filters

To apply a filter to private messages on the server, from a chat client, type the following command:

EXTMSG PFILTER SET PRIVATE=filter_name

To apply a filter to channel names on the server, from a chat client, type the following command:

EXTMSG PFILTER SET CHANNELNAMES=filter_name

To apply a filter to nicknames on the server, from a chat client, type the following command:

EXTMSG PFILTER SET NICKNAMES=filter_name

To apply a filter to all dynamic channels on the server, from a chat client, type the following command:

EXTMSG PFILTER SET DYNAMIC=filter_name

Starting and Stopping Profanity Filtering on the Server

To start filtering all dynamic channels, from a chat client, type the following command:

EXTMSG PFILTER START DYNAMIC

To start filtering only messages sent to all members of a registered channel, from a chat client, type the following command:

EXTMSG PFILTER START PERSISTENT=channel_name MESSAGES=PUBLIC LIST=filter_name

To start filtering all messages sent to a registered channel, from a chat client, type the following command:

EXTMSG PFILTER START PERSISTENT=channel_name MESSAGES=ALL LIST=filter_name

To stop filtering all dynamic channels, from a chat client, type the following command:

EXTMSG PFILTER STOP DYNAMIC

To stop filtering a registered channel, from a chat client, type the following command:

EXTMSG PFILTER STOP PERSISTENT=channel_name