{"_id":"@anzuev/notify","_rev":"3-2f5deb04a65da895e87c14da9d70ee81","name":"@anzuev/notify","description":"Notification service for StudCloud project","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@anzuev/notify","version":"0.0.1","description":"Notification service for StudCloud project","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["studcloud","notify"],"author":{"name":"AnZuev"},"license":"ISC","dependencies":{"@anzuev/studcloud.errors":"^0.2.0","bluebird":"^3.4.1","log4js":"^0.6.37","mz":"^2.4.0","nodemailer":"^2.5.0","nodemailer-smtp-transport":"^2.6.0"},"devDependencies":{"gulp":"^3.9.1","gulp-concat":"^2.6.0","gulp-jsdoc-to-markdown":"^1.2.2","gulp-util":"^3.0.7"},"gitHead":"af042208034b88690fb6d723d32a47d8e4b846b0","_id":"@anzuev/notify@0.0.1","_shasum":"a4915a6ab927b00965e5313ab7c8d72add0ecaf6","_from":".","_npmVersion":"3.3.12","_nodeVersion":"5.4.1","_npmUser":{"name":"anzuev","email":"anzuev@istudentapp.ru"},"dist":{"shasum":"a4915a6ab927b00965e5313ab7c8d72add0ecaf6","tarball":"https://registry.npmjs.org/@anzuev/notify/-/notify-0.0.1.tgz","integrity":"sha512-G5Vm2hHuXidpCYVShHrBdwormmniGP48tfmrMo43CyQMWqWEgGARYmCIfVVEkphNifpkPnSHLXCd0U2BX6mDqQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC7yKxq0DqagBZq+p5370remMYLN2fGOMUuOZbGeJT78wIhAOZQcD/Sj7p4EgpwIAmGi3RPqTBnyTn8BW5uSbzY5ZNg"}]},"maintainers":[{"name":"anzuev","email":"anzuev@istudentapp.ru"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/notify-0.0.1.tgz_1470222198356_0.9734775137621909"}}},"readme":"\n# Notify\n  <a name=\"module_Notify..Notify\"></a>\n\n### Notify~Notify\n**Kind**: inner class of <code>[Notify](#module_Notify)</code>  \n**Friend**: BaseNotification  \n\n* [~Notify](#module_Notify..Notify)\n    * [.configure(config)](#module_Notify..Notify.configure)\n    * [.setMailAccounts(accounts)](#module_Notify..Notify.setMailAccounts) ⇒\n    * [.getMailConfirmNotification()](#module_Notify..Notify.getMailConfirmNotification) ⇒ <code>MailConfirmationNotification</code>\n\n<a name=\"module_Notify..Notify.configure\"></a>\n\n#### Notify.configure(config)\nНастройка модуля(логгера)\n\n**Kind**: static method of <code>[Notify](#module_Notify..Notify)</code>  \n\n| Param | Description |\n| --- | --- |\n| config | конфиг типа nconf |\n\n<a name=\"module_Notify..Notify.setMailAccounts\"></a>\n\n#### Notify.setMailAccounts(accounts) ⇒\nПередача почтовых аккаунтов, с которых будут слаться уведомления\n\n**Kind**: static method of <code>[Notify](#module_Notify..Notify)</code>  \n**Returns**: void  \n\n| Param | Description |\n| --- | --- |\n| accounts | аккаунты для связки |\n\n**Example**  \n```js\nlet accounts = {\n\t\tmailConfirm: { // название нотификации\n\t\tmail: 'auth@istudentapp.ru', // какой адрес используем\n\t\t\tpassword: \"quetbxdfpzhtsnid\", // какой пароль к ящику\n\t\t\thtmlTemp: \"/Users/anton/GitHub/Notify/templates/MailConfirm.html\" // путь к шаблону письма\n\t\t},\n\t\trestorePassword: {\n\t\t\tmail: \"auth@istudentapp.ru\",\n\t\t\tpassword: \"quetbxdfpzhtsnid\"\n\t\t}\n\t};\nNotify.setMailAccounts(accounts);\n```\n<a name=\"module_Notify..Notify.getMailConfirmNotification\"></a>\n\n#### Notify.getMailConfirmNotification() ⇒ <code>MailConfirmationNotification</code>\nПолучение класса для создания нотификации для подтверждения почты\n\n**Kind**: static method of <code>[Notify](#module_Notify..Notify)</code>  \n**Throws**:\n\n- <code>ValidationError</code> , code = 500, Модуль Notify не был настроен(Notify.configure and Notify.setMailAccounts)\n\n<a name=\"module_Notify..BaseNotification\"></a>\n\n### Notify~BaseNotification\nКласс для представления нотификации по почте. Здесь определены\nсеттеры/геттеры для нотификации, а также отправка в общем случае(без рендеринга сообщения)\n\n**Kind**: inner class of <code>[Notify](#module_Notify)</code>  \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| subject | <code>String</code> | тема письма |\n| cc | <code>Array.&lt;String&gt;</code> | массив адрессов в открытой копии |\n| bcc | <code>Array.&lt;String&gt;</code> | массив адрессов в закрытой копии |\n| type | <code>String</code> | тип нотификации(mailConfirm и тд) |\n| html | <code>String</code> | html-содержимое письма |\n| text | <code>Sting</code> | raw-содержимое пиьсма |\n| attachment |  | массив прикрепленных докумнетов(не реализовано) |\n\n\n* [~BaseNotification](#module_Notify..BaseNotification)\n    * _instance_\n        * [.setCc(addresses)](#module_Notify..BaseNotification+setCc)\n        * [.setBcc(addresses)](#module_Notify..BaseNotification+setBcc)\n        * [.setHtml(html)](#module_Notify..BaseNotification+setHtml)\n        * [.setText(text)](#module_Notify..BaseNotification+setText)\n        * [.setSubject(subject)](#module_Notify..BaseNotification+setSubject)\n        * [.getType()](#module_Notify..BaseNotification+getType) ⇒ <code>String</code>\n        * [.getHtml()](#module_Notify..BaseNotification+getHtml) ⇒ <code>String</code>\n        * [.getText()](#module_Notify..BaseNotification+getText) ⇒ <code>String</code>\n        * [.getSubject()](#module_Notify..BaseNotification+getSubject) ⇒ <code>String</code>\n        * [.getCc()](#module_Notify..BaseNotification+getCc) ⇒ <code>Array.&lt;String&gt;</code>\n        * [.getBcc()](#module_Notify..BaseNotification+getBcc) ⇒ <code>Array.&lt;String&gt;</code>\n    * _static_\n        * [.BaseNotification](#module_Notify..BaseNotification.BaseNotification)\n            * [new BaseNotification()](#new_module_Notify..BaseNotification.BaseNotification_new)\n\n<a name=\"module_Notify..BaseNotification+setCc\"></a>\n\n#### baseNotification.setCc(addresses)\nУстановка адресов в копию\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| addresses | <code>Array.&lt;String&gt;</code> | адреса |\n\n<a name=\"module_Notify..BaseNotification+setBcc\"></a>\n\n#### baseNotification.setBcc(addresses)\nУстановка адресов в скрытую копию\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| addresses | <code>Array.&lt;String&gt;</code> | адреса |\n\n<a name=\"module_Notify..BaseNotification+setHtml\"></a>\n\n#### baseNotification.setHtml(html)\nУстановка html-содержимого для письма\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| html | <code>String</code> | html-содержимое |\n\n<a name=\"module_Notify..BaseNotification+setText\"></a>\n\n#### baseNotification.setText(text)\nУстановка raw-содержимого для письма\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| text | <code>String</code> | raw-содержимое |\n\n<a name=\"module_Notify..BaseNotification+setSubject\"></a>\n\n#### baseNotification.setSubject(subject)\nУстановка темы для письма\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| subject | <code>String</code> | subject-содержимое |\n\n<a name=\"module_Notify..BaseNotification+getType\"></a>\n\n#### baseNotification.getType() ⇒ <code>String</code>\nПолучение типа\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n**Returns**: <code>String</code> - type  \n<a name=\"module_Notify..BaseNotification+getHtml\"></a>\n\n#### baseNotification.getHtml() ⇒ <code>String</code>\nПолучение html-содержимого\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n**Returns**: <code>String</code> - html  \n<a name=\"module_Notify..BaseNotification+getText\"></a>\n\n#### baseNotification.getText() ⇒ <code>String</code>\nПолучение raw-текста\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n**Returns**: <code>String</code> - text  \n<a name=\"module_Notify..BaseNotification+getSubject\"></a>\n\n#### baseNotification.getSubject() ⇒ <code>String</code>\nПолучение темы\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n**Returns**: <code>String</code> - topic  \n<a name=\"module_Notify..BaseNotification+getCc\"></a>\n\n#### baseNotification.getCc() ⇒ <code>Array.&lt;String&gt;</code>\nПолучение копии\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n**Returns**: <code>Array.&lt;String&gt;</code> - сс  \n<a name=\"module_Notify..BaseNotification+getBcc\"></a>\n\n#### baseNotification.getBcc() ⇒ <code>Array.&lt;String&gt;</code>\nПолучение скрытой копии\n\n**Kind**: instance method of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n**Returns**: <code>Array.&lt;String&gt;</code> - bсс  \n<a name=\"module_Notify..BaseNotification.BaseNotification\"></a>\n\n#### BaseNotification.BaseNotification\n**Kind**: static class of <code>[BaseNotification](#module_Notify..BaseNotification)</code>  \n<a name=\"new_module_Notify..BaseNotification.BaseNotification_new\"></a>\n\n##### new BaseNotification()\nКонструктор, создает новую нотификацию\n\n<a name=\"module_Notify..MailConfirmationNotification\"></a>\n\n### Notify~MailConfirmationNotification ⇐ <code>BaseNotification</code>\nКласс, представляющий нотификацию, отправляемую на почту, для подтверждения почты. Наследуется от Base\n\n**Kind**: inner class of <code>[Notify](#module_Notify)</code>  \n**Extends:** <code>BaseNotification</code>  \n\n* [~MailConfirmationNotification](#module_Notify..MailConfirmationNotification) ⇐ <code>BaseNotification</code>\n    * _instance_\n        * [.sendToMany(users)](#module_Notify..MailConfirmationNotification+sendToMany) ⇒ <code>void</code>\n        * [.sendToOne(user)](#module_Notify..MailConfirmationNotification+sendToOne) ⇒ <code>void</code>\n    * _static_\n        * [.MailConfirmationNotification](#module_Notify..MailConfirmationNotification.MailConfirmationNotification)\n            * [new MailConfirmationNotification(link)](#new_module_Notify..MailConfirmationNotification.MailConfirmationNotification_new)\n\n<a name=\"module_Notify..MailConfirmationNotification+sendToMany\"></a>\n\n#### mailConfirmationNotification.sendToMany(users) ⇒ <code>void</code>\nОтправка уведомления нескольким пользователям\n\n**Kind**: instance method of <code>[MailConfirmationNotification](#module_Notify..MailConfirmationNotification)</code>  \n**Access:** public  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| users | <code>Array.&lt;String&gt;</code> | массив адресов для отправки |\n\n<a name=\"module_Notify..MailConfirmationNotification+sendToOne\"></a>\n\n#### mailConfirmationNotification.sendToOne(user) ⇒ <code>void</code>\nОтправка уведомления одному пользователю\n\n**Kind**: instance method of <code>[MailConfirmationNotification](#module_Notify..MailConfirmationNotification)</code>  \n**Access:** public  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| user | <code>String</code> | адрес для отправки |\n\n<a name=\"module_Notify..MailConfirmationNotification.MailConfirmationNotification\"></a>\n\n#### MailConfirmationNotification.MailConfirmationNotification\n**Kind**: static class of <code>[MailConfirmationNotification](#module_Notify..MailConfirmationNotification)</code>  \n**Access:** public  \n<a name=\"new_module_Notify..MailConfirmationNotification.MailConfirmationNotification_new\"></a>\n\n##### new MailConfirmationNotification(link)\nКонструктор для MailConfirmationNotification\n\n\n| Param | Description |\n| --- | --- |\n| link | ссылка для подтверждения почты(уже с вставленной почтой и ключом) Формат - host + /auth/confirmMail?mail=%s&key=%s |\n\n","maintainers":[{"name":"anzuev","email":"anzuev@istudentapp.ru"}],"time":{"modified":"2022-06-12T14:43:24.182Z","created":"2016-08-03T11:03:20.305Z","0.0.1":"2016-08-03T11:03:20.305Z"},"keywords":["studcloud","notify"],"author":{"name":"AnZuev"},"license":"ISC","readmeFilename":"README.md"}