Class Suppression.Builder

  • Enclosing class:
    Suppression

    public static class Suppression.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • compartmentId

        public Suppression.Builder compartmentId​(String compartmentId)
        The OCID of the compartment to contain the suppression.

        Since suppressions are at the customer level, this must be the tenancy OCID.

        Parameters:
        compartmentId - the value to set
        Returns:
        this builder
      • emailAddress

        public Suppression.Builder emailAddress​(String emailAddress)
        Email address of the suppression.
        Parameters:
        emailAddress - the value to set
        Returns:
        this builder
      • id

        public Suppression.Builder id​(String id)
        The unique ID of the suppression.
        Parameters:
        id - the value to set
        Returns:
        this builder
      • timeCreated

        public Suppression.Builder timeCreated​(Date timeCreated)
        The date and time the suppression was added in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • timeLastSuppressed

        public Suppression.Builder timeLastSuppressed​(Date 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.
        Parameters:
        timeLastSuppressed - the value to set
        Returns:
        this builder
      • messageId

        public Suppression.Builder messageId​(String 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.

        Parameters:
        messageId - the value to set
        Returns:
        this builder
      • errorDetail

        public Suppression.Builder errorDetail​(String 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.

        Parameters:
        errorDetail - the value to set
        Returns:
        this builder
      • errorSource

        public Suppression.Builder errorSource​(String 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.

        Parameters:
        errorSource - the value to set
        Returns:
        this builder