# Notifications Tab

The Notifications Tab contains parameters used to control who receives a status email when a non-GUI CopyStorm/Restore job runs and under what circumstances email is sent. CopyStorm/Restore supports email notifications via SMTP or via a Salesforce SOAP API call.

## SFDC Notifications

![](https://2924009365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5FyPmqVkPxhj2oT8fbgB%2Fuploads%2Fgit-blob-fbb7b9c9b3f341be6a1de2cf55eeb1058f128862%2F6bece3c5-RESTOREsfdcEmailNotifications.jpg?alt=media)

| Parameter Name       | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Send Email To        | Yes      | Notification emails will be sent to this white space separated list of email addresses.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Subject              | Yes      | <p>The subject line used for notification emails. Though it can be any text you want, there are a few special text values that will be replaced dynamically before a message is sent:</p><ul><li><p>“{status}” will be replaced by “OK” or “ERROR” based on the outcome of the job.</p><ul><li>If there are any exceptions encountered then “ERROR” will be substituted, otherwise “OK” will be used.</li></ul></li><li>“{application}” will be replaced by “CopyStorm/Restore”.</li><li><p>“{file}” will be replaced by the base name of the CopyStorm/Restore configuration file used by the job.</p><ul><li>For example, the configuration file “C:\capstorm\config\myCopyStormRestoreConfig.copyStormRestore” will be replaced with “myCopyStormRestoreConfig.copyStormRestore”.</li></ul></li></ul> |
| Send Notification On | No       | <p>Determines when CopyStorm/Restore will send a notification email:</p><ul><li>Success: If checked, an email will be sent if a job works perfectly (no exceptions).</li><li>Exception(s): If checked, an email will be sent if a job has any exception (including non-fatal exceptions where CopyStorm/Restore recovered).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Notify Current User  | No       | If checked, the Salesforce User specified on the Main tab of CopyStorm/Restore will be notified in addition to the specified recipients (Send Email To).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

## SMTP Notifications

![](https://2924009365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5FyPmqVkPxhj2oT8fbgB%2Fuploads%2Fgit-blob-5139f0d976219d63bead464f3dd3de5e9c6b4f1f%2F189437ac-RESTOREsmtpEmailNotifications.jpg?alt=media)

| Parameter Name       | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Email Host           | Yes      | The SMTP host used by your organization (used to send email). If you do not know this information ask your email administrator.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Email From           | Yes      | The email address that will appear in the “From” field in sent notifications. Note that many email servers allow this value to be a fake email address (e.g. “<noreply@capstorm.com>”).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Send Email To        | Yes      | Notification emails will be sent to this white space separated list of email addresses.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Subject              | Yes      | <p>The subject line used for notification emails. Though it can be any text you want, there are a few special text values that will be replaced dynamically before a message is sent:</p><ul><li><p>“{status}” will be replaced by “OK” or “ERROR” based on the outcome of the job.</p><ul><li>If there are any exceptions encountered then “ERROR” will be substituted, otherwise “OK” will be used.</li></ul></li><li>“{application}” will be replaced by “CopyStorm/Restore”.</li><li><p>“{file}” will be replaced by the base name of the CopyStorm/Restore configuration file used by the job.</p><ul><li>For example, the configuration file “C:\capstorm\config\myCopyStormRestoreConfig.copyStormRestore” will be replaced with “myCopyStormRestoreConfig.copyStormRestore”.</li></ul></li></ul> |
| Send Notification On | No       | <p>Determines when CopyStorm/Restore will send a notification email:</p><ul><li>Success: If checked, an email will be sent if a job works perfectly (no exceptions).</li><li>Exception(s): If checked, an email will be sent if a job has any exception (including non-fatal exceptions where CopyStorm/Restore recovered).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Require Encryption   | No       | If checked, CopyStorm/Restore will require that connections to the email server be encrypted with TLS.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Email User           | No       | Username used to authenticate with the SMTP server.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Email Password       | No       | Password used to authenticate with the SMTP server.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

## How to Test Email Delivery

The “Test Email Delivery” button causes an email to be sent to the recipient list. If communication to the SMTP email server or target Salesforce org is successful an acknowledgement dialog will be displayed and an email will be delivered to the recipients.

If communication to the SMTP email server or target Salesforce org fails, a dialog will be displayed showing the error. In this case you should show the error to your local administrator.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://learn.capstorm.com/copystorm-restore/reference/notifications-tab.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
