Notifications client

Email template entities contain the templates for sending emails. The variables can be resolved at runtime.

IMailTemplateEntity is a subtype of IEntity. It provides C# properties and methods for the members on the M.Mailing.Template entity definition.

To get these email templates, the client provides extra getters that are not available on the entities client. It allows fetching email templates by name. However, every operation on an IEntity still applies to IMailTemplateEntity. Saving and deleting IMailTemplateEntity objects is still done through the entities client.

A simple hello world template could look like this:

CultureInfo enUs = CultureInfo.GetCultureInfo("en-US");
var entity = await client.EntityFactory.CreateAsync(Constants.MailTemplate.DefinitionName);
var template = client.TypedEntityFactory.FromEntity <IMailTemplateEntity>(<ENTITY>);
template.Name = "Hello world template";
template.Subject[enUs] = "Hello there!";
template.Description[enUs] = "Hello";
template.Body[enUs] = "Hello {{Username}}!";
template.SetPropertyValue("M.Mailing.TemplateLabel", enUs, "Hello world template");

var templateVariable = new TemplateVariable
{
  Name = "Username",
  VariableType = TemplateVariableType.String
};
template.SetTemplateVariables(new[] { templateVariable });

await client.Entities.SaveAsync(<TEMPLATE>);

Emails can be sent to users by username, user ID, or by a broadcast. There are three respective overloads to the SendEmailNotificationAsync with the following input:

An email broadcast could be sent using the template:

var request = new MailRequestBroadcast
{
  MailTemplateName = "Hello world template"
};
request.Variables.Add("Username", "world");

await client.Notifications.SendEmailNotificationAsync(<REQUEST>);

This would send an e-mail containing "Hello world!", to everyone.

Real-time notifications can be sent to users by username, user ID, or by a broadcast. There are three respective overloads to the SendRealTimeNotificationAsync with the following input:

Here's an example of a real-time notification sent to the DemoUser:

var request = new RealtimeRequestByUsername()
{
  Title = "Your notification title",
  Link = new System.Uri("https://example.com")
};
request.Recipients.Add("DemoUser");
request.SetBody("Your description");
request.SetIcon("https://example.com/image.png");

await client.Notifications.SendRealTimeNotificationAsync(<REQUEST>);

The link is opened when the user clicks the notification.

This real-time request interface is built on the standard notifications API, which uses an options object that contains all the notification information. This object is directly passed from the IRealtimeRequest.Options property. Some helper methods have been provided to help configure this options object, for example, the body and the icon of the notification.

Sending confirmation emails to users can be done using IDs or usernames:

await client.Notifications.SendConfirmationEmailAsync("DemoUser");

This will send an email to the specified user, containing a secure link to activate their account.