Class Notifications

Notifications API client for the Mosaia SDK

Provides email notification functionality for sending emails through the Mosaia platform. This is useful for sending transactional emails, notifications, and other communications.

Example

import { Mosaia } from 'mosaia-node-sdk';

const mosaia = new Mosaia({ apiKey: 'your-api-key' });
const notifications = mosaia.notifications;

// Send an email
const result = await notifications.sendEmail({
  to: 'user@example.com',
  subject: 'Welcome!',
  text: 'Welcome to our platform!',
  html: '<h1>Welcome!</h1><p>Welcome to our platform!</p>'
});

Constructors

constructor

Methods

sendEmail

Constructors

constructor

Methods

sendEmail

  • sendEmail(
        email: NotificationEmailInterface,
    ): Promise<NotificationResponseInterface>

    Send an email notification

    Sends an email through the Mosaia platform's notification service. Supports both plain text and HTML email formats.

    Parameters

    Returns Promise<NotificationResponseInterface>

    Promise resolving to notification response

    Example

    // Send plain text email
    const result = await notifications.sendEmail({
      to: 'user@example.com',
      subject: 'Password Reset',
      text: 'Your password reset code is: 123456'
    });

    Example

    // Send HTML email
    const result = await notifications.sendEmail({
      to: 'user@example.com',
      subject: 'Welcome!',
      html: '<h1>Welcome!</h1><p>Thank you for joining!</p>'
    });

    Throws

    When email sending fails or required fields are missing

Settings

Member Visibility

On This Page

Constructors
Methods