Class ContactMailCategory

Namespace

Tharga.Team

Assembly

Tharga.Team.dll

A kind of mail the product's staff send to contacts — people who are not users, such as prospective customers — which each address may opt out of.

public sealed record ContactMailCategory : IEquatable<ContactMailCategory>

Inheritance

object

ContactMailCategory

Implements

IEquatable<ContactMailCategory>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Always optional and never a user's choice. Every contact mail carries an unsubscribe link, an opt-out is kept for the address rather than for a user, and contact categories are never listed in a user's mail settings.

The key is stored on every mail and every opt-out, so it never changes once mail has been sent in it, and it may not be the key of a user mail category. The name and description are shown on the unsubscribe page through the host's text catalogue: NameKey and DescriptionKey are what a translation is registered under, Name and Description the English used when there is none.

Properties

Description

One sentence on what the mail is about, in English.

public string Description { get; init; }

Property Value

string

DescriptionKey

The text key the description is translated under; contactMail.category.{Key}.description unless set.

public string DescriptionKey { get; init; }

Property Value

string

Key

The stable key: lowercase letters, digits, dots, dashes and underscores, starting with a letter or digit.

public required string Key { get; init; }

Property Value

string

Name

The name shown on the unsubscribe page and to staff, in English.

public required string Name { get; init; }

Property Value

string

NameKey

The text key the name is translated under; contactMail.category.{Key}.name unless set.

public string NameKey { get; init; }

Property Value

string