com.mailslurp.models

Class WebhookBounceRecipientPayload

java.lang.Object

com.mailslurp.models.WebhookBounceRecipientPayload

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

BOUNCE_RECIPIENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email caused a bounce to occur for a recipient. Save the recipient to a ban list of your server and avoid email them again.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookBounceRecipientPayload.CustomTypeAdapterFactory
static class	WebhookBounceRecipientPayload.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_EVENT_NAME
static String	SERIALIZED_NAME_MESSAGE_ID
static String	SERIALIZED_NAME_RECIPIENT
static String	SERIALIZED_NAME_WEBHOOK_ID
static String	SERIALIZED_NAME_WEBHOOK_NAME

Constructor Summary

Constructors

Constructor and Description
WebhookBounceRecipientPayload()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
WebhookBounceRecipientPayload	eventName(WebhookBounceRecipientPayload.EventNameEnum eventName)
static WebhookBounceRecipientPayload	fromJson(String jsonString) Create an instance of WebhookBounceRecipientPayload given an JSON string
WebhookBounceRecipientPayload.EventNameEnum	getEventName() Name of the event type webhook is being triggered for.
String	getMessageId() Idempotent message ID.
String	getRecipient() Email address that caused a bounce.
UUID	getWebhookId() ID of webhook entity being triggered
String	getWebhookName() Name of the webhook being triggered
int	hashCode()
WebhookBounceRecipientPayload	messageId(String messageId)
WebhookBounceRecipientPayload	recipient(String recipient)
void	setEventName(WebhookBounceRecipientPayload.EventNameEnum eventName)
void	setMessageId(String messageId)
void	setRecipient(String recipient)
void	setWebhookId(UUID webhookId)
void	setWebhookName(String webhookName)
String	toJson() Convert an instance of WebhookBounceRecipientPayload 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
WebhookBounceRecipientPayload	webhookId(UUID webhookId)
WebhookBounceRecipientPayload	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_RECIPIENT

public static final String SERIALIZED_NAME_RECIPIENT

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

WebhookBounceRecipientPayload

public WebhookBounceRecipientPayload()

Method Detail

messageId

public WebhookBounceRecipientPayload 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 WebhookBounceRecipientPayload webhookId(UUID webhookId)

getWebhookId

@Nonnull
public UUID getWebhookId()

ID of webhook entity being triggered

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

eventName

public WebhookBounceRecipientPayload eventName(WebhookBounceRecipientPayload.EventNameEnum eventName)

getEventName

@Nonnull
public WebhookBounceRecipientPayload.EventNameEnum getEventName()

Name of the event type webhook is being triggered for.

Returns:

eventName

setEventName

public void setEventName(WebhookBounceRecipientPayload.EventNameEnum eventName)

webhookName

public WebhookBounceRecipientPayload webhookName(String webhookName)

getWebhookName

@Nullable
public String getWebhookName()

Name of the webhook being triggered

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

recipient

public WebhookBounceRecipientPayload recipient(String recipient)

getRecipient

@Nonnull
public String getRecipient()

Email address that caused a bounce. Make note of the address and try not to message it again to preserve your reputation.

Returns:

recipient

setRecipient

public void setRecipient(String recipient)

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 WebhookBounceRecipientPayload

fromJson

public static WebhookBounceRecipientPayload fromJson(String jsonString)
                                              throws IOException

Create an instance of WebhookBounceRecipientPayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookBounceRecipientPayload

Throws:

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

toJson

public String toJson()

Convert an instance of WebhookBounceRecipientPayload to an JSON string

Returns:

JSON string