Class Suppression
The full information representing an email suppression.
Inherited Members
Namespace: Oci.EmailService.Models
Assembly: OCI.DotNetSDK.Email.dll
Syntax
public class Suppression
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID. |
Remarks
Required
EmailAddress
Declaration
[Required(ErrorMessage = "EmailAddress is required.")]
[JsonProperty(PropertyName = "emailAddress")]
public string EmailAddress { get; set; }
Property Value
Type | Description |
---|---|
string | Email address of the suppression. |
Remarks
Required
ErrorDetail
Declaration
[JsonProperty(PropertyName = "errorDetail")]
public string ErrorDetail { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
ErrorSource
Declaration
[JsonProperty(PropertyName = "errorSource")]
public string ErrorSource { get; set; }
Property Value
Type | Description |
---|---|
string | 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.
|
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The unique ID of the suppression. |
Remarks
Required
MessageId
Declaration
[JsonProperty(PropertyName = "messageId")]
public string MessageId { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
Reason
Declaration
[JsonProperty(PropertyName = "reason")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SuppressionReason? Reason { get; set; }
Property Value
Type | Description |
---|---|
SuppressionReason? | The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List. |
TimeCreated
Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the suppression was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339. |
TimeLastSuppressed
Declaration
[JsonProperty(PropertyName = "timeLastSuppressed")]
public DateTime? TimeLastSuppressed { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The last date and time the suppression prevented submission in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339. |