com.mailgun.model.mailing.lists.MailingListData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mailgun-java Show documentation

The Mailgun SDK for Java enables Java developers to work with Mailgun API efficiently.

The newest version!

package com.mailgun.model.mailing.lists;

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.mailgun.enums.AccessLevel;
import com.mailgun.enums.ReplyPreference;
import lombok.Builder;
import lombok.Value;
import lombok.extern.jackson.Jacksonized;

import java.time.ZonedDateTime;

import static com.mailgun.util.Constants.ENGLISH;
import static com.mailgun.util.Constants.RFC_2822_DATE_TIME_PATTERN_TIME_ZONE_NUMERIC;

/**
 * 
 * Mailgun list data.
 * 
 *
 * @see Mailing Lists
 */
@Value
@Jacksonized
@Builder
@JsonIgnoreProperties(ignoreUnknown = true)
public class MailingListData {

    /**
     * 
     * List access level, one of: READONLY (default), MEMBERS, EVERYONE.
     * 
     * {@link AccessLevel}
     */
    @JsonProperty("access_level")
    AccessLevel accessLevel;

    /**
     * 
     * An email address, the ID for the mailing list.
     * 
     */
    String address;

    /**
     * 
     * Mailing list creation time.
     * 
     * {@link ZonedDateTime}
     */
    @JsonFormat(pattern = RFC_2822_DATE_TIME_PATTERN_TIME_ZONE_NUMERIC, locale = ENGLISH)
    @JsonProperty("created_at")
    ZonedDateTime createdAt;

    /**
     * 
     * Mailing list description.
     * 
     */
    String description;

    /**
     * 
     * Mailing list members count.
     * The total number of mailing list members.
     * 
     */
    @JsonProperty("members_count")
    Integer membersCount;

    /**
     * 
     * Mailing list name, e.g. Developers (optional).
     * 
     */
    String name;

    /**
     * 
     * Set where replies should go: list (default) | sender (optional).
     * 
     */
    @JsonProperty("reply_preference")
    ReplyPreference replyPreference;

}