Email: Sender¶
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 | Sender |
| 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_sender.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 of the compartment that contains the sender. | 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 |
emailAddress |
The email address of the sender. | string |
Yes |
emailIpPoolId |
An optional field. The IpPool OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) used to submit an email by Email Delivery when sent from this sender. | 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 |
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 |
|---|---|---|---|
compartmentId |
The OCID for the compartment. | 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 |
emailAddress |
Email address of the sender. | string |
No |
emailDomainId |
The email domain used to assert responsibility for emails sent from this sender. | string |
No |
emailIpPoolId |
The IpPool OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) used to submit an email by Email Delivery when sent from this sender. | 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 unique OCID of the sender. | 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 sender's current lifecycle state. | string |
No |
locks |
Locks associated with this resource. | list[object] |
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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). | string |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/email_v1beta1_sender.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 compartment OCID and sender email address below before running e2e.
# Update metadata.name if you want to force a fresh create instead of reusing an
# existing Sender with the same compartmentId and emailAddress.
#
apiVersion: email.oracle.com/v1beta1
kind: Sender
metadata:
name: sender-sample
spec:
compartmentId: ocid1.compartment.oc1..exampleuniqueID
emailAddress: sender@example.com
freeformTags:
managed-by: oci-service-operator