Notifications client

The SDK provides a Notifications client to manage and send notifications.

Note

The client variable in the following code examples refers to the IMClient instance. When using the Web SDK, the variable name can be chosen freely, but it is also called client at instantiation in the documentation.

Email templates

Mail 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.

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

Getting an email template

To get an email template by name, for example the template for when a user has forgotten their password:

RequestResponseshell
var template = await client.Notifications.GetMailTemplateEntityAsync("ForgotPassword");

Note that it is still possible to get the mail template by id as well:

RequestResponseshell
var entity = await client.Entities.GetAsync(id);
// create an instance of a typed IMailTemplateEntity
IMailTemplateEntity template = client.TypedEntityFactory.FromEntity<IMailTemplateEntity>(entity);

Creating an email template

A simple hello world template could look like this:

RequestResponseshell
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);

Sending email notifications

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

  • MailRequestById: for specifying users by id.
  • MailRequestByUsername: for specifying users by username.
  • MailRequestBroadcast: sends to all users.

An email broadcast could be sent using the template previously created:

RequestResponseshell
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.

Sending real-time notifications

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

  • RealtimeRequestById: for specifying users by id.
  • RealtimeRequestByUsername: for specifying users by username.
  • RealtimeRequestBroadcast: sends to all users.

A real-time notification could be sent to the DemoUser:

RequestResponseshell
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 on the notification.

This real-time request interface is built on the standard notifications API: https://developer.mozilla.org/en-US/docs/Web/API/notification. This API 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 e-mails

Important

For SendConfirmationEmailAsync to work, you need to set EnableConfirmationMail to true in the settings.

Sending confirmation e-mails to users can be done using ids or usernames:

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

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

Do you have some feedback for us?

If you have suggestions for improving this article,