@anzuev/notify

Notify

Notify~Notify

Kind: inner class of Notify
Friend: BaseNotification

• ~Notify
  • .configure(config)
  • .setMailAccounts(accounts) ⇒
  • .getMailConfirmNotification() ⇒ MailConfirmationNotification

Notify.configure(config)

Настройка модуля(логгера)

Kind: static method of Notify

Param	Description
config	конфиг типа nconf

Notify.setMailAccounts(accounts) ⇒

Передача почтовых аккаунтов, с которых будут слаться уведомления

Kind: static method of Notify
Returns: void

Param	Description
accounts	аккаунты для связки

Example

let accounts = {
		mailConfirm: { // название нотификации
		mail: '[e-mail]', // какой адрес используем
			password: "quetbxdfpzhtsnid", // какой пароль к ящику
			htmlTemp: "/Users/anton/GitHub/Notify/templates/MailConfirm.html" // путь к шаблону письма
		},
		restorePassword: {
			mail: "[e-mail]",
			password: "quetbxdfpzhtsnid"
		}
	};
Notify.setMailAccounts(accounts);

Notify.getMailConfirmNotification() ⇒ MailConfirmationNotification

Получение класса для создания нотификации для подтверждения почты

Kind: static method of Notify
Throws:

• ValidationError , code = 500, Модуль Notify не был настроен(Notify.configure and Notify.setMailAccounts)

Notify~BaseNotification

Класс для представления нотификации по почте. Здесь определены сеттеры/геттеры для нотификации, а также отправка в общем случае(без рендеринга сообщения)

Kind: inner class of Notify
Properties

Name	Type	Description
subject	String	тема письма
cc	Array.<String>	массив адрессов в открытой копии
bcc	Array.<String>	массив адрессов в закрытой копии
type	String	тип нотификации(mailConfirm и тд)
html	String	html-содержимое письма
text	Sting	raw-содержимое пиьсма
attachment		массив прикрепленных докумнетов(не реализовано)

• ~BaseNotification
  • instance
    • .setCc(addresses)
    • .setBcc(addresses)
    • .setHtml(html)
    • .setText(text)
    • .setSubject(subject)
    • .getType() ⇒ String
    • .getHtml() ⇒ String
    • .getText() ⇒ String
    • .getSubject() ⇒ String
    • .getCc() ⇒ Array.<String>
    • .getBcc() ⇒ Array.<String>
  • static
    • .BaseNotification
      • new BaseNotification()

baseNotification.setCc(addresses)

Установка адресов в копию

Kind: instance method of BaseNotification

Param	Type	Description
addresses	Array.<String>	адреса

baseNotification.setBcc(addresses)

Установка адресов в скрытую копию

Kind: instance method of BaseNotification

Param	Type	Description
addresses	Array.<String>	адреса

baseNotification.setHtml(html)

Установка html-содержимого для письма

Kind: instance method of BaseNotification

Param	Type	Description
html	String	html-содержимое

baseNotification.setText(text)

Установка raw-содержимого для письма

Kind: instance method of BaseNotification

Param	Type	Description
text	String	raw-содержимое

baseNotification.setSubject(subject)

Установка темы для письма

Kind: instance method of BaseNotification

Param	Type	Description
subject	String	subject-содержимое

baseNotification.getType() ⇒ String

Получение типа

Kind: instance method of BaseNotification
Returns: String - type

baseNotification.getHtml() ⇒ String

Получение html-содержимого

Kind: instance method of BaseNotification
Returns: String - html

baseNotification.getText() ⇒ String

Получение raw-текста

Kind: instance method of BaseNotification
Returns: String - text

baseNotification.getSubject() ⇒ String

Получение темы

Kind: instance method of BaseNotification
Returns: String - topic

baseNotification.getCc() ⇒ Array.<String>

Получение копии

Kind: instance method of BaseNotification
Returns: Array.<String> - сс

baseNotification.getBcc() ⇒ Array.<String>

Получение скрытой копии

Kind: instance method of BaseNotification
Returns: Array.<String> - bсс

BaseNotification.BaseNotification

Kind: static class of BaseNotification

new BaseNotification()

Конструктор, создает новую нотификацию

Notify~MailConfirmationNotification ⇐ BaseNotification

Класс, представляющий нотификацию, отправляемую на почту, для подтверждения почты. Наследуется от Base

Kind: inner class of Notify
Extends: BaseNotification

• ~MailConfirmationNotification ⇐ BaseNotification
  • instance
    • .sendToMany(users) ⇒ void
    • .sendToOne(user) ⇒ void
  • static
    • .MailConfirmationNotification
      • new MailConfirmationNotification(link)

mailConfirmationNotification.sendToMany(users) ⇒ void

Отправка уведомления нескольким пользователям

Kind: instance method of MailConfirmationNotification
Access: public

Param	Type	Description
users	Array.<String>	массив адресов для отправки

mailConfirmationNotification.sendToOne(user) ⇒ void

Отправка уведомления одному пользователю

Kind: instance method of MailConfirmationNotification
Access: public

Param	Type	Description
user	String	адрес для отправки

MailConfirmationNotification.MailConfirmationNotification

Kind: static class of MailConfirmationNotification
Access: public

new MailConfirmationNotification(link)

Конструктор для MailConfirmationNotification

Param	Description
link	ссылка для подтверждения почты(уже с вставленной почтой и ключом) Формат - host + /auth/confirmMail?mail=%s&key=%s