com.mailslurp.models

Class WebhookEmailReadPayload

java.lang.Object

com.mailslurp.models.WebhookEmailReadPayload

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

EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is read. This happens when an email is requested in full from the API or a user views the email in the dashboard.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookEmailReadPayload.CustomTypeAdapterFactory
static class	WebhookEmailReadPayload.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_CREATED_AT
static String	SERIALIZED_NAME_EMAIL_ID
static String	SERIALIZED_NAME_EMAIL_IS_READ
static String	SERIALIZED_NAME_EVENT_NAME
static String	SERIALIZED_NAME_INBOX_ID
static String	SERIALIZED_NAME_MESSAGE_ID
static String	SERIALIZED_NAME_WEBHOOK_ID
static String	SERIALIZED_NAME_WEBHOOK_NAME

Constructor Summary

Constructors

Constructor and Description
WebhookEmailReadPayload()

Method Summary

Modifier and Type	Method and Description
WebhookEmailReadPayload	createdAt(OffsetDateTime createdAt)
WebhookEmailReadPayload	emailId(UUID emailId)
WebhookEmailReadPayload	emailIsRead(Boolean emailIsRead)
boolean	equals(Object o)
WebhookEmailReadPayload	eventName(WebhookEmailReadPayload.EventNameEnum eventName)
static WebhookEmailReadPayload	fromJson(String jsonString) Create an instance of WebhookEmailReadPayload given an JSON string
OffsetDateTime	getCreatedAt() Date time of event creation
UUID	getEmailId() ID of the email that was received.
Boolean	getEmailIsRead() Is the email read
WebhookEmailReadPayload.EventNameEnum	getEventName() Name of the event type webhook is being triggered for.
UUID	getInboxId() Id of the inbox
String	getMessageId() Idempotent message ID.
UUID	getWebhookId() ID of webhook entity being triggered
String	getWebhookName() Name of the webhook being triggered
int	hashCode()
WebhookEmailReadPayload	inboxId(UUID inboxId)
WebhookEmailReadPayload	messageId(String messageId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setEmailId(UUID emailId)
void	setEmailIsRead(Boolean emailIsRead)
void	setEventName(WebhookEmailReadPayload.EventNameEnum eventName)
void	setInboxId(UUID inboxId)
void	setMessageId(String messageId)
void	setWebhookId(UUID webhookId)
void	setWebhookName(String webhookName)
String	toJson() Convert an instance of WebhookEmailReadPayload 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
WebhookEmailReadPayload	webhookId(UUID webhookId)
WebhookEmailReadPayload	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_EMAIL_ID

public static final String SERIALIZED_NAME_EMAIL_ID

See Also:

Constant Field Values

SERIALIZED_NAME_INBOX_ID

public static final String SERIALIZED_NAME_INBOX_ID

See Also:

Constant Field Values

SERIALIZED_NAME_EMAIL_IS_READ

public static final String SERIALIZED_NAME_EMAIL_IS_READ

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

WebhookEmailReadPayload

public WebhookEmailReadPayload()

Method Detail

messageId

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

getWebhookId

@Nonnull
public UUID getWebhookId()

ID of webhook entity being triggered

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

eventName

public WebhookEmailReadPayload eventName(WebhookEmailReadPayload.EventNameEnum eventName)

getEventName

@Nonnull
public WebhookEmailReadPayload.EventNameEnum getEventName()

Name of the event type webhook is being triggered for.

Returns:

eventName

setEventName

public void setEventName(WebhookEmailReadPayload.EventNameEnum eventName)

webhookName

public WebhookEmailReadPayload webhookName(String webhookName)

getWebhookName

@Nullable
public String getWebhookName()

Name of the webhook being triggered

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

emailId

public WebhookEmailReadPayload emailId(UUID emailId)

getEmailId

@Nonnull
public UUID getEmailId()

ID of the email that was received. Use this ID for fetching the email with the `EmailController`.

Returns:

emailId

setEmailId

public void setEmailId(UUID emailId)

inboxId

public WebhookEmailReadPayload inboxId(UUID inboxId)

getInboxId

@Nonnull
public UUID getInboxId()

Id of the inbox

Returns:

inboxId

setInboxId

public void setInboxId(UUID inboxId)

emailIsRead

public WebhookEmailReadPayload emailIsRead(Boolean emailIsRead)

getEmailIsRead

@Nonnull
public Boolean getEmailIsRead()

Is the email read

Returns:

emailIsRead

setEmailIsRead

public void setEmailIsRead(Boolean emailIsRead)

createdAt

public WebhookEmailReadPayload createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nonnull
public OffsetDateTime getCreatedAt()

Date time of event creation

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

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 WebhookEmailReadPayload

fromJson

public static WebhookEmailReadPayload fromJson(String jsonString)
                                        throws IOException

Create an instance of WebhookEmailReadPayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookEmailReadPayload

Throws:

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

toJson

public String toJson()

Convert an instance of WebhookEmailReadPayload to an JSON string

Returns:

JSON string