Email: EmailDomain¶
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 | EmailDomain |
| API Version | email.oracle.com/v1beta1 |
| Package | |
| 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_emaildomain.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 |
|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this email domain. | string |
Yes |
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 domain. It does not have to be unique, and you can change it. Avoid entering confidential information. | string |
No |
domainVerificationId |
Id for Domain in Domain Management (under governance) if DOMAINID verification method used. | 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 |
name |
The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 (https://tools.ietf.org/html/rfc5321#section-4.1.2) Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892). | string |
Yes |
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 |
|---|---|---|---|
activeDkimId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DKIM key that will be used to sign mail sent from this email domain. | string |
No |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains this email domain. | 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 an email domain. | string |
No |
domainVerificationId |
Id for Domain in Domain Management (under governance) if DOMAINID verification method used. | string |
No |
domainVerificationStatus |
The current domain verification status. | 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 email domain. | string |
No |
isSpf |
Value of the SPF field. For more information about SPF, please see SPF Authentication (https://docs.oracle.com/iaas/Content/Email/Concepts/overview.htm#components). | boolean |
No |
lifecycleState |
The current state of the email domain. | string |
No |
locks |
Locks associated with this resource. | list[object] |
No |
name |
The name of the email domain in the Internet Domain Name System (DNS). Example: mydomain.example.com |
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 email domain was created, 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 |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/email_v1beta1_emaildomain.yaml. Replace placeholder values before applying it.
#
# 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.
#
#
# Replace the domain and compartment OCID below before running e2e.
# Update metadata.name and spec.name together if you want to force a fresh create instead of
# binding to an existing EmailDomain with the same name in the same compartment.
#
apiVersion: email.oracle.com/v1beta1
kind: EmailDomain
metadata:
name: emaildomain-sample
spec:
name: mail.example.com
compartmentId: ocid1.compartment.oc1..exampleuniqueID
description: OSOK EmailDomain sample