To use the email notification feature, you must edit the e-mail configuration file (emailsettings.xml).
The configuration file contains the following elements:
§ SmtpHost - SMTP server address.
§ SmtpPort - SMTP Port used by the host.
§ SmtpSsl - Specify whether the SMTP host uses Secure Socket Layer (SSL). This value can be “true” or “false”.
§ SmtpUserName - Name of the account that is sending the e-mail.
§ SmtpPassword - Password for the account that is sending the e-mail.
§ SmtpSender - E-mail address that is listed as the sender in email notifications.
§ SuccessEmailSubject - Subject of an e-mail when a task succeeds.
§ SuccessEmailBody - Body of an e-mail when a task succeeds.
§ FailureEmailSubject - Subject of an e-mail when a task fails.
§ FailureEmailBody - Body of an e-mail when a task fails.
§ MetadataEmailSubject - Subject of an e-mail when a task fails due to metadata changes.
§ MetadataEmailBody - Body of an e-mail when a task fails due to metadata changes.
§ MetadataSuccessEmailSubject - Subject of an e-mail when a task succeeds despite metadata changes.
§ MetadataSuccessEmailBody - Body of an e-mail when a task succeeds despite metadata changes.
u Before you begin:
If you are using Windows Vista or above, you must have administrator rights to be able to modify the configuration file.
u To edit the configuration file:
1. From the Tools menu, select Settings, then Email Configuration. The e-mail configuration file opens in Internet Explorer (IE) or your default XML editor.
2. If the file opens in Internet Explorer, select “Source” from the IE View menu to open the configuration file in Notepad (or your default text editor). If this does not open the file in a writable form, check the address bar of the browser for the file path, locate the file on your disk, and open it manually.
3. Provide values for the SmtpHost, SmtpPort, SmtpSsl, SmtpUserName, SmtpPassword and SmtpSender elements. You may need to replace empty element tags (<element/>) with start and end tags. You must contact the internet service provider for the correct settings If you have upgraded from an older version of RETS Connector, the SmtpPort and SmtpSsl tags must be added. Below are sample settings for a gmail address:
• <SmtpSender> firstname.lastname@example.org </SmtpSender>
4. If desired, you can edit the subject and body settings. RETS Connector supports the use of tokens in these settings (see Tokens).
5. Save your changes to the e-mail configuration file.
6. Restart the RETS Connector Service (see The RETS Connector Monitor).
7. Restart RETS Connector.
Changes to emailsettings.xml affect ALL tasks, not only those that you have created.
u To configure RETS Connector to send e-mail notifications:
1. Edit the e-mail configuration file as necessary.
2. Select one or more of the e-mailing options:
• Email on Success. Sends an e-mail notification when the task executes successfully.
• Email on Failure. Sends an e-mail notification when the task fails.
• Metadata change. Sends an e-mail notification when the task succeeds despite metadata changes.
• Md Change Failure. Sends an e-mail notification when the task fails due to metadata changes.
3. For each e-mailing option you selected, type the e-mail addresses that should receive the notification. Separate multiple addresses with semicolons (;).