software.amazon.awssdk.services.sesv2.model.BehaviorOnMxFailure Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package software.amazon.awssdk.services.sesv2.model;

import static java.util.stream.Collectors.toSet;

import java.util.Set;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;

/**
 * 
 * The action that you want to take if the required MX record can't be found when you send an email. When you set this
 * value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you
 * set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified
 * error, and doesn't attempt to deliver the email.
 * 
 * 
 * These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending,
 * Failed, and TemporaryFailure states.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public enum BehaviorOnMxFailure {
    USE_DEFAULT_VALUE("USE_DEFAULT_VALUE"),

    REJECT_MESSAGE("REJECT_MESSAGE"),

    UNKNOWN_TO_SDK_VERSION(null);

    private final String value;

    private BehaviorOnMxFailure(String value) {
        this.value = value;
    }

    @Override
    public String toString() {
        return String.valueOf(value);
    }

    /**
     * Use this in place of valueOf to convert the raw string returned by the service into the enum value.
     *
     * @param value
     *        real value
     * @return BehaviorOnMxFailure corresponding to the value
     */
    public static BehaviorOnMxFailure fromValue(String value) {
        if (value == null) {
            return null;
        }
        return Stream.of(BehaviorOnMxFailure.values()).filter(e -> e.toString().equals(value)).findFirst()
                .orElse(UNKNOWN_TO_SDK_VERSION);
    }

    /**
     * Use this in place of {@link #values()} to return a {@link Set} of all values known to the SDK. This will return
     * all known enum values except {@link #UNKNOWN_TO_SDK_VERSION}.
     *
     * @return a {@link Set} of known {@link BehaviorOnMxFailure}s
     */
    public static Set knownValues() {
        return Stream.of(values()).filter(v -> v != UNKNOWN_TO_SDK_VERSION).collect(toSet());
    }
}