# `Mailglass.Credo.PrefixedPubSubTopics`
[🔗](https://github.com/szTheory/mailglass/blob/v1.0.0/credo_checks/prefixed_pub_sub_topics.ex#L1)

## Basics

> #### This check is disabled by default. {: .neutral}
>
> [Learn how to enable it](`e:credo:config_file.html#checks`) via `.credo.exs`.

This check has a base priority of `high` and works with any version of Elixir.

## Explanation

`Phoenix.PubSub` topics used by mailglass must use the `mailglass:`
namespace prefix.

## Check-Specific Parameters

Use the following parameters to configure this check:

### `:required_prefix`

  Required topic prefix for literal PubSub topic strings.

*This parameter defaults to* `"mailglass:"`.

## General Parameters

Like with all checks, [general params](`e:credo:check_params.html`) can be applied.

Parameters can be configured via the [`.credo.exs` config file](`e:credo:config_file.html`).

---

*Consult [api-reference.md](api-reference.md) for complete listing*