Email Output (AWS SES)¶
The Email output allows you to send notifications via email using Amazon Simple Email Service (AWS SES). This is useful when you need formal, detailed notifications or when the recipient prefers email communication.
How It Works¶
When you create an Email output, Relaye connects to AWS SES using your credentials. When a notification is sent:
- Relaye formats the message according to your template
- The message is sent to AWS SES for delivery
- AWS SES delivers the email to the specified recipient(s)
- Relaye logs the delivery status
Email outputs support HTML formatting, attachments, and multiple recipients, making them suitable for detailed notifications and reports.
Prerequisites¶
Before setting up an Email output, you need:
- An AWS account
- Access to AWS SES (Simple Email Service)
- Verified sender email address(es) in AWS SES
- Appropriate AWS IAM credentials with SES send permissions
If you're in the AWS SES sandbox environment, you'll also need to verify recipient email addresses.
Setting Up Email Output¶
To set up an Email output:
- Go to the Outputs section
- Click New Output
- Select Email (AWS SES) as the output type
- Enter the following information:
- From Email: The verified sender email address
- To Email: The recipient email address
- Region Name: The AWS region where your SES service is configured
- Access Key ID: Your AWS access key
- Secret Access Key: Your AWS secret key
- Give your output a name (e.g., "Daily Reports")
- Click Save
Handling Attachments¶
If your input includes files or images, they can be sent as email attachments. Relaye automatically processes these and includes them in the outgoing email.
Note
Large attachments might affect delivery time and reliability. Consider linking to files instead of attaching them for large documents.
Setting Email Subject¶
The subject line for emails is automatically generated based on the sender information, but you can influence it through your template. The first line or heading of your template content is often used as part of the subject.
Testing Your Email Output¶
To test your Email output:
- Go to the output's details page
- Click Test
- Relaye will send a test email to the configured recipient
- Check the recipient's inbox to confirm receipt
Common Uses¶
Email outputs are frequently used for:
- Detailed Reports: Send comprehensive reports that need formatting and structure
- Formal Notifications: Deliver notifications that require a formal communication channel
- Scheduled Summaries: Send daily or weekly summaries of events
- Documentation: Deliver documentation or instructions that may need to be referenced later
- Escalation: Provide a backup notification method for critical alerts
Troubleshooting¶
Common Issues¶
AWS Credentials Issues
If you're having trouble with AWS credentials:
- Verify your access key and secret key are correct
- Check that your IAM user has the
ses:SendEmailpermission - Ensure you've selected the correct AWS region
- Verify that your AWS account is active and in good standing
Email Delivery Problems
If emails aren't being delivered:
- Check if your sender email is verified in AWS SES
- If in the SES sandbox, verify recipient emails are also verified
- Check your AWS SES sending quotas and statistics
- Verify that the recipient email address is correct
- Check for bounces or complaints in your AWS SES dashboard
Viewing Email Logs¶
You can view all outgoing email notifications by:
- Going to the Outputs section
- Clicking on your Email output
- Navigating to the Outgoing Logs tab
This will show you all sent emails, their status, and any error messages.
Best Practices¶
- Use a consistent sender email to build recognition
- Include your organization name in the sender email (e.g.,
alerts@yourcompany.com) - Keep email subjects concise and informative
- Use responsive HTML design for better mobile viewing
- Include plain text alternatives for better compatibility
- Use professional formatting and branding
- Include contact information or reply instructions
- Be mindful of email frequency to avoid overwhelming recipients
- Consider time zones when sending non-critical emails