Email: Suppression¶
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 | Suppression |
| 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_suppression.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 to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID. | string |
Yes |
emailAddress |
The recipient email address of the suppression. | 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 |
|---|---|---|---|
compartmentId |
The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID. | string |
No |
emailAddress |
Email address of the suppression. | string |
No |
errorDetail |
The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions. | string |
No |
errorSource |
DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known. Note: Most SMTP errors that cause suppressions come from software run by email receiving systems rather than from OCI email delivery itself. | string |
No |
id |
The unique ID of the suppression. | string |
No |
messageId |
The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions. | string |
No |
reason |
The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List (https://docs.oracle.com/iaas/Content/Email/Concepts/overview.htm#components). | string |
No |
status |
- | object |
Yes |
timeCreated |
The date and time the suppression 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 |
timeLastSuppressed |
The last date and time the suppression prevented submission 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_suppression.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.
#
apiVersion: email.oracle.com/v1beta1
kind: Suppression
metadata:
name: suppression-sample
spec: {}