See alsoManages simple email functions to send messages, with or without attachments.
WebVue support - Yes.
|
Mode |
Mnemonic |
Syntax |
| 0 | SEND | 1 |
| 1 | ADDPROFILE | 2 |
| 2 | DELPROFILE | 3 |
| 3 | DELALLPROFILES | 4 |
Syntax 1
EMAIL(Mode, EmailProfile, To, Cc, Bcc, Subject, Message [, FileAttachments[, Priority [, MessageFormat[, MessageEncoding]]]] )
Return type: INTEGER.
|
Argument |
Meaning |
|
EmailProfile |
The name of an email profile as configured in Actions.Email.Profiles. The profile provides information such as the outgoing (SMTP) server name. If no profile is specified then the default profile is used. Type STR. |
|
To |
The address of the recipients as a list of semicolon delimited e-mail addresses. Type STR. |
|
Cc |
The address of any carbon copy recipients as a list of semicolon delimited e-mail addresses. Type STR. |
|
Bcc |
The address of the blind carbon copy recipients as a list of semicolon delimited e-mail addresses. Type STR. |
|
Subject |
The e-mail subject line. Type STR. |
|
Message |
The body of the e-mail message. Type STR. |
|
FileAttachments |
A list of semicolon delimited file attachments. Files in the list must be specified with absolute paths. Type Str. The maximum size of an email attachment is 10MB. |
|
Priority |
The priority of the message. Any numeric type. 0 = Normal |
|
MessageFormat |
The format of the body of the e-mail message. Any numeric type. 0 = Plain text |
|
MessageEncoding |
The encoding for the body of the e-mail topic. See the Message Encoding topic. |
Execution
|
Mode |
Mnemonic |
Action |
|
0 |
SEND |
Send an e-mail. Returns 0 if successful, else 1. The sending status is recorded in the system variable. |
Syntax 2
EMAIL(MODE, ProfileName, ProfileDescription, AccountName, AccountDescription, SenderAddress, SenderDisplayName, ReplyToAddress, ServerHost, ServerPort, DeliveryMethod, EncryptionMethod, AuthenticationMode, UserName, UserPassword);
Return type: INTEGER.
|
Argument |
Meaning |
| ProfileName | The name of the profile. Type STR. |
| ProfileDescription | The description of the profile. Type STR. |
| AccountName | The name for the account. Type STR. |
| AccountDescription | The description of the account. Type STR. |
| SenderAddress | The E-mail address that will appear in the From field of the recipient's e-mail client. Type STR. |
| SenderDisplayName | If configured, this will be displayed in the From field of the recipient's message client instead of the source e-mail address. Type STR. |
| ReplyToAddress | E-mail address that will be used by the recipients email client if he chooses to reply to the message. Type STR. |
| ServerHost | The name of the outgoing server. Type STR. If executed in a WebVue session context this instruction is processed by the computer that hosts the web back end. The outgoing server does not need to be reachable from the web clients. |
| ServerPort | The port number for the outgoing server. Any numeric type. |
| DeliveryMethod | A flag indicating the delivery method for the email. 1 via IIS, 0 via network. |
| EncryptionMethod | A flag indicating the encryption method. 1 for SSL, else 0. |
| AuthenticationMode | A flag indication if authentication is required. 1 for authentication, otherwise 0. |
| UserName | The user name if authentication is used. Type STR. |
| UserPassword | The use password if authentication is used. Type STR. |
Execution
|
Mode |
Mnemonic |
Action |
|
1 |
ADDPROFILE |
Add a temporary email profile and account. Returns 1 if successful, else 0 (parameter error). |
Syntax 3
EMAIL(MODE, ProfileName);
Return type: INTEGER.
|
Argument |
Meaning |
| ProfileName | The name of the profile. Type STR. |
Execution
|
Mode |
Mnemonic |
Action |
|
2 |
DELPROFILE |
Delete a temporary email profile and account. Only a profile and account that has been programmatically created can be deleted. Returns 1 if successful, else 0 (parameter error). |
Syntax 4
EMAIL(MODE);
Return type: INTEGER.
Execution
|
Mode |
Mnemonic |
Action |
|
3 |
DELALLPROFILES |
Delete all temporary email profiles and accounts. Only profiles and accounts that have been programmatically created are deleted. Return always 1. |