Constructor
new Mail(opts)
Creates a mail
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
object | The configuration options. |
Methods
copy(uuid, dstId, newName) → {Promise.<*>}
Copy a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
dstId |
The uuid of the destination folder or record |
|
newName |
The newName of the mail |
Returns:
- Return void
- Type
- Promise.<*>
copy(uuid, dstId, newName) → {Promise.<*>}
Copy a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
dstId |
The uuid of the destination folder or record |
|
newName |
The newName of the mail |
Returns:
- Return void
- Type
- Promise.<*>
createAccount(mailProtocol, mailHost, mailUser, mailPassword, mailFolder, mailMarkSeen, mailMarkDeleted, active) → {Promise.<any>|Promise.<*>}
Create account
Parameters:
| Name | Type | Description |
|---|---|---|
mailProtocol |
The protocol of a mail account. |
|
mailHost |
The server of a mail account |
|
mailUser |
The user of a mail account |
|
mailPassword |
The password of a mail account |
|
mailFolder |
Thye folder of a mail account |
|
mailMarkSeen |
The mark seed of a mail account |
|
mailMarkDeleted |
The mark deleted of a mail account |
|
active |
The active indicates if an account is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>
createAccount(mailProtocol, mailHost, mailUser, mailPassword, mailFolder, mailMarkSeen, mailMarkDeleted, active) → {Promise.<any>|Promise.<*>}
Create account
Parameters:
| Name | Type | Description |
|---|---|---|
mailProtocol |
The protocol of a mail account. |
|
mailHost |
The server of a mail account |
|
mailUser |
The user of a mail account |
|
mailPassword |
The password of a mail account |
|
mailFolder |
Thye folder of a mail account |
|
mailMarkSeen |
The mark seed of a mail account |
|
mailMarkDeleted |
The mark deleted of a mail account |
|
active |
The active indicates if an account is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>
createFilter(order, node, path, grouping, exclusive, active, accountId) → {Promise.<any>|Promise.<*>}
Create Filter
Parameters:
| Name | Type | Description |
|---|---|---|
order |
The order of a filter |
|
node |
The node is a UUID of a Folder or Record |
|
path |
The node is a path of a Folder or Record |
|
grouping |
The grouping group the imported mails. |
|
exclusive |
The exclusive of a filter |
|
active |
The active indicates if a filter is activated |
|
accountId |
The id of a mail account |
Returns:
- Type
- Promise.<any> | Promise.<*>
createFilter(order, node, path, grouping, exclusive, active, accountId) → {Promise.<any>|Promise.<*>}
Create Filter
Parameters:
| Name | Type | Description |
|---|---|---|
order |
The order of a filter |
|
node |
The node is a UUID of a Folder or Record |
|
path |
The node is a path of a Folder or Record |
|
grouping |
The grouping group the imported mails. |
|
exclusive |
The exclusive of a filter |
|
active |
The active indicates if a filter is activated |
|
accountId |
The id of a mail account |
Returns:
- Type
- Promise.<any> | Promise.<*>
createRule(field, operation, value, active, filterId) → {Promise.<any>|Promise.<*>}
Create Rule
Parameters:
| Name | Type | Description |
|---|---|---|
field |
The field can be FROM, TO, SUJECT or CONTENT |
|
operation |
The operation can be CONTAINS or EQUALS |
|
value |
The value of a rule |
|
active |
The active indicates if a rule is activated |
|
filterId |
The id of a filter |
Returns:
- Type
- Promise.<any> | Promise.<*>
createRule(field, operation, value, active, filterId) → {Promise.<any>|Promise.<*>}
Create Rule
Parameters:
| Name | Type | Description |
|---|---|---|
field |
The field can be FROM, TO, SUJECT or CONTENT |
|
operation |
The operation can be CONTAINS or EQUALS |
|
value |
The value of a rule |
|
active |
The active indicates if a rule is activated |
|
filterId |
The id of a filter |
Returns:
- Type
- Promise.<any> | Promise.<*>
delete(uuid) → {Promise.<*>}
Delete a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
Returns:
- Return void
- Type
- Promise.<*>
delete(uuid) → {Promise.<*>}
Delete a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
Returns:
- Return void
- Type
- Promise.<*>
deleteAccount(accountId) → {Promise.<any>|Promise.<*>}
Delete Account
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
The id of an account |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteAccount(accountId) → {Promise.<any>|Promise.<*>}
Delete Account
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
The id of an account |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteFilter(filterId) → {Promise.<any>|Promise.<*>}
Delete Filter
Parameters:
| Name | Type | Description |
|---|---|---|
filterId |
The id of a filter |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteFilter(filterId) → {Promise.<any>|Promise.<*>}
Delete Filter
Parameters:
| Name | Type | Description |
|---|---|---|
filterId |
The id of a filter |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteRule(ruleId) → {Promise.<any>|Promise.<*>}
Delete Rule
Parameters:
| Name | Type | Description |
|---|---|---|
ruleId |
The id of a mail account |
Returns:
- Type
- Promise.<any> | Promise.<*>
deleteRule(ruleId) → {Promise.<any>|Promise.<*>}
Delete Rule
Parameters:
| Name | Type | Description |
|---|---|---|
ruleId |
The id of a mail account |
Returns:
- Type
- Promise.<any> | Promise.<*>
extendedCopy(uuid, dstId, newName, categories, keywords, notes, propertyGroups, wiki, security) → {Promise.<any>|Promise.<(*|never)>}
Extended copy of a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
dstId |
The uuid of the folder or record destination node |
|
newName |
The newName of the new node |
|
categories |
When true copy categories |
|
keywords |
When true copy keywords |
|
notes |
When true copy notes |
|
propertyGroups |
The metadata groups |
|
wiki |
When true copy wiki |
|
security |
When true copy security |
Returns:
Return the properties of a mail
- Type
- Promise.<any> | Promise.<(*|never)>
extendedCopy(uuid, dstId, newName, categories, keywords, notes, propertyGroups, wiki, security) → {Promise.<any>|Promise.<(*|never)>}
Extended copy of a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
dstId |
The uuid of the folder or record destination node |
|
newName |
The newName of the new node |
|
categories |
When true copy categories |
|
keywords |
When true copy keywords |
|
notes |
When true copy notes |
|
propertyGroups |
The metadata groups |
|
wiki |
When true copy wiki |
|
security |
When true copy security |
Returns:
Return the properties of a mail
- Type
- Promise.<any> | Promise.<(*|never)>
getAccounts() → {Promise.<any>|Promise.<(*|never)>}
Get the Accounts of a user
Returns:
Return a list of accounts of a user
- Type
- Promise.<any> | Promise.<(*|never)>
getAccounts() → {Promise.<any>|Promise.<(*|never)>}
Get the Accounts of a user
Returns:
Return a list of accounts of a user
- Type
- Promise.<any> | Promise.<(*|never)>
getAttachments(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the attachments of a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a mail node |
Returns:
Return a list of type Document
- Type
- Promise.<any> | Promise.<(*|never)>
getAttachments(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the attachments of a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a mail node |
Returns:
Return a list of type Document
- Type
- Promise.<any> | Promise.<(*|never)>
getContent(uuid, mailName) → {Promise.<any>|Promise.<*>}
Download mail content
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
mailName |
The name of the mail |
Returns:
- Type
- Promise.<any> | Promise.<*>
getContent(uuid, mailName) → {Promise.<any>|Promise.<*>}
Download mail content
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
mailName |
The name of the mail |
Returns:
- Type
- Promise.<any> | Promise.<*>
getExtractedText(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the Extracted text
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a mail node |
Returns:
Return the text of a document
- Type
- Promise.<any> | Promise.<(*|never)>
getExtractedText(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the Extracted text
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a mail node |
Returns:
Return the text of a document
- Type
- Promise.<any> | Promise.<(*|never)>
getMailsPaginated(offset, limit, context, subject, from, dateFrom, dateTo, attachments, orderColumn, orderAsc) → {Promise.<*>}
Get children nodes
Parameters:
| Name | Type | Description |
|---|---|---|
offset |
The offset of the node query |
|
limit |
The limit of the node query |
|
context |
The context |
|
subject |
Filter the result using subject |
|
from |
vilter by the from email |
|
dateFrom |
Filter by date from |
|
dateTo |
Filter by date to |
|
attachments |
Filter by attachments |
|
orderColumn |
Field used to order the query |
|
orderAsc |
Field used to order ascendant |
Returns:
- Return a list of Nodes
- Type
- Promise.<*>
getMailsPaginated(offset, limit, context, subject, from, dateFrom, dateTo, attachments, orderColumn, orderAsc) → {Promise.<*>}
Get children nodes
Parameters:
| Name | Type | Description |
|---|---|---|
offset |
The offset of the node query |
|
limit |
The limit of the node query |
|
context |
The context |
|
subject |
Filter the result using subject |
|
from |
vilter by the from email |
|
dateFrom |
Filter by date from |
|
dateTo |
Filter by date to |
|
attachments |
Filter by attachments |
|
orderColumn |
Field used to order the query |
|
orderAsc |
Field used to order ascendant |
Returns:
- Return a list of Nodes
- Type
- Promise.<*>
getMessageFromAccounts(accountId, start) → {Promise.<any>|Promise.<(*|never)>}
Get the Mail Server Messages
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
The id of a account |
|
start |
The offset message from accounts |
Returns:
Return a list of Mail Server Messages
- Type
- Promise.<any> | Promise.<(*|never)>
getMessageFromAccounts(accountId, start) → {Promise.<any>|Promise.<(*|never)>}
Get the Mail Server Messages
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
The id of a account |
|
start |
The offset message from accounts |
Returns:
Return a list of Mail Server Messages
- Type
- Promise.<any> | Promise.<(*|never)>
getPdf(uuid, filename) → {Promise.<any>|Promise.<*>}
Download mail as PDF
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
filename |
The name of the PDF document |
Returns:
- Type
- Promise.<any> | Promise.<*>
getPdf(uuid, filename) → {Promise.<any>|Promise.<*>}
Download mail as PDF
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
filename |
The name of the PDF document |
Returns:
- Type
- Promise.<any> | Promise.<*>
getProperties(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the mail properties
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a mail node |
Returns:
Return the properties of a mail
- Type
- Promise.<any> | Promise.<(*|never)>
getProperties(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the mail properties
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a mail node |
Returns:
Return the properties of a mail
- Type
- Promise.<any> | Promise.<(*|never)>
getRules(filterId) → {Promise.<any>|Promise.<(*|never)>}
Get rules of a filter
Parameters:
| Name | Type | Description |
|---|---|---|
filterId |
The id of a Filter |
Returns:
Return a list of rules
- Type
- Promise.<any> | Promise.<(*|never)>
getRules(filterId) → {Promise.<any>|Promise.<(*|never)>}
Get rules of a filter
Parameters:
| Name | Type | Description |
|---|---|---|
filterId |
The id of a Filter |
Returns:
Return a list of rules
- Type
- Promise.<any> | Promise.<(*|never)>
getThumbnail(uuid, type, halfSize) → {Promise.<*>}
Get the thumbnail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
type |
Type of the thumnail |
|
halfSize |
Thumnail halfsize |
Returns:
- Return void
- Type
- Promise.<*>
getThumbnail(uuid, type, halfSize) → {Promise.<*>}
Get the thumbnail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
type |
Type of the thumnail |
|
halfSize |
Thumnail halfsize |
Returns:
- Return void
- Type
- Promise.<*>
importMessages(accountId, messageId) → {Promise.<any>|Promise.<*>}
Import messages
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
The id of an account |
|
messageId |
List the id of a messages |
Returns:
- Type
- Promise.<any> | Promise.<*>
importMessages(accountId, messageId) → {Promise.<any>|Promise.<*>}
Import messages
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
The id of an account |
|
messageId |
List the id of a messages |
Returns:
- Type
- Promise.<any> | Promise.<*>
isValid(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is valid mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is a mail otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
isValid(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is valid mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is a mail otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
move(uuid, dstId) → {Promise.<*>}
Move a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
dstId |
The uuid of the destination folder or record |
Returns:
- Return void
- Type
- Promise.<*>
move(uuid, dstId) → {Promise.<*>}
Move a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
dstId |
The uuid of the destination folder or record |
Returns:
- Return void
- Type
- Promise.<*>
purge(uuid) → {Promise.<any>|Promise.<*>}
Purge folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
Returns:
- Type
- Promise.<any> | Promise.<*>
purge(uuid) → {Promise.<any>|Promise.<*>}
Purge folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
Returns:
- Type
- Promise.<any> | Promise.<*>
rename(uuid, newName) → {Promise.<*>}
Rename a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
newName |
The name of the mail |
Returns:
- Return void
- Type
- Promise.<*>
rename(uuid, newName) → {Promise.<*>}
Rename a mail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
newName |
The name of the mail |
Returns:
- Return void
- Type
- Promise.<*>
savePdf(uuid, newName) → {Promise.<any>|Promise.<*>}
Save document as PDF
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
newName |
The newName of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
savePdf(uuid, newName) → {Promise.<any>|Promise.<*>}
Save document as PDF
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
newName |
The newName of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
sendMailWithAttachments(uuid, content, to, cc, bcc, replyTo, subject, docsId) → {Promise.<any>|Promise.<*>}
Send mail with attachments
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder or record |
|
content |
The content of the email |
|
to |
The list of to |
|
cc |
The list of cc |
|
bcc |
The list of bcc |
|
replyTo |
The list of replyTo |
|
subject |
The subject |
|
docsId |
The documents are sent as attachments in the email |
Returns:
- Type
- Promise.<any> | Promise.<*>
sendMailWithAttachments(uuid, content, to, cc, bcc, replyTo, subject, docsId) → {Promise.<any>|Promise.<*>}
Send mail with attachments
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder or record |
|
content |
The content of the email |
|
to |
The list of to |
|
cc |
The list of cc |
|
bcc |
The list of bcc |
|
replyTo |
The list of replyTo |
|
subject |
The subject |
|
docsId |
The documents are sent as attachments in the email |
Returns:
- Type
- Promise.<any> | Promise.<*>
setDescription(uuid, description) → {Promise.<*>}
Set description
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
description |
The description of the mail |
Returns:
- Return void
- Type
- Promise.<*>
setDescription(uuid, description) → {Promise.<*>}
Set description
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
description |
The description of the mail |
Returns:
- Return void
- Type
- Promise.<*>
setNodeClass(uuid, ncId) → {Promise.<*>}
Set nodeClass
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
ncId |
The nodeClass id |
Returns:
- Return void
- Type
- Promise.<*>
setNodeClass(uuid, ncId) → {Promise.<*>}
Set nodeClass
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the mail |
|
ncId |
The nodeClass id |
Returns:
- Return void
- Type
- Promise.<*>
setRestUrl(restUrl)
Set the rest url
Parameters:
| Name | Type | Description |
|---|---|---|
restUrl |
The rest url |
setRestUrl(restUrl)
Set the rest url
Parameters:
| Name | Type | Description |
|---|---|---|
restUrl |
The rest url |
setTitle(uuid, title) → {Promise.<*>}
Set title
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
title |
The title of the mail |
Returns:
- Return void
- Type
- Promise.<*>
setTitle(uuid, title) → {Promise.<*>}
Set title
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
title |
The title of the mail |
Returns:
- Return void
- Type
- Promise.<*>
setToken(token)
Set the token in Mail variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |
setToken(token)
Set the token in Mail variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |
testConnection(mailProtocol, mailHost, mailUser, mailPassword, mailFolder, mailMarkSeen, mailMarkDeleted, active) → {Promise.<any>|Promise.<*>}
Test connection the of a mail account
Parameters:
| Name | Type | Description |
|---|---|---|
mailProtocol |
The protocol of a mail account. |
|
mailHost |
The server of a mail account |
|
mailUser |
The user of a mail account |
|
mailPassword |
The password of a mail account |
|
mailFolder |
Thye folder of a mail account |
|
mailMarkSeen |
The mark seed of a mail account |
|
mailMarkDeleted |
The mark deleted of a mail account |
|
active |
The active indicates if an account is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>
testConnection(mailProtocol, mailHost, mailUser, mailPassword, mailFolder, mailMarkSeen, mailMarkDeleted, active) → {Promise.<any>|Promise.<*>}
Test connection the of a mail account
Parameters:
| Name | Type | Description |
|---|---|---|
mailProtocol |
The protocol of a mail account. |
|
mailHost |
The server of a mail account |
|
mailUser |
The user of a mail account |
|
mailPassword |
The password of a mail account |
|
mailFolder |
Thye folder of a mail account |
|
mailMarkSeen |
The mark seed of a mail account |
|
mailMarkDeleted |
The mark deleted of a mail account |
|
active |
The active indicates if an account is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateAccount(id, mailProtocol, mailHost, mailUser, mailPassword, mailFolder, mailMarkSeen, mailMarkDeleted, active) → {Promise.<any>|Promise.<*>}
Update account
Parameters:
| Name | Type | Description |
|---|---|---|
id |
The id of a mail account |
|
mailProtocol |
The protocol of a mail account. |
|
mailHost |
The server of a mail account |
|
mailUser |
The user of a mail account |
|
mailPassword |
The password of a mail account |
|
mailFolder |
Thye folder of a mail account |
|
mailMarkSeen |
The mark seed of a mail account |
|
mailMarkDeleted |
The mark deleted of a mail account |
|
active |
The active indicates if an account is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateAccount(id, mailProtocol, mailHost, mailUser, mailPassword, mailFolder, mailMarkSeen, mailMarkDeleted, active) → {Promise.<any>|Promise.<*>}
Update account
Parameters:
| Name | Type | Description |
|---|---|---|
id |
The id of a mail account |
|
mailProtocol |
The protocol of a mail account. |
|
mailHost |
The server of a mail account |
|
mailUser |
The user of a mail account |
|
mailPassword |
The password of a mail account |
|
mailFolder |
Thye folder of a mail account |
|
mailMarkSeen |
The mark seed of a mail account |
|
mailMarkDeleted |
The mark deleted of a mail account |
|
active |
The active indicates if an account is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateFilter(id, order, node, path, grouping, exclusive, active) → {Promise.<any>|Promise.<*>}
Update Filter
Parameters:
| Name | Type | Description |
|---|---|---|
id |
The id of a filter |
|
order |
The order of a filter |
|
node |
The node is a UUID of a Folder or Record |
|
path |
The node is a path of a Folder or Record |
|
grouping |
The grouping group the imported mails. |
|
exclusive |
The exclusive of a filter |
|
active |
The active indicates if a filter is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateFilter(id, order, node, path, grouping, exclusive, active) → {Promise.<any>|Promise.<*>}
Update Filter
Parameters:
| Name | Type | Description |
|---|---|---|
id |
The id of a filter |
|
order |
The order of a filter |
|
node |
The node is a UUID of a Folder or Record |
|
path |
The node is a path of a Folder or Record |
|
grouping |
The grouping group the imported mails. |
|
exclusive |
The exclusive of a filter |
|
active |
The active indicates if a filter is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateRule(id, field, operation, value, active) → {Promise.<any>|Promise.<*>}
Update rule
Parameters:
| Name | Type | Description |
|---|---|---|
id |
The id of a rule |
|
field |
The field can be FROM, TO, SUJECT or CONTENT |
|
operation |
The operation can be CONTAINS or EQUALS |
|
value |
The value of a rule |
|
active |
The active indicates if a rule is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>
updateRule(id, field, operation, value, active) → {Promise.<any>|Promise.<*>}
Update rule
Parameters:
| Name | Type | Description |
|---|---|---|
id |
The id of a rule |
|
field |
The field can be FROM, TO, SUJECT or CONTENT |
|
operation |
The operation can be CONTAINS or EQUALS |
|
value |
The value of a rule |
|
active |
The active indicates if a rule is activated |
Returns:
- Type
- Promise.<any> | Promise.<*>