View Source

Class NotificationEmailBodyParams

Represents the parameters used for generating a notification email body.

Inheritance

object

Namespace: Umbraco.Cms.Core.Models

Assembly: Umbraco.Core.dll

Syntax

public class NotificationEmailBodyParams

Constructors

NotificationEmailBodyParams(string?, string?, string?, string, string, string?, string, string)

Initializes a new instance of the NotificationEmailBodyParams class.

Declaration

public NotificationEmailBodyParams(string? recipientName, string? action, string? itemName, string itemId, string itemUrl, string? editedUser, string siteUrl, string summary)

Parameters

Type	Name	Description
string	recipientName	The name of the email recipient.
string	action	The action that triggered the notification (e.g., "published", "updated").
string	itemName	The name of the content item affected.
string	itemId	The unique identifier of the content item.
string	itemUrl	The URL to the content item in the backoffice.
string	editedUser	The name of the user who performed the action.
string	siteUrl	The base URL of the site.
string	summary	The summary of changes, either HTML or text based depending on email type.

Exceptions

Type	Condition
ArgumentNullException	Thrown when any parameter is null.

Properties

Action

Gets the action that triggered the notification (e.g., "published", "updated").

Declaration

public string Action { get; }

Property Value

Type	Description
string

EditedUser

Gets the name of the user who performed the action.

Declaration

public string EditedUser { get; }

Property Value

Type	Description
string

ItemId

Gets the unique identifier of the content item.

Declaration

public string ItemId { get; }

Property Value

Type	Description
string

ItemName

Gets the name of the content item affected.

Declaration

public string ItemName { get; }

Property Value

Type	Description
string

ItemUrl

Gets the URL to the content item in the backoffice.

Declaration

public string ItemUrl { get; }

Property Value

Type	Description
string

RecipientName

Gets the name of the email recipient.

Declaration

public string RecipientName { get; }

Property Value

Type	Description
string

SiteUrl

Gets the base URL of the site.

Declaration

public string SiteUrl { get; }

Property Value

Type	Description
string

Summary

This will either be an HTML or text based summary depending on the email type being sent

Declaration

public string Summary { get; }

Property Value

Type	Description
string