Class EmailPreviewTab

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Email preview page.

public sealed class EmailPreviewTab : Page<EmailPreviewTemplateProperties>, IPage

Inheritance

object

Page<EmailPreviewTemplateProperties>

EmailPreviewTab

Implements

IPage

Inherited Members

Page<EmailPreviewTemplateProperties>.ConfigurePage()

Page<EmailPreviewTemplateProperties>.ValidatePage()

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

EmailPreviewTab(IInfoProvider<EmailConfigurationInfo>, IEmailContentResolverFactory, IEmailDataContextProvider, IEmailDetailedStatusRetriever, IEmailConfigurationAdminModelRetriever, IEmailMarkupBuilderFactory, IEmailRecipientContextProvider, IEmailConfigurationSenderEmailAddressRetriever, IStructuredEmailDataProvider)

Initializes a new instance of the EmailPreviewTab class.

public EmailPreviewTab(IInfoProvider<EmailConfigurationInfo> emailConfigurationInfoProvider, IEmailContentResolverFactory emailContentResolverFactory, IEmailDataContextProvider dataContextProvider, IEmailDetailedStatusRetriever emailDetailedStatusRetriever, IEmailConfigurationAdminModelRetriever emailConfigurationAdminModelRetriever, IEmailMarkupBuilderFactory emailMarkupBuilderFactory, IEmailRecipientContextProvider emailRecipientContextProvider, IEmailConfigurationSenderEmailAddressRetriever emailConfigurationSenderEmailAddressRetriever, IStructuredEmailDataProvider structuredEmailDataProvider)

Parameters

emailConfigurationInfoProvider IInfoProvider<EmailConfigurationInfo>

emailContentResolverFactory IEmailContentResolverFactory

dataContextProvider IEmailDataContextProvider

emailDetailedStatusRetriever IEmailDetailedStatusRetriever

emailConfigurationAdminModelRetriever IEmailConfigurationAdminModelRetriever

emailMarkupBuilderFactory IEmailMarkupBuilderFactory

emailRecipientContextProvider IEmailRecipientContextProvider

emailConfigurationSenderEmailAddressRetriever IEmailConfigurationSenderEmailAddressRetriever

structuredEmailDataProvider IStructuredEmailDataProvider

Remarks

This class is not supposed to be instantiated directly in a custom code.

Properties

ContentLanguageIdentifier

Content language identifier.

[PageParameter(typeof(ContentLanguageModelBinder), typeof(EmailChannelContentLanguage))]
public ContentLanguageUrlIdentifier ContentLanguageIdentifier { get; set; }

Property Value

ContentLanguageUrlIdentifier

EmailConfigurationID

Email configuration identifier.

[PageParameter(typeof(IntPageModelBinder), typeof(EmailEditLayout))]
public int EmailConfigurationID { get; set; }

Property Value

int

Methods

ConfigureTemplateProperties(EmailPreviewTemplateProperties)

Gets the object representing client side template properties.

public override Task<EmailPreviewTemplateProperties> ConfigureTemplateProperties(EmailPreviewTemplateProperties properties)

Parameters

properties EmailPreviewTemplateProperties

Initialized properties object.

Returns

Task<EmailPreviewTemplateProperties>

GetContent(CancellationToken)

Gets content of an email as HTML.

[PageCommand(Permission = "View")]
public Task<string> GetContent(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<string>

Returns email content as HTML string.

GetInboxViewData(CancellationToken)

Gets the data for the inbox view.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<GetInboxViewDataCommandResult>> GetInboxViewData(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetInboxViewDataCommandResult>>

GetStatusModel(CancellationToken)

Endpoint that returns status of the email.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<DetailedStatusModel>> GetStatusModel(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<DetailedStatusModel>>