Email: Dkim¶

Manage OCI Email Delivery resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.

Resource Snapshot¶

Field	Value
Service	`email`
Resource	`Dkim`
API Version	`email.oracle.com/v1beta1`
Package	Email
Support Status	Preview
Latest Released Version	`v2.1.0-alpha`
Install Namespace	`oci-service-operator-email-system`

Quick Links¶

Resource Guide Index
Setup Guide
Package Page
API Reference
Spec Reference
Status Reference
Rendered Sample (config/samples/email_v1beta1_dkim.yaml)

Spec Fields¶

This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.

Field	Description	Type	Required
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`	`map[string, map[string, string]]`	No
`description`	A string that describes the details about the DKIM. It does not have to be unique, and you can change it. Avoid entering confidential information.	`string`	No
`emailDomainId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the EmailDomain for this DKIM.	`string`	Yes
`freeformTags`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`	`map[string, string]`	No
`name`	The DKIM selector. This selector is required to be globally unique for this email domain. If you do not provide the selector, we will generate one for you. If you do provide the selector, we suggest adding a short region indicator to differentiate from your signing of emails in other regions you might be subscribed to. Selectors limited to ASCII characters can use alphanumeric, dash ("-"), and dot (".") characters. Non-ASCII selector names should adopt IDNA2008 normalization (RFC 5891-5892). Avoid entering confidential information. Example: `mydomain-phx-20210228`	`string`	No
`privateKey`	The DKIM RSA Private Key in Privacy-Enhanced Mail (PEM) format. It is a text-based representation of the private key used for signing email messages.	`string`	No

Status Fields¶

This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.

Field	Description	Type	Required
`cnameRecordValue`	The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).	`string`	No
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains this DKIM.	`string`	No
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`	`map[string, map[string, string]]`	No
`description`	The description of the DKIM. Avoid entering confidential information.	`string`	No
`dnsSubdomainName`	The name of the DNS subdomain that must be provisioned to enable email recipients to verify DKIM signatures. It is usually created with a CNAME record set to the cnameRecordValue.	`string`	No
`emailDomainId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the email domain that this DKIM belongs to.	`string`	No
`freeformTags`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`	`map[string, string]`	No
`id`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DKIM.	`string`	No
`isImported`	Indicates whether the DKIM was imported.	`boolean`	No
`keyLength`	Length of the RSA key used in the DKIM.	`integer`	No
`lifecycleDetails`	A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.	`string`	No
`lifecycleState`	The current state of the DKIM.	`string`	No
`name`	The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.	`string`	No
`status`	-	`object`	Yes
`systemTags`	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No
`timeCreated`	The time the DKIM was created. Times are expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z`	`string`	No
`timeUpdated`	The time of the last change to the DKIM configuration, due to a state change or an update operation. Times are expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ".	`string`	No
`txtRecordValue`	The DNS TXT record value to provision to the DKIM DNS subdomain in place of using a CNAME record. This is used in cases where a CNAME cannot be used, such as when the cnameRecordValue would exceed the maximum length for a DNS entry. You can also use this if you have an existing procedure to directly provision TXT records for DKIM. Many DNS APIs require you to break this string into segments of fewer than 255 characters.	`string`	No

Sample Manifest¶

This example is generated from the checked-in sample manifest at config/samples/email_v1beta1_dkim.yaml. Replace placeholder values before applying it.

Open the rendered sample page

#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#

apiVersion: email.oracle.com/v1beta1
kind: Dkim
metadata:
  name: dkim-sample
spec: {}