Ma-notification-center NPM

ma-notification-center v4.0

ma-notification-center is a package developed by MobileArts for sending internal notifications via SMS, email, or Telegram, utilizing AWS SDK v3. This new and updated version can handle emails up to 2GB.

Key Features

Email Notifications: Send emails with support for multiple recipients, CC, and BCC.
Telegram Notifications: Send text messages, photos, and documents through Telegram.
SMS Notifications: Send SMS messages to multiple recipients.

Installation

To install the package, use the following command in your project directory:

cd yourpath
npm install ma-notification-center

Usage

After installation, you can add the package to your project with the following import statement:

const notifications = require('ma-notification-center');

Sending an Email

Use the sendEmail() method to send an email. This method requires arrays of recipient email addresses and the email content.

/* to_emails, cc_emails, and bcc_emails are arrays */
notifications.sendEmail(
  to_emails,        // Array of recipient email addresses
  cc_emails,        // Array of CC email addresses
  bcc_emails,       // Array of BCC email addresses
  subject,          // Email subject
  text_body,        // Plain text version of the email body
  text_html,        // HTML version of the email body
  sender_email,     // The email address that will appear as the sender (optional)
);

Sending a Telegram Message

Use the sendTelegram() method to send a Telegram text message.

/* chat_ids is an array */
notifications.sendTelegram(
  chat_ids,         // Array of Telegram chat IDs
  text              // The text message to send
);

Sending a Telegram Photo

Use the sendTelegramPhoto() method to send a photo via Telegram.

/* chat_ids is an array */
notifications.sendTelegramPhoto(
  chat_ids,         // Array of Telegram chat IDs
  imageurl,         // URL of the image to send
  caption           // Caption for the image (optional)
);

Sending a Telegram Document

Use the sendTelegramDocument() method to send a document via Telegram.

/* chat_ids is an array */
notifications.sendTelegramDocument(
  chat_ids,         // Array of Telegram chat IDs
  documenturl,      // URL of the document to send
  caption           // Caption for the document (optional)
);

Sending an SMS

Use the sendSMS() method to send an SMS to multiple recipients.

/* phonenumbers is an array */
notifications.sendSMS(
  source,           // The source or sender ID (optional, can be null)
  phonenumbers,     // Array of recipient phone numbers
  text              // The text message to send
);

Notes

Ensure that all email addresses and phone numbers are validated before sending notifications.
The package assumes that all necessary AWS credentials and configurations are set up in your environment.
The source parameter in sendSMS() is optional. If not provided, it can be handled downstream by your SMS service provider.