Sends an email using the SMTP protocol.
Syntax
Result = SRP_Send_Mail(Message, Config)
Returns
If the email sends successfully, then 1 is return. If the email cannot be sent, then a string describing the error is returned.
Parameters
| Parameter | Description |
|---|---|
| Message | The email information |
| Config | The settings for how the email will be sent |
Remarks
The first parameter describes the contents and destination of the email. It has the following structure:
| Field | Name | Description |
|---|---|---|
| <1> | Subject | The text to appear the subject line of the email |
| <2> | From | The email address of the sender. To pass name with email, use format name(email). You cannot leave this blank. |
| <3> | To | A comma delimited list of destination email addresses. To pass name with email, use format name(email). There must be at least one email here. |
| <4> | Cc | A comma delimited list of carbon-copy email addresses. To pass name with email, use format name(email). |
| <5> | Bcc | A comma delimited list of blind carbon-copy email addresses. To pass name with email, use format name(email). |
| <6> | Reply To | A single email address to which replies will be sent. Passing name with email not supported. If blank, replies will be sent to the email address in the From field |
| <7> | Body Type | If the body contains HTML tags, set this to "HTML." If not, leave this field blank or set it to "TEXT" |
| <8> | Body | The email content |
| <9> | Attachments | An @VM delimited list of paths to files to be attached. (Full paths only. No relative paths) |
| <10> | Importance | The email's importance level. Set this field to one of three values: SRPMail_Importance_Low$, SRPMail_Importance_Normal$, or SRPMail_Importance_High$ |
| <11> | Read Receipt Request | Requests a read receipt when set to 1. |
| <12> | Delivery Confirmation Requested | Requests confirmation that your email was delivered when set to 1. |
The second parameter establishes the SMTP server to be used and how to connect to it. It has the following structure:
| Field | Name | Description |
|---|---|---|
| <1> | Send Using | If the SMTP server you want to use is directly on your machine, set this to SendUsing_Pickup$. If, like most people, your SMTP server is on a network or remote location, use SendUsing_Port$. Deprecated. As of 2.0 this field is ignored and pickup directories are no longer supported. |
| <2> | Server Directory | If you specified SendUsing_Pickup$, then set this field to the directory location of the local SMTP server. |
| <3> | Server Port | If you specified SendUsing_Port$, then set this field to the SMTP service port. (The default SMTP service port is 25). |
| <4> | SMTP Server | If you specified SendUsing_Port$, then set this field to the SMTP server name or IP address. (For example: mail.mydomain.com) |
| <5> | Authenticate | This field specifies the authentication mechanism to be used. For now, always set this to 1. |
| <6> | Username | Your email account's username |
| <7> | Password | Your email account's password |
| <8> | Use SSL/TLS | Set this field to "SSL" if you need the email transported using the SSL protocol or "TLS" for the TLS protocol. If you set this to "1", then the protocol will be SSL if the port is 465 or TLS otherwise. Set it to 0 or leave it blank if neither protocol is needed. |
If you set the Send Using field to SendUsing_Port$, then set the SMTP Server field to an IP address rather than a server name for better results.
Example
$insert SRPMAIL_INSERTS Config = "" Config<1> = SendUsing_Port$ Config<3> = 25 Config<4> = "mymail.somedomain.com" Config<5> = 1 Config<6> = "myusername" Config<7> = "password" Config<8> = 0 Message = "" Message<1> = "Subject Line" Message<2> = "myemail@somedomain.com" Message<3> = "myfriend@somedomain.com" Message<4> = "" Message<5> = "" Message<6> = "" Message<7> = "TEXT" Message<8> = "Hello World!" Message<9> = "" Message<10> = SRPMail_Importance_Normal$ rv = SRP_Send_Mail(Message, Config)
