Add AWS SES docs

Signed-off-by: Paolo Di Tommaso <[email protected]>
nextflow-io · Oct 13, 2023 · b83e714 · b83e714
1 parent ef53026
commit b83e714
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs/config.md b/docs/config.md
@@ -1588,6 +1588,12 @@ The following environment variables control the configuration of the Nextflow ru
   :::
 : Disables the requirement for Wave service when enabling the Fusion file system.
 
+`NXF_ENABLE_AWS_SES`
+: :::{versionadded} 23.06.0-edge
+  :::
+: Enable to use of AWS SES native API for sending emails in place of legacy SMTP settings (default: `false`)
+
+
 `NXF_ENABLE_FS_SYNC`
 : :::{versionadded} 23.10.0
   :::

diff --git a/docs/mail.md b/docs/mail.md
@@ -130,6 +130,23 @@ mail {
 
 See the {ref}`mail scope <config-mail>` section to learn more the mail server configuration options.
 
+### AWS SES configuration
+
+As of version `23.06.0-edge` Nextflow supports [AWS SES](https://aws.amazon.com/ses/) native API as an alternative
+provider to send emails in place of SMTP server.
+
+To enable this feature add the following environment variable in the launching environment:
+
+```
+export NXF_ENABLE_AWS_SES=true
+```
+
+Make also sure to add the following AWS IAM permission to the AWS user (or role) used to launch the pipeline execution:
+
+```
+ses:SendRawEmail
+```
+
 ## Mail notification
 
 You can use the `sendMail` function with a {ref}`workflow completion handler <metadata-completion-handler>` to notify the completion of a workflow completion. For example: