# `Mailglass.StreamPolicyError`
[🔗](https://github.com/szTheory/mailglass/blob/v1.0.0/lib/mailglass/errors/stream_policy_error.ex#L1)

Raised when a message violates stream policy.

## Types

- `:stream_policy_violated` — the message violates rules for its assigned stream.

# `t`

```elixir
@type t() :: %Mailglass.StreamPolicyError{
  __exception__: true,
  cause: Exception.t() | nil,
  context: %{required(atom()) => term()},
  detail: %{rule: atom(), suggestion: String.t()} | nil,
  message: String.t(),
  type: :stream_policy_violated
}
```

# `new`
*since 0.2.0* 

```elixir
@spec new(
  atom(),
  keyword()
) :: t()
```

Build a `Mailglass.StreamPolicyError` struct.

---

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