Add support for smtp credentials, email sender, and suppressions

Add support for email sender and email suppressions
Add TOC for email and smtp resources
Add example for TXT record for email delivery
Add support for singular datasources for email suppression and sender
Fix handling of time created in inputs for datasource

Author: kilokahn

CHANGELOG.md

@@ -3,7 +3,10 @@ All notable changes to this project are documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
-## 2.1.14 - 2018-07-xx
+## 2.1.14 - 2018-07-12
+
+### Added
+- Ability to create and manage email approved senders, suppressions, and smtp credentials
 
 ### Changed
 - Default timeout changed from 5 minutes to 15 minutes to accommodate more resources that don't time out quicker.

docs/Table of Contents.md

@@ -49,6 +49,9 @@ This lists all of the available OCI resources and/or data sources.
 * **DNS**
     * [Records](https://github.com/oracle/terraform-provider-oci/tree/master/docs/dns/records.md)
     * [Zones](https://github.com/oracle/terraform-provider-oci/tree/master/docs/dns/zones.md)
+* **Email**
+    * [Senders](https://github.com/oracle/terraform-provider-oci/tree/master/docs/email/senders.md)
+    * [Suppressions](https://github.com/oracle/terraform-provider-oci/tree/master/docs/email/suppressions.md)
 * **File Storage**
     * [Exports](https://github.com/oracle/terraform-provider-oci/blob/master/docs/file_storage/exports.md)
     * [Export Sets](https://github.com/oracle/terraform-provider-oci/blob/master/docs/file_storage/export_sets.md)
@@ -69,6 +72,7 @@ This lists all of the available OCI resources and/or data sources.
     * [Region Subscriptions](https://github.com/oracle/terraform-provider-oci/tree/master/docs/identity/region_subscriptions.md)
     * [Regions](https://github.com/oracle/terraform-provider-oci/tree/master/docs/identity/regions.md)
     * ~~[Swift Passwords](https://github.com/oracle/terraform-provider-oci/tree/master/docs/identity/swift_passwords.md)~~ [DEPRECATED]
+    * [Smtp Credentials](https://github.com/oracle/terraform-provider-oci/tree/master/docs/identity/smtp_credentials.md)
     * [Tag Namespaces](https://github.com/oracle/terraform-provider-oci/tree/master/docs/identity/tag_namespaces.md)
     * [Tags](https://github.com/oracle/terraform-provider-oci/tree/master/docs/identity/tags.md)
     * [Tenancies](https://github.com/oracle/terraform-provider-oci/tree/master/docs/identity/tenancies.md)

docs/email/senders.md

@@ -0,0 +1,96 @@
+# oci_email_sender
+
+## Sender Resource
+
+### Sender Reference
+
+The following attributes are exported:
+
+* `email_address` - The email address of the sender.
+* `id` - The unique OCID of the sender.
+* `is_spf` - Value of the SPF field. For more information about SPF, please see [SPF Authentication](https://docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/emaildeliveryoverview.htm#spf). 
+* `state` - The current status of the approved sender.
+* `time_created` - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339. 
+
+
+
+### Create Operation
+Creates a sender for a tenancy in a given compartment.
+
+The following arguments are supported:
+
+* `compartment_id` - (Required) The OCID of the compartment that contains the sender.
+* `email_address` - (Required) The email address of the sender.
+
+
+### Update Operation
+
+
+The following arguments support updates:
+* NO arguments in this resource support updates
+
+** IMPORTANT **
+Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
+
+### Example Usage
+
+```hcl
+resource "oci_email_sender" "test_sender" {
+	#Required
+	compartment_id = "${var.compartment_id}"
+	email_address = "${var.sender_email_address}"
+}
+```
+
+
+## Sender Singular DataSource
+
+
+### Get Operation
+Gets an approved sender for a given `senderId`.
+
+The following arguments are supported:
+
+* `sender_id` - (Required) The unique OCID of the sender.
+
+
+### Example Usage
+
+```hcl
+data "oci_email_sender" "test_sender" {
+	#Required
+	sender_id = "${var.sender_sender_id}"
+}
+```
+# oci_email_senders
+
+## Sender DataSource
+
+Gets a list of senders.
+
+### List Operation
+Gets a collection of approved sender email addresses and sender IDs.
+
+The following arguments are supported:
+
+* `compartment_id` - (Required) The OCID for the compartment.
+* `email_address` - (Optional) The email address of the approved sender.
+* `state` - (Optional) The current state of a sender.
+
+
+The following attributes are exported:
+
+* `senders` - The list of senders.
+
+### Example Usage
+
+```hcl
+data "oci_email_senders" "test_senders" {
+	#Required
+	compartment_id = "${var.compartment_id}"
+
+	#Optional
+	email_address = "${var.sender_email_address}"
+	state = "${var.sender_state}"
+}
+```

docs/email/suppressions.md

@@ -0,0 +1,102 @@
+# oci_email_suppression
+
+## Suppression Resource
+
+### Suppression Reference
+
+The following attributes are exported:
+
+* `email_address` - The email address of the suppression.
+* `id` - The unique OCID of the suppression.
+* `reason` - The reason that the email address was suppressed. For more information on the types of bounces, see [Suppresion List](https://docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/emaildeliveryoverview.htm#suppressionlist).
+* `time_created` - The date and time a recipient's email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339. 
+
+
+
+### Create Operation
+Adds recipient email addresses to the suppression list for a tenancy.
+
+
+The following arguments are supported:
+
+* `compartment_id` - (Required) The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID. 
+* `email_address` - (Required) The recipient email address of the suppression.
+
+
+### Update Operation
+
+
+The following arguments support updates:
+* NO arguments in this resource support updates
+
+** IMPORTANT **
+Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
+
+### Example Usage
+
+```hcl
+resource "oci_email_suppression" "test_suppression" {
+	#Required
+	compartment_id = "${var.tenancy_ocid}"
+	email_address = "${var.suppression_email_address}"
+}
+```
+
+
+## Suppression Singular DataSource
+
+
+### Get Operation
+Gets the details of a suppressed recipient email address for a given
+`suppressionId`. Each suppression is given a unique OCID.
+
+
+The following arguments are supported:
+
+* `suppression_id` - (Required) The unique OCID of the suppression.
+
+
+### Example Usage
+
+```hcl
+data "oci_email_suppression" "test_suppression" {
+	#Required
+	suppression_id = "${var.suppression_suppression_id}"
+}
+```
+# oci_email_suppressions
+
+## Suppression DataSource
+
+Gets a list of suppressions.
+
+### List Operation
+Gets a list of suppressed recipient email addresses for a user. The
+`compartmentId` for suppressions must be a tenancy OCID. The returned list
+is sorted by creation time in descending order.
+
+The following arguments are supported:
+
+* `compartment_id` - (Required) The OCID for the compartment.
+* `email_address` - (Optional) The email address of the suppression.
+* `time_created_greater_than_or_equal_to` - (Optional) Search for suppressions that were created within a specific date range, using this parameter to specify the earliest creation date for the returned list (inclusive). Specifying this parameter without the corresponding `timeCreatedLessThan` parameter will retrieve suppressions created from the given `timeCreatedGreaterThanOrEqualTo` to the current time, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.  **Example:** 2016-12-19T16:39:57.600Z 
+* `time_created_less_than` - (Optional) Search for suppressions that were created within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding `timeCreatedGreaterThanOrEqualTo` parameter will retrieve all suppressions created before the specified end date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.  **Example:** 2016-12-19T16:39:57.600Z 
+
+
+The following attributes are exported:
+
+* `suppressions` - The list of suppressions.
+
+### Example Usage
+
+```hcl
+data "oci_email_suppressions" "test_suppressions" {
+	#Required
+	compartment_id = "${var.tenancy_ocid}"
+
+	#Optional
+	email_address = "${var.suppression_email_address}"
+	time_created_greater_than_or_equal_to = "${var.suppression_time_created_greater_than_or_equal_to}"
+	time_created_less_than = "${var.suppression_time_created_less_than}"
+}
+```

docs/examples/email/dns.tf

@@ -0,0 +1,28 @@
+// Configure a DNS that has the TXT record to setup the SPF for the email
+resource "oci_dns_zone" "zone1" {
+  compartment_id = "${var.tenancy_ocid}"
+  name = "tf-example-primary.oci-email-dns"
+  zone_type = "PRIMARY"
+}
+
+resource "oci_dns_record" "record-txt" {
+  zone_name_or_id = "${oci_dns_zone.zone1.name}"
+  rtype = "TXT"
+  rdata = "v=spf1 include:spf.oracleemaildelivery.com -all"
+  domain = "${oci_dns_zone.zone1.name}"
+  ttl = 86400
+}
+
+data "oci_dns_records" "records" {
+  zone_name_or_id = "${oci_dns_zone.zone1.name}"
+
+  # optional
+  compartment_id = "${var.tenancy_ocid}"
+  domain = "${oci_dns_zone.zone1.name}"
+  sort_by = "rtype" # domain|rtype|ttl
+  sort_order = "DESC" # ASC|DESC
+}
+
+output "dns_records" {
+  value = "${data.oci_dns_records.records.records}"
+}

docs/examples/email/env-vars

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+### Authentication details
+export TF_VAR_tenancy_ocid="<tenancy OCID>"
+export TF_VAR_user_ocid="<user OCID>"
+export TF_VAR_fingerprint="<PEM key fingerprint>"
+export TF_VAR_private_key_path="<path to the private key that matches the fingerprint above>"
+
+### Region
+export TF_VAR_region="<region in which to operate, example: us-ashburn-1, us-phoenix-1>"
+
+### Compartment
+export TF_VAR_compartment_ocid="<compartment OCID>"
+
+### Public/private keys used on the instance
+export TF_VAR_ssh_public_key=$(cat <path to public key>)
+export TF_VAR_ssh_private_key=$(cat <path to private key>)
+## NOTE: These are not your api keys. More info on the right keys see
+## https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/managingkeypairs.htm

docs/examples/email/provider.tf

@@ -0,0 +1,20 @@
+/*
+ * This example file shows how to configure the oci provider to target the a single region.
+ */
+
+// These variables would commonly be defined as environment variables or sourced in a .env file
+variable "tenancy_ocid" {}
+variable "user_ocid" {}
+variable "fingerprint" {}
+variable "private_key_path" {}
+variable "compartment_ocid" {}
+variable "region" { default = "us-ashburn-1" }
+
+
+provider "oci" {
+  region = "${var.region}"
+  tenancy_ocid = "${var.tenancy_ocid}"
+  user_ocid = "${var.user_ocid}"
+  fingerprint = "${var.fingerprint}"
+  private_key_path = "${var.private_key_path}"
+}

docs/examples/email/senders.tf

@@ -0,0 +1,30 @@
+variable "sender_email_address" { default = "[email protected]" }
+variable "sender_state" { default = "ACTIVE" }
+
+
+resource "oci_email_sender" "test_sender" {
+  #Required
+  compartment_id = "${var.compartment_ocid}"
+  email_address = "${var.sender_email_address}"
+  timeouts {
+    create = "10m"
+  }
+}
+
+data "oci_email_senders" "test_senders" {
+  #Required
+  compartment_id = "${var.compartment_ocid}"
+
+  #Optional
+  email_address = "${var.sender_email_address}"
+  state = "${var.sender_state}"
+
+  filter {
+    name = "id"
+    values = ["${oci_email_sender.test_sender.id}"]
+  }
+}
+
+output "emailSenders" {
+  value = "${data.oci_email_senders.test_senders.senders}"
+}

docs/examples/email/suppressions.tf

@@ -0,0 +1,28 @@
+variable "suppression_email_address" { default = "[email protected]" }
+variable "suppression_time_created_greater_than_or_equal_to" { default = "2018-01-01T00:00:00.000Z" }
+variable "suppression_time_created_less_than" { default = "2038-01-01T00:00:00.000Z" }
+
+resource "oci_email_suppression" "test_suppression" {
+  #Required
+  compartment_id = "${var.tenancy_ocid}"
+  email_address = "${var.suppression_email_address}"
+}
+
+data "oci_email_suppressions" "test_suppressions" {
+  #Required
+  compartment_id = "${var.tenancy_ocid}"
+
+  #Optional
+  email_address = "${var.suppression_email_address}"
+  time_created_greater_than_or_equal_to = "${var.suppression_time_created_greater_than_or_equal_to}"
+  time_created_less_than = "${var.suppression_time_created_less_than}"
+
+  filter {
+    name = "id"
+    values = ["${oci_email_suppression.test_suppression.id}"]
+  }
+}
+
+output "emailSuppressions" {
+  value = "${data.oci_email_suppressions.test_suppressions.suppressions}"
+}

docs/examples/identity/user.tf

@@ -67,7 +67,7 @@ resource "oci_identity_customer_secret_key" "customer-secret-key1" {
 }
 
 data "oci_identity_customer_secret_keys" "customer-secret-keys1" {
-  user_id = "${oci_identity_user.user1.id}"
+  user_id = "${oci_identity_customer_secret_key.customer-secret-key1.user_id}"
 }
 
 output "customer-secret-key" {
@@ -76,3 +76,19 @@ output "customer-secret-key" {
     "${data.oci_identity_customer_secret_keys.customer-secret-keys1.customer_secret_keys}"
   ]
 }
+
+resource "oci_identity_smtp_credential" "smtp-credential-1" {
+  description = "tf-example-smtp-credential"
+  user_id = "${oci_identity_user.user1.id}"
+}
+
+data "oci_identity_smtp_credentials" "smtp-credentials-1" {
+  user_id = "${oci_identity_smtp_credential.smtp-credential-1.user_id}"
+}
+
+output "smtp-credential" {
+  value = [
+    "${oci_identity_smtp_credential.smtp-credential-1.password}",
+    "${data.oci_identity_smtp_credentials.smtp-credentials-1.smtp_credentials}",
+  ]
+}