com.mailslurp.models

Class WebhookBouncePayload

java.lang.Object

com.mailslurp.models.WebhookBouncePayload

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class WebhookBouncePayload
extends Object

BOUNCE webhook payload. Sent to your webhook url endpoint via HTTP POST when an email bounced or was rejected by a recipient. Save the recipients to a ban list on your server and avoid emailing them again. It is recommended you also listen to the BOUNCE_RECIPIENT payload.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookBouncePayload.CustomTypeAdapterFactory
static class	WebhookBouncePayload.EventNameEnum Name of the event type webhook is being triggered for.

Field Summary

Fields

Modifier and Type	Field and Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_BOUNCE_ID
static String	SERIALIZED_NAME_BOUNCE_RECIPIENTS
static String	SERIALIZED_NAME_EVENT_NAME
static String	SERIALIZED_NAME_MESSAGE_ID
static String	SERIALIZED_NAME_SENDER
static String	SERIALIZED_NAME_SENT_TO_RECIPIENTS
static String	SERIALIZED_NAME_WEBHOOK_ID
static String	SERIALIZED_NAME_WEBHOOK_NAME

Constructor Summary

Constructors

Constructor and Description
WebhookBouncePayload()

Method Summary

Modifier and Type	Method and Description
WebhookBouncePayload	addBounceRecipientsItem(String bounceRecipientsItem)
WebhookBouncePayload	addSentToRecipientsItem(String sentToRecipientsItem)
WebhookBouncePayload	bounceId(UUID bounceId)
WebhookBouncePayload	bounceRecipients(List<String> bounceRecipients)
boolean	equals(Object o)
WebhookBouncePayload	eventName(WebhookBouncePayload.EventNameEnum eventName)
static WebhookBouncePayload	fromJson(String jsonString) Create an instance of WebhookBouncePayload given an JSON string
UUID	getBounceId() ID of the bounce email record.
List<String>	getBounceRecipients() Email addresses that resulted in a bounce or email being rejected.
WebhookBouncePayload.EventNameEnum	getEventName() Name of the event type webhook is being triggered for.
String	getMessageId() Idempotent message ID.
String	getSender() Sender causing bounce
List<String>	getSentToRecipients() Email sent to recipients
UUID	getWebhookId() ID of webhook entity being triggered
String	getWebhookName() Name of the webhook being triggered
int	hashCode()
WebhookBouncePayload	messageId(String messageId)
WebhookBouncePayload	sender(String sender)
WebhookBouncePayload	sentToRecipients(List<String> sentToRecipients)
void	setBounceId(UUID bounceId)
void	setBounceRecipients(List<String> bounceRecipients)
void	setEventName(WebhookBouncePayload.EventNameEnum eventName)
void	setMessageId(String messageId)
void	setSender(String sender)
void	setSentToRecipients(List<String> sentToRecipients)
void	setWebhookId(UUID webhookId)
void	setWebhookName(String webhookName)
String	toJson() Convert an instance of WebhookBouncePayload to an JSON string
String	toString()
static void	validateJsonObject(com.google.gson.JsonObject jsonObj) Validates the JSON Object and throws an exception if issues found
WebhookBouncePayload	webhookId(UUID webhookId)
WebhookBouncePayload	webhookName(String webhookName)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_MESSAGE_ID

public static final String SERIALIZED_NAME_MESSAGE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_WEBHOOK_ID

public static final String SERIALIZED_NAME_WEBHOOK_ID

See Also:

Constant Field Values

SERIALIZED_NAME_EVENT_NAME

public static final String SERIALIZED_NAME_EVENT_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_WEBHOOK_NAME

public static final String SERIALIZED_NAME_WEBHOOK_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_BOUNCE_ID

public static final String SERIALIZED_NAME_BOUNCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SENT_TO_RECIPIENTS

public static final String SERIALIZED_NAME_SENT_TO_RECIPIENTS

See Also:

Constant Field Values

SERIALIZED_NAME_SENDER

public static final String SERIALIZED_NAME_SENDER

See Also:

Constant Field Values

SERIALIZED_NAME_BOUNCE_RECIPIENTS

public static final String SERIALIZED_NAME_BOUNCE_RECIPIENTS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

WebhookBouncePayload

public WebhookBouncePayload()

Method Detail

messageId

public WebhookBouncePayload messageId(String messageId)

getMessageId

@Nonnull
public String getMessageId()

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

Returns:

messageId

setMessageId

public void setMessageId(String messageId)

webhookId

public WebhookBouncePayload webhookId(UUID webhookId)

getWebhookId

@Nonnull
public UUID getWebhookId()

ID of webhook entity being triggered

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

eventName

public WebhookBouncePayload eventName(WebhookBouncePayload.EventNameEnum eventName)

getEventName

@Nonnull
public WebhookBouncePayload.EventNameEnum getEventName()

Name of the event type webhook is being triggered for.

Returns:

eventName

setEventName

public void setEventName(WebhookBouncePayload.EventNameEnum eventName)

webhookName

public WebhookBouncePayload webhookName(String webhookName)

getWebhookName

@Nullable
public String getWebhookName()

Name of the webhook being triggered

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

bounceId

public WebhookBouncePayload bounceId(UUID bounceId)

getBounceId

@Nonnull
public UUID getBounceId()

ID of the bounce email record. Use the ID with the bounce controller to view more information

Returns:

bounceId

setBounceId

public void setBounceId(UUID bounceId)

sentToRecipients

public WebhookBouncePayload sentToRecipients(List<String> sentToRecipients)

addSentToRecipientsItem

public WebhookBouncePayload addSentToRecipientsItem(String sentToRecipientsItem)

getSentToRecipients

@Nullable
public List<String> getSentToRecipients()

Email sent to recipients

Returns:

sentToRecipients

setSentToRecipients

public void setSentToRecipients(List<String> sentToRecipients)

sender

public WebhookBouncePayload sender(String sender)

getSender

@Nonnull
public String getSender()

Sender causing bounce

Returns:

sender

setSender

public void setSender(String sender)

bounceRecipients

public WebhookBouncePayload bounceRecipients(List<String> bounceRecipients)

addBounceRecipientsItem

public WebhookBouncePayload addBounceRecipientsItem(String bounceRecipientsItem)

getBounceRecipients

@Nullable
public List<String> getBounceRecipients()

Email addresses that resulted in a bounce or email being rejected. Please save these recipients and avoid emailing them in the future to maintain your reputation.

Returns:

bounceRecipients

setBounceRecipients

public void setBounceRecipients(List<String> bounceRecipients)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to WebhookBouncePayload

fromJson

public static WebhookBouncePayload fromJson(String jsonString)
                                     throws IOException

Create an instance of WebhookBouncePayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookBouncePayload

Throws:

IOException - if the JSON string is invalid with respect to WebhookBouncePayload

toJson

public String toJson()

Convert an instance of WebhookBouncePayload to an JSON string

Returns:

JSON string