Added docs for the email subdmomain and it's settings

docs/messaging/email-settings.md

@@ -0,0 +1,51 @@
+---
+sidebar_position: 1
+---
+
+# Custom Email Domain
+
+[[API Docs](/api/email-settings#tag/Domains)]
+[[SDK](https://www.npmjs.com/package/@epilot/email-settings-client)]
+[[Setup Docs](https://help.epilot.cloud/hc/de/articles/5573710208412-E-Mail-Konfigurationsmen%C3%BC-im-Detail-epilot-360-#h_01GA1JYMPGHRE0XDCHW9N61G57)]
+
+Epilot not only provides the capability to send emails using our domain but also allows clients to bring their own subdomains. This enables messages to be sent and received via epilot, acting on behalf of your own organization. It is highly recommended that an IT professional from your company, who is well-versed with DNS records, handle this integration.
+
+## Subdomain Delegation:
+While setting up the subdomain, a process known as 'subdomain delegation' is required. With this setup:
+
+- The subdomain will be managed by epilot.
+- Its primary role will be to enable the sending and receiving of emails.
+- This subdomain can be further configured to serve as a dedicated portal for end customers or installers.
+- More on the portal domain setup [here](https://help.epilot.cloud/hc/de/articles/4417739340050-Kundenportal-einrichten-epilot-360-#h_01GC9GHGN6788D2GDVE6H0BVVQ).
+
+## SPF, DMARC, and DKIM Implementation:
+- After the domain is delegated to us, we handle the creation of all the necessary MX & TXT records in our AWS hosted zone. This includes:
+  - SPF (Sender Policy Framework) to specify the servers that are allowed to send email for your domain.
+  - DMARC (Domain-based Message Authentication Reporting and Conformance) to enable reporting and set a policy for email authentication.
+  - DKIM (DomainKeys Identified Mail) to sign emails cryptographically.
+- These protocols assist in verifying the email sender’s identity, which significantly reduces the risk of phishing emails and spam.
+- Further reference can be found in the [AWS documentation](https://docs.aws.amazon.com/ses/latest/dg/email-authentication-methods.html).
+
+## Custom "Mail From" Domain Configuration:
+- Per the [AWS SES guidelines](https://docs.aws.amazon.com/ses/latest/dg/mail-from.html), it is advised to use a different "Mail From" domain than the sender's email address that appears in the actual email.
+- To align with this guidance, we configure the "Mail From" domain to adopt the format mail.${subdomain}.
+- This distinct "Mail From" domain is a best practice that enhances email deliverability and aligns with various email authentication standards.
+
+## Email Transmission Security:
+- SES, by default, ensures the secure transmission of emails using TLS (Transport Layer Security) encryption.
+- This ensures that the contents of the email are secure during transit and are protected from eavesdropping or tampering.
+
+Please note that the actual implementation may require collaboration with your IT department or domain administrator due to the sensitive nature of these configurations.
+
+## Email Receiving
+- We employ SES receipt rules to handle incoming emails. 
+- These rules are configured to direct the emails to separate S3 buckets, organized by tenant. 
+- Subsequently, these emails are processed and structured as message entities along with attachments, which are then organized under their respective parent threads.
+
+# Email Addresses
+
+[[API Docs](/api/email-settings#tag/Settings)]
+[[SDK](https://www.npmjs.com/package/@epilot/email-settings-client)]
+[[Setup Docs](https://help.epilot.cloud/hc/de/articles/5573710208412-E-Mail-Konfigurationsmen%C3%BC-im-Detail-epilot-360-#h_01GA1JYT6TNQ64AJH612WN9J4V)]
+
+With this setting, users have the flexibility to designate a specific email address within their subdomain for both sending and receiving messages.

docs/messaging/email-templates.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 2
 ---
 
 # Email Templates

docs/messaging/message-api.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 2
 ---
 
 # Message API

docs/messaging/template-variables.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 ---
 
 # Template Variables

redoc.config.js

@@ -49,6 +49,11 @@ module.exports.specs = [
     routePath: '/api/permissions',
     specUrl: 'https://docs.api.epilot.io/permissions.yaml',
   },
+  {
+    layout: { title: 'Email Settings API' },
+    routePath: '/api/email-settings',
+    specUrl: 'https://docs.api.epilot.io/email-settings.yaml',
+  },
   {
     layout: { title: 'Message API' },
     routePath: '/api/message',