com.sparkpost.model.webhook.event.PolicyRejectionEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sparkpost-lib Show documentation
There is a newer version: 0.27

package com.sparkpost.model.webhook.event;

import java.util.List;
import java.util.Map;

import com.google.gson.annotations.SerializedName;
import com.yepher.jsondoc.annotations.Description;

import lombok.Data;
import lombok.EqualsAndHashCode;

/**
 * Due to policy, SparkPost rejected a message or failed to generate a message.
 */

@Data
@EqualsAndHashCode(callSuper = true)
public class PolicyRejectionEvent extends AbstractWebhookEvent {

    @Description(
            value = "Canonicalized text of the response returned by the remote server due to a failed delivery attempt",
            sample = "MAIL REFUSED - IP (a.b.c.d) is in black list")
    private String reason;

    @SerializedName("remote_addr")
    @Description(value = "IP address of the host from which SparkPost received this message", sample = "127.0.0.1")
    private String remoteAddr;

    @SerializedName("template_version")
    @Description(value = "Version of the template used to construct this message", sample = "1")
    private String templateVersion;

    @SerializedName("friendly_from")
    @Description(value = "Friendly sender or \"From\" header in the original email", sample = "[email protected]")
    private String friendlyFrom;

    @SerializedName("rcpt_meta")
    @Description(value = "Metadata describing the message recipient", sample = "{\"customKey\":\"customValue\"}")
    private Map rcptMeta;

    @SerializedName("rcpt_tags")
    @Description(value = "Tags applied to the message which generated this event", sample = "[\"male\",\"US\"]")
    private List rcptTags;

    @SerializedName("message_id")
    @Description(value = "SparkPost-cluster-wide unique identifier for this message", sample = "000443ee14578172be22")
    private String messageId;

    @Description(value = "Type of event this record describes", sample = "policy_rejection")
    private String type;

    @SerializedName("raw_rcpt_to")
    @Description(value = "Actual recipient address used on this message's SMTP envelope", sample = "[email protected]")
    private String rawRcptTo;

    @SerializedName("rcpt_type")
    @Description(value = "Indicates that a recipient address appeared in the Cc or Bcc header or the archive JSON array", sample = "cc")
    private String rcptType;

    @SerializedName("bounce_class")
    @Description(
            value = "Classification code for a given message (see [Bounce Classification Codes](https://support.sparkpost.com/customer/portal/articles/1929896))",
            sample = "1")
    private String bounceClass;

    @SerializedName("msg_from")
    @Description(value = "Sender address used on this message's SMTP envelope", sample = "[email protected]")
    private String msgFrom;

    @SerializedName("event_id")
    @Description(value = "Unique event identifier", sample = "92356927693813856")
    private String eventId;

    @SerializedName("rcpt_to")
    @Description(value = "Lowercase version of recipient address used on this message's SMTP envelope", sample = "[email protected]")
    private String rcptTo;

    @SerializedName("sending_ip")
    @Description(value = "IP address through which this message was sent", sample = "127.0.0.1")
    private String sendingIp;

    @SerializedName("raw_reason")
    @Description(
            value = "Unmodified, exact response returned by the remote server due to a failed delivery attempt",
            sample = "MAIL REFUSED - IP (17.99.99.99) is in black list")
    private String rawReason;

    @SerializedName("error_code")
    @Description(value = "Error code by which the remote server described a failed delivery attempt", sample = "554")
    private String errorCode;

    @SerializedName("subaccount_id")
    @Description(value = "Unique subaccount identifier.", sample = "101")
    private String subaccountId;

    @SerializedName("template_id")
    @Description(value = "Slug of the template used to construct this message", sample = "templ-1234")
    private String templateId;

    @SerializedName("transmission_id")
    @Description(value = "Transmission which originated this message", sample = "65832150921904138")
    private String transmissionId;

    @SerializedName("customer_id")
    @Description(value = "SparkPost-customer identifier through which this message was sent", sample = "1")
    private String customerId;

    @SerializedName("campaign_id")
    @Description(value = "Campaign of which this message was a part", sample = "Example Campaign Name")
    private String campaignId;

    @Description(value = "Event date and time, in Unix timestamp format (integer seconds since 00:00:00 GMT 1970-01-01)", sample = "1454442600")
    private String timestamp;

}