0 : AUTOMATED CONFIGURATION
=======================================
The steps from 0), 1) and 3) of SEND AN EMAIL VIA AWS SES & SEND A TEMPLATED EMAIL VIA AWS SES can be automatically performed by using this deployment template:
https://console.aws.amazon.com/cloudformation/home?#/stacks/create/review?stackName=BubbleSES&templateURL=https://bubble-resources.s3.amazonaws.com/deployment-assets/CloudFormation-AWSSES.yaml You will find the required parameters values used across the plugin in the "OUTPUT" tab of the created stack.
Steps 2a) or 2b) to validate identifies will still require to be performed manually.
1 : SEND AN EMAIL VIA AWS SES
=======================================
ACTION DESCRIPTION
--------------------------------
SEND AN EMAIL VIA AWS SES composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:
- The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation results in an "Email address not verified" error.
- If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
- The maximum message size is 10 MB.
- The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
STEP-BY-STEP SETUP
--------------------------------
0) Sign-up for AWS SES by following this link:
https://console.aws.amazon.com/ses/home?p=txt&cp=bn&ad=c 1) Set-up AWS SES by following the steps indicated here:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sign-up-for-aws.html Then, either you verify a domain to send an email from any email address belonging to this domain, or a single sender email address at once.
2a) Verify the domain you want to send the email from following this tutorial:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html 2b) Alternatively, you can verify a sender address at once using this tutorial:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html 3) Create your AWS SES API KEY & SECRET and attach the AWS SES FULL ACCESS policy to SendEmail:
https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys 4) Enter in the PLUGIN SETTINGS your AWS SES API KEY & SECRET & AWS SERVICE ENDPOINT REGION (if not provided, the default endpoint is "us-east-1").
5) (Optional) if you are only testing by sending emails to verified adresses or domains) AWS SES only allows you to send emails to other domains/email adresses than the one you verified at setup. In order to send emails to other domains, you need to move from Sandbox to Production mode following this tutorial:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html 6) Set up the action "END AN EMAIL VIA AWS SES" in the workflow.
Inputs Fields :
- TO ADDRESSES : List of recipients to place on the To: line of the message. Use :split by ',' to populate this field using a comma-separated email addresses string.
- CC ADDRESSES : List of recipients to place on the Cc: line of the message. Use :split by ',' to populate this field using a comma-separated email addresses string.
- BCC ADDRESSES : List of recipients to place on the Bcc: line of the message. Use :split by ',' to populate this field using a comma-separated email addresses string.
- SUBJECT : The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
- SENDER ADDRESS : The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide at
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html - REPLY-TO ADDRESSES : List of "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply. Use :split by ',' to populate this field using a comma-separated email addresses string.
- TEXT BODY : The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
- HTML BODY : The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
Output Fields :
- MESSAGE ID : Returns the unique sent-message identifier.
2 : SEND A TEMPLATED EMAIL VIA AWS SES
=======================================
ACTION DESCRIPTION
--------------------------------
SEND A TEMPLATED EMAIL VIA AWS SES composes an email message using an email template and immediately queues it for sending.
To send email using this operation, your call must meet the following requirements:
- The call must refer to an existing email template. You can create email templates using the CREATE AWS SES EMAIL TEMPLATE action.
- The message must be sent from a verified email address or domain.
- If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
- The maximum message size is 10 MB.
- The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address.
- If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
STEP-BY-STEP SETUP
--------------------------------
0) Sign-up for AWS SES by following this link:
https://console.aws.amazon.com/ses/home?p=txt&cp=bn&ad=c 1) Set-up AWS SES by following the steps indicated here:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sign-up-for-aws.html Then, either you verify a domain to send an email from any email address belonging to this domain, or a single sender email address at once.
2a) Verify the domain you want to send the email from following this tutorial:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html 2b) Alternatively, you can verify a sender address at once using this tutorial:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html 3) Create your AWS SES API KEY & SECRET and attach the AWS SES FULL ACCESS policy to SendTemplatedEmail:
https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys 4) Enter in the PLUGIN SETTINGS your AWS SES API KEY & SECRET & AWS SERVICE ENDPOINT REGION (if not provided, the default endpoint is "us-east-1").
5) (Optional) if you are only testing by sending emails to verified adresses or domains) AWS SES only allows you to send emails to other domains/email adresses than the one you verified at setup. In order to send emails to other domains, you need to move from Sandbox to Production mode following this tutorial:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html 6) Set up the action "SEND A TEMPLATED EMAIL VIA AWS SES" in the workflow.
Inputs Fields :
- TO ADDRESSES : List of recipients to place on the To: line of the message. Use :split by ',' to populate this field using a comma-separated email addresses string.
- CC ADDRESSES : List of recipients to place on the Cc: line of the message. Use :split by ',' to populate this field using a comma-separated email addresses string.
- BCC ADDRESSES : List of recipients to place on the Bcc: line of the message. Use :split by ',' to populate this field using a comma-separated email addresses string.
- SENDER ADDRESS : The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide at
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html - REPLY-TO ADDRESSES : List of "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply. Use :split by ',' to populate this field using a comma-separated email addresses string.
- RETURN PATH : The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
- TEMPLATE NAME : The template to use when sending this email.
- TEMPLATE DATA : A list of replacement values to apply to the template. For example, if you set the tag {{name}} in the body and you want to replace it with JohnDoe, you need to enter name = JohnDoe
Output Fields :
- MESSAGE ID : Returns the unique sent-message identifier.
> AWS SES will NOT reject a request wherein the tag replacements in the template fails, resulting in a silent error. Therefore, it is strongly advised to set-up your AWS environment to get failure notification. For more information, please refer to:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html#send-personalized-email-set-up-notifications3 : SEND BULK TEMPLATED EMAILS VIA AWS SES
=======================================
ACTION DESCRIPTION
--------------------------------
SEND BULK TEMPLATED EMAILS VIA AWS SES composes email messages using an email template and immediately queues it for sending.
To send email using this operation, your call must meet the following requirements:
- The call must refer to an existing email template. You can create email templates using the CREATE AWS SES EMAIL TEMPLATE action.
- The message must be sent from a verified email address or domain.
- If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
- The maximum message size is 10 MB.
- The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address.
- If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
STEP-BY-STEP SETUP
--------------------------------
0) Sign-up for AWS SES by following this link:
https://console.aws.amazon.com/ses/home?p=txt&cp=bn&ad=c 1) Set-up AWS SES by following the steps indicated here:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sign-up-for-aws.html Then, either you verify a domain to send an email from any email address belonging to this domain, or a single sender email address at once.
2a) Verify the domain you want to send the email from following this tutorial:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html 2b) Alternatively, you can verify a sender address at once using this tutorial:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html 3) Create your AWS SES API KEY & SECRET and attach the AWS SES FULL ACCESS policy to SendBulkTemplatedEmail:
https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys 4) Enter in the PLUGIN SETTINGS your AWS SES API KEY & SECRET & AWS SERVICE ENDPOINT REGION (if not provided, the default endpoint is "us-east-1").
5) (Optional) if you are only testing by sending emails to verified adresses or domains) AWS SES only allows you to send emails to other domains/email adresses than the one you verified at setup. In order to send emails to other domains, you need to move from Sandbox to Production mode following this tutorial:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html 6) Set up the action "SEND AN EMAIL VIA AWS SES" in the workflow.
Inputs Fields :
- TO ADDRESSES : List of recipients. Each of them will uniquely be placed in the To: line of the message. Use :split by ',' to populate this field using a comma-separated email addresses string.
- CC ADDRESSES : List of recipients to place on the Cc: line of the message. Use :split by ',' to populate this field using a comma-separated email addresses string. This field is common to all messages.
- BCC ADDRESSES : List of recipients to place on the Bcc: line of the message. Use :split by ',' to populate this field using a comma-separated email addresses string. This field is common to all messages.
- SENDER ADDRESS : The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide at
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html. This field is common to all messages.
- REPLY-TO ADDRESSES : List of "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply. Use :split by ',' to populate this field using a comma-separated email addresses string. This field is common to all messages.
- RETURN PATH : The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. This field is common to all messages.
- TEMPLATE NAME : The template to use when sending this email. This field is common to all messages.
- TEMPLATE DATA : A list of replacement values to apply to the template; for example, if you set the tag {{name}} in the body and want to replace it with JohnDoe, enter name = JohnDoe; if a comma-separated list of values is provided, the number of values must match the number of toAddresses, otherwise the replacement variable is assumed global to all messages; to include a literal comma in a value, escape it with a backslash such as \,
- BATCH SIZE : Number of messages to send in a single request to AWS SES. If the number of messages exceeds the batch size, several requests will be made until completion. Minimum value : 0. Maximum value : 50. Defaulting to : 50.
- PAUSE BETWEEN BATCHES : Number of milliseconds between batches. Defaulting to : 1000.
Output Fields :
- MESSAGE ID : Returns the unique sent-message identifier.
> AWS SES will NOT reject a request wherein the tag replacements in the template fails, resulting in a silent error. Therefore, it is strongly advised to set-up your AWS environment to get failure notification. For more information, please refer to:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html#send-personalized-email-set-up-notifications4 : CREATE AWS SES EMAIL TEMPLATE
=======================================
ACTION DESCRIPTION
--------------------------------
CREATE AWS SES EMAIL TEMPLATE creates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation.
These templates include a subject line, and the text and HTML parts of the email body. The subject and body sections may also contain unique values that are personalized for each recipient.
STEP-BY-STEP SETUP
--------------------------------
1) Set up the action "CREATE AWS SES EMAIL TEMPLATE" in the workflow.
Inputs Fields :
- TEMPLATE NAME : The name of the template to create. You will refer to this name when you send email using the "SEND A TEMPLATED EMAIL VIA AWS SES" action.
- SUBJECT : The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
- TEXT BODY : The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
- HTML BODY : The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
5 : UPDATE AWS SES EMAIL TEMPLATE
=======================================
ACTION DESCRIPTION
--------------------------------
UPDATE AWS SES EMAIL TEMPLATE updates an existing email template.
STEP-BY-STEP SETUP
--------------------------------
1) Set up the action "UPDATE AWS SES EMAIL TEMPLATE" in the workflow.
Inputs Fields :
- TEMPLATE NAME : The name of the template to update. You will refer to this name when you send email using the "SEND A TEMPLATED EMAIL VIA AWS SES" action.
- SUBJECT : The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
- TEXT BODY : The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
- HTML BODY : The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
6 : LIST AWS SES EMAIL TEMPLATE
=======================================
ACTION DESCRIPTION
--------------------------------
LIST AWS SES EMAIL TEMPLATE lists the available template names associated with the AWS SES API KEY & SECRET credentials.
STEP-BY-STEP SETUP
--------------------------------
1) Set up the action "LIST AWS SES EMAIL TEMPLATE" in the workflow.
Output Fields :
- TEMPLATE LIST : List of template names.
2) (Optional) Create a RepeatingGroup, use the "Display list" workflow action to populate this RepeatingGroup with the output of the "List AWS SES Templates" you previously set.
3) (Optional) Use this RepeatingGroup to populate for instance a DropDown menu element to select the template.
7 : DELETE AWS SES EMAIL TEMPLATE
=======================================
ACTION DESCRIPTION
--------------------------------
DELETE AWS SES EMAIL TEMPLATE deletes a template associated with the AWS SES API KEY & SECRET credentials.
STEP-BY-STEP SETUP
--------------------------------
1) Set up the action "DELETE AWS SES EMAIL TEMPLATE" in the workflow.
Output Fields :
- TEMPLATE NAME : The name of the template to delete.
IMPLEMENTATION EXAMPLE
======================
Feel free to browse the app editor in the Service URL for an implementation example.
ADDITIONAL INFORMATION
======================
> AWS SES template syntax :
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html#send-personalized-email-create-template > AWS SES quotas & limits :
https://docs.aws.amazon.com/ses/latest/dg/quotas.htmlTROUBLESHOOTING
================
Any plugin related error will be posted to the the Logs tab, "Server logs" section of your App Editor.
Make sure that "Plugin server side output" and "Plugin server side output" is selected in "Show Advanced".
> Server Logs Details:
https://manual.bubble.io/core-resources/bubbles-interface/logs-tab#server-logsPERFORMANCE CONSIDERATIONS
===========================
GENERAL
-------------
The message may not include more than 50 recipients. For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota).
QUESTIONS ?
===========
Contact us at
[email protected] for any additional feature you would require or support question.