Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Amazon SES

Least Privileged User

Navigate to the AWS console and create an IAM user with programmatic access. The user will need the following permissions. You can create a policy specifically for these permissions and apply the permissions to the user.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "ses:VerifyEmailIdentity",
        "cloudwatch:GetMetricData",
        "ses:GetIdentityPolicies",
        "ses:GetSendQuota",
        "ses:ListReceiptFilters",
        "ses:GetIdentityMailFromDomainAttributes",
        "ses:VerifyDomainDkim",
        "cloudwatch:ListMetrics",
        "ses:VerifyDomainIdentity",
        "cloudwatch:DescribeAlarmHistory",
        "ses:GetIdentityDkimAttributes",
        "ses:DescribeReceiptRuleSet",
        "cloudwatch:DescribeAlarmsForMetric",
        "ses:ListReceiptRuleSets",
        "ses:ListIdentities",
        "ses:VerifyEmailAddress",
        "ses:GetSendStatistics",
        "ses:GetIdentityVerificationAttributes",
        "ses:GetIdentityNotificationAttributes",
        "cloudwatch:GetMetricStatistics",
        "ses:ListIdentityPolicies",
        "ses:DescribeReceiptRule",
        "ses:DescribeActiveReceiptRuleSet",
        "cloudwatch:DescribeAlarms",
        "ses:ListVerifiedEmailAddresses"
      ],
      "Resource": "*"
    }
  ]
}

Connection Parameters

Name
Required?
Description

Region

Access Key ID

Required

Secret Access Key

Required

Additional Threads

The number of additional threads allowed to be utilized during collection.

Request Timeout (seconds)

The number of seconds to allow for the API to return a response.

Collect CloudWatch Metrics

CloudWatch Historic Mode

If enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.

Metrics

Domain

Name
Description

Behavior On Mail Exchanger Failure

The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email.

Bounce Notifications SNS Topic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.

Complaint Notifications SNS Topic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.

Delivery Notifications SNS Topic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.

DKIM Enabled

True if DKIM signing is enabled for email sent from the Domain; false otherwise.

DKIM Tokens

A set of character strings that represent the Email Addresses's domain's identity.

DKIM Verification Status

Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS.

Email Feedback Forwarding Enabled

Describes whether Amazon SES will forward bounce and complaint notifications as email.

Include Headers In Bounce Notifications

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce.

Include Headers In Complaint Notifications

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint.

Include Headers In Delivery Notifications

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery.

MAIL FROM Domain

The custom MAIL FROM domain that the Domain is configured to use.

MAIL FROM Domain Status

The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup.

Name

Name of the Domain.

Region

The AWS Region this object belongs to.

Verification Status

The verification status of the Domain.

Verification Token

The verification token for a Domain identity.

Email Address

Name
Description

Behavior On Mail Exchanger Failure

The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email.

Bounce Notifications SNS Topic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.

Complaint Notifications SNS Topic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.

Delivery Notifications SNS Topic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.

DKIM Enabled

True if DKIM signing is enabled for email sent from the Email Address; false otherwise.

DKIM Tokens

A set of character strings that represent the Email Addresses's domain's identity.

DKIM Verification Status

Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS.

Email Feedback Forwarding Enabled

Describes whether Amazon SES will forward bounce and complaint notifications as email.

Include Headers In Bounce Notifications

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce.

Include Headers In Complaint Notifications

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint.

Include Headers In Delivery Notifications

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery.

MAIL FROM Domain

The custom MAIL FROM domain that the Email Address is configured to use.

MAIL FROM Domain Status

The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup.

Name

Name of the Email Address.

Region

The AWS Region this object belongs to.

Verification Status

The verification status of the Email Address.

Email Service

Name
Description

Account Sending Enabled

Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.

Bounced Emails

The recipient's mail server permanently rejected the email. This event corresponds to hard bounces; soft bounces are included only when Amazon SES fails to deliver the email after retrying for a period of time.

Clicked Emails

The recipient clicked a link in the email. Only click events from HTML emails are tracked.

Complaint Emails

The recipient marked the email as spam.

Delivered Emails

Amazon SES successfully delivered the email to the recipient's mail server.

Email Reputation Bounce Rate (%)

The percentage of messages sent from your account that bounced. Only hard bounces are considered in this calculation.

Email Reputation Complaint Rate (%)

The percentage of messages sent from your account that were reported by their recipients as spam.

Emails Sent Over Last Day

The number of emails sent during the previous 24 hours.

Emails Sent Quota Per Day

The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.

Maximum Send Rate (per Second)

The maximum number of emails that Amazon SES can accept from the user's account per second.

Opened Emails

The recipient opened an email. Only open events from HTML emails are tracked.

Region

The AWS Region this object belongs to.

Sent Emails

Amazon SES accepted the email and attempted to send it. This value may be distinct from the Delivery metric, because messages could bounce or be rejected.