SMTP (using AWS SES)

SMTP service provided by Amazon Simple Email Service (SES)

• Documentation
• Support
• Catalog Metadata ID: b90ace67-954b-4b33-8f84-95cacc55b94c
• Tags: aws, ses, preview
• Service Name: datagov-smtp
• Provider Display Name : ``

Provisioning

Request Parameters

• region string - The region of the SES service. Default: ${config("aws.default_region")}.
  • The value must be one of: [ap-east-1 ap-northeast-1 ap-northeast-2 ap-northeast-3 ap-south-1 ap-southeast-1 ap-southeast-2 ca-central-1 cn-north-1 cn-northwest-1 eu-central-1 eu-north-1 eu-west-1 eu-west-2 eu-west-3 me-south-1 sa-east-1 us-east-1 us-east-2 us-gov-west-1 us-west-1 us-west-2].
• domain string - Domain to send mail from Default: ``.
• email_receipt_error string - Email to recieve DMARC errors Default: datagovhelp@gsa.gov.
• enable_feedback_notifications boolean - Flag to toggle creation of SNS topics for feedback notifications Default: false.
• mail_from_subdomain string - Subdomain to use as sending email server Default: ``.

Binding

Request Parameters

• source_ips array - IP Ranges that requests to SES must come from Default: [52.222.122.97/32 52.222.123.172/32].
• notification_webhook string - HTTPS endpoint to subscribe to feedback notifications Default: ``.

Response Parameters

• region string - AWS region for the SES instance
• required_records object - If a domain was supplied, the records to be created in that zone
• email_receipt_error string - Email to recieve DMARC errors
• instructions string - Any further steps are needed before using the service.
• domain_arn string - Instance SES domain identity (used when creating bindings)
• bounce_topic_arn string - ARN of the SNS topic receiving bounce feedback notifications
• complaint_topic_arn string - ARN of the SNS topic receiving complaint feedback notifications
• delivery_topic_arn string - ARN of the SNS topic receiving delivery feedback notifications
• smtp_server string - SMTP server
• smtp_user string - SMTP user and AWS Access Key ID
• smtp_password string - SMTP password
• secret_access_key string - AWS Secret Access Key
• notification_webhook string - Subscribed endpoint for email feedback notifications

Plans

The following plans are built-in to the Cloud Service Broker and may be overridden or disabled by the broker administrator.

• base
  • Plan ID: dc109a6e-c4a8-4fbb-8c49-acf9740ab819.
  • Description: Provision SMTP credentials to use for sending transactional mail from your application
  • This plan doesn't override user variables on provision.
  • This plan doesn't override user variables on bind.

Examples

smtp

SMTP base Uses plan: dc109a6e-c4a8-4fbb-8c49-acf9740ab819.

Provision

{}

Bind

{}

Cloud Foundry Example

$ cf create-service datagov-smtp base my-datagov-smtp-example -c `{}`
$ cf bind-service my-app my-datagov-smtp-example -c `{}`

---