This module is meant handling mailing
- Description:
This module is meant handling mailing
- Source:
Methods
(static) escapedHTMLString(s) → {string}
- Description:
encode string to escape html code
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
s |
string | inputed string |
Returns:
newString new string escaped html code
- Type
- string
(static) getUserFirstName(member) → {string}
- Description:
Gets members first name to use in the email
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
member |
object | member document |
Returns:
value to use as member's first name
- Type
- string
(static) lookup(callback)
- Description:
Lookup host name to use in links
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | callback for result |
(static) sendAutomatedMessageError(member, link)
- Description:
Send email notifying a member about unrecoverable automated message error
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
member |
object | user object |
link |
string | link to use in email |
(static) sendLocalizedMessage(lang, to, subject, message, callback)
- Description:
Send localized email with params
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
lang |
string | locale to use in email (to get values from properties) |
to |
string | where to send email |
subject |
string | Array.<string> | key from localization files to use as subject; array of [key, var0, var1, ...] kind in case the property needs variable substitution |
message |
string | Array.<string> | key from localization files to use as email message; array of [key, var0, var1, ...] kind in case the property needs variable substitution |
callback |
function | function to call when its done |
(static) sendMail(message, callback)
- Description:
Send email with message object
- Source:
Parameters:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message |
object | message object Properties
|
|||||||||||||||
callback |
function | function to call when its done |
(static) sendMessage(to, subject, message, callback)
- Description:
Send email with params
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
to |
string | where to send email |
subject |
string | subject for email |
message |
string | email message |
callback |
function | function to call when its done |
(static) sendPasswordResetInfo(member, prid)
- Description:
Email to send to members when requesting to reset password
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
member |
object | member document |
prid |
string | password reset id |
(static) sendToNewMember(member, memberPassword)
- Description:
Email to send to new members
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
member |
object | member document |
memberPassword |
string | OTP for member to authorize |
(static) sendToNewMemberLink(member, prid)
- Description:
Email to send to new members
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
member |
object | member document |
prid |
string | id for password reset link |
(static) sendToUpdatedMember(member, memberPassword)
- Description:
Email to send to members where global admin updated their password
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
member |
object | member document |
memberPassword |
string | OTP for member to authorize |
(inner) getPluginConfig() → {string}
- Source:
Returns:
email and company name
- Type
- string