E-Mail Context Reference
E-mail module adds the following entities to Iotellect Server context tree.
Root Context
The following actions are added to Root context:
Send Email
This Call Function instructs Iotellect Server to send an email message.
Action Type: | |
Action Name: | sendMail |
Action Group: | Advanced Actions |
Permissions: | Accessible at Administrator permission level |
Check Incoming Mail
This Call Function forces Iotellect Server to fetch mail from an incoming mail server.
Action Type: | |
Action Name: | checkMail |
Permissions: | Accessible at Engineer permission level |
Action Group: | Advanced Actions |
Utilities Context
The following functions are added to Utilities context:
Check Mail
Instructs Iotellect Server to fetch and process incoming e-mail messages.
Function Name: | checkMail |
Permissions: | Accessible at Engineer permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format: | none |
Get Incoming Mail
Get list of incoming e-mail messages. Works only with POP3 mail servers.
Function Name: | getMail | ||
Permissions: | Accessible at Engineer permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
---|---|---|---|
address | String | Incoming e-mail server address (IP or host name of POP3 server). | |
username | String | Incoming e-mail server username (login). | |
password | String | Incoming e-mail server password. | |
properties | DataTable | Advanced Mail Settings table. | |
Output Records: | 0...unlimited | ||
Output Format: | Name | Type | Description |
sender | String | The e-mail and optionally the name of the message author. | |
subject | String | Message subject. | |
text | String | Message text. | |
headers | DataTable | List of e-mail headers. | |
attachments | DataTable | List of e-mail attachments. | |
to | DataTable | List of recipients. | |
cc | DataTable | Carbon Copy recipients list. | |
bcc | DataTable | Blind Carbon Copy recipients list. |
Send EMail
Sends an email. This function will work properly only if mail sending is properly set up in server global configuration.
Function Name: | sendMail | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
---|---|---|---|
recipients | String | Comma-separated list of email recipients. | |
subject | String | Message subject. | |
message | String | Message text. | |
html | Boolean | Indicates that message text is in HTML format. | |
attachments | DataTable | DataTable with two fields: name (String) and data (Data), contains list of attachments | |
Output Records: | 0 | ||
Output Format: | None |
Was this page helpful?