# Mail

FSProtect mail integration enables users to receive email notifications as soon as a scan is completed. Users can include summary reports, full reports, and the results of customized queries as access links in the notification email, providing a quick overview of the scan results. In case a scan fails, an email is sent with the reason for the failure, keeping users informed.

## **Creating New Configuration**

<figure><img src="/files/Eb3mdBNn5X1h4oO4mieq" alt=""><figcaption><p>Mail Integration</p></figcaption></figure>

Tooltip provider that is above and right side on the table allows us to;

* **Export**: Exports all mail configurations and respective information that is listed in this table as a CSV file.
* **New Configuration**: Create a new mail configuration from scratch.

Left-click on the `New Configuration` button redirects the users to the creation page.

### Mandatory Fields

<figure><img src="/files/4J69vU7k9zt39UMAWSSV" alt=""><figcaption><p>Mandatory Values of Mail Configuration</p></figcaption></figure>

**Configuration Name**: Name of the mail configuration.

**Mail Server**: Fully Qualified Domain Name (FQDN) or IP address of the mail server.

**Mail Server Port**: Port number of the mail server.

**Connection Security**: Connection type used to connect to the mail server (e.g. TLS, SSL, None).

**Send Email To**: Receiver list of the notification email.

**Send Summary Report**: Determines whether the summary report access link is attached to the notification email.

**Send Full Report**: Determines whether the full report access link is attached to the notification email.

**Active**: Indicates whether the mail configuration is active.

### Optional Fields

**Email Address**: The sender mail address of the notification mail.

**Email Password**: The password of the sender mail address of the notification mail.

{% hint style="info" %}
When Email Address and Email Password is empty, client will try loging in anonymously to the mail server. For example SMTP Relay servers that authenticates by itself.
{% endhint %}

<figure><img src="/files/qpZRYcxA5lSCdiJ1ysf1" alt=""><figcaption><p>Optional Parameters of Mail Configuration</p></figcaption></figure>

**Use Different Sender**\
Allows specifying a custom sender (“From”) email address.\
If not provided, the authenticated email address is used.

**Send Summary Report**\
Includes the summary report access link in the notification email.

**Send Full Report**\
Includes the full report access link in the notification email.

**New Vulnerabilities**\
Sends notification when new vulnerabilities are detected compared to the previous scheduled scan.

**Fixed Vulnerabilities**\
Sends notification when vulnerabilities are fixed compared to the previous scheduled scan.

**Scheduled Reports Difference**\
Sends notification when scheduled scan results differ from the previous execution.

**Send All Saved Queries**\
Includes results of all saved queries in the notification email.

**Saved Query IDs**\
Specifies which saved queries are included when **Send All Saved Queries** is disabled.

**Scheduled Reports**: Scheduled reports are the built-in or custom-created `Search&Reports` queries. The results of these queries can be added as attachments to allow users to get a quick overview and instant answers to the questions they are curious about.

**Save**: Saves the new configuration to the database.

**Save and Test** (Recommended): Saves the new configuration to the database and sends a confirmation e-mail to validate/verify the configuration.

After `Save`/`Save and Test`, users can see the saved mail configurations.

## Mail Configurations

The table contains the regarding information about the integrated mail servers and allows us to perform operations on these configurations with the help of a three-dot button.

<figure><img src="/files/EyBpaRMtQq1tbanytyka" alt=""><figcaption><p>List of Mail Integrations</p></figcaption></figure>

### Column Info

**Name**: Name of the configuration.

**Mail Server**: Full Qualified Domain Name(FQDN) of the mail server.

**Full Report**: Whether the full report access link is attached to the notification mail.

**Active**: Whether the mail configuration is active.

**Mail To**: The receiver list of the notification mail.

**SMTP Relay** : If **Email Address** and **Email Password** are not provided, FSProtect sends emails using SMTP Relay or anonymous delivery without SMTP authentication.\
This behavior is commonly used with internal or IP-trusted mail servers.

### Operations

Three-dot button on the each row allows us to perform following operations on a mail integration configuration;

**Edit**: Edit the selected mail configuration.

**Delete**: Delete the selected mail configuration.

The following figure is an example of the notification e-mail that sent after the completion of the scan.

![Mail Notification](/files/bAfkfOlRP2jk6xjubdIf)

<figure><img src="/files/EfNLfON930ulMaegCsNL" alt=""><figcaption><p>Mail Failed Notification</p></figcaption></figure>

<figure><img src="/files/calwiryp9L4VkuV2aJlC" alt=""><figcaption><p>Example of Send All Saved Queries</p></figcaption></figure>


---

# 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://docs.forestall.io/fsprotect/integrations/mail.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.