com.mailslurp.models

Class WebhookNewEmailPayload

java.lang.Object

com.mailslurp.models.WebhookNewEmailPayload

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

NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to. Use the email ID to fetch the full email body or attachments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookNewEmailPayload.CustomTypeAdapterFactory
static class	WebhookNewEmailPayload.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_ATTACHMENT_META_DATAS
static String	SERIALIZED_NAME_BCC
static String	SERIALIZED_NAME_CC
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_DOMAIN_ID
static String	SERIALIZED_NAME_EMAIL_ID
static String	SERIALIZED_NAME_EVENT_NAME
static String	SERIALIZED_NAME_FROM
static String	SERIALIZED_NAME_INBOX_ID
static String	SERIALIZED_NAME_MESSAGE_ID
static String	SERIALIZED_NAME_SUBJECT
static String	SERIALIZED_NAME_TO
static String	SERIALIZED_NAME_WEBHOOK_ID
static String	SERIALIZED_NAME_WEBHOOK_NAME

Constructor Summary

Constructors

Constructor and Description
WebhookNewEmailPayload()

Method Summary

Modifier and Type	Method and Description
WebhookNewEmailPayload	addAttachmentMetaDatasItem(AttachmentMetaData attachmentMetaDatasItem)
WebhookNewEmailPayload	addBccItem(String bccItem)
WebhookNewEmailPayload	addCcItem(String ccItem)
WebhookNewEmailPayload	addToItem(String toItem)
WebhookNewEmailPayload	attachmentMetaDatas(List<AttachmentMetaData> attachmentMetaDatas)
WebhookNewEmailPayload	bcc(List<String> bcc)
WebhookNewEmailPayload	cc(List<String> cc)
WebhookNewEmailPayload	createdAt(OffsetDateTime createdAt)
WebhookNewEmailPayload	domainId(UUID domainId)
WebhookNewEmailPayload	emailId(UUID emailId)
boolean	equals(Object o)
WebhookNewEmailPayload	eventName(WebhookNewEmailPayload.EventNameEnum eventName)
WebhookNewEmailPayload	from(String from)
static WebhookNewEmailPayload	fromJson(String jsonString) Create an instance of WebhookNewEmailPayload given an JSON string
List<AttachmentMetaData>	getAttachmentMetaDatas() List of attachment meta data objects if attachments present
List<String>	getBcc() List of `BCC` recipients email addresses that the email was addressed to.
List<String>	getCc() List of `CC` recipients email addresses that the email was addressed to.
OffsetDateTime	getCreatedAt() Date time of event creation
UUID	getDomainId() Id of the domain that received an email
UUID	getEmailId() ID of the email that was received.
WebhookNewEmailPayload.EventNameEnum	getEventName() Name of the event type webhook is being triggered for.
String	getFrom() Who the email was sent from.
UUID	getInboxId() Id of the inbox
String	getMessageId() Idempotent message ID.
String	getSubject() The subject line of the email message as specified by SMTP subject header
List<String>	getTo() List of `To` recipient email addresses that the email was addressed to.
UUID	getWebhookId() ID of webhook entity being triggered
String	getWebhookName() Name of the webhook being triggered
int	hashCode()
WebhookNewEmailPayload	inboxId(UUID inboxId)
WebhookNewEmailPayload	messageId(String messageId)
void	setAttachmentMetaDatas(List<AttachmentMetaData> attachmentMetaDatas)
void	setBcc(List<String> bcc)
void	setCc(List<String> cc)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDomainId(UUID domainId)
void	setEmailId(UUID emailId)
void	setEventName(WebhookNewEmailPayload.EventNameEnum eventName)
void	setFrom(String from)
void	setInboxId(UUID inboxId)
void	setMessageId(String messageId)
void	setSubject(String subject)
void	setTo(List<String> to)
void	setWebhookId(UUID webhookId)
void	setWebhookName(String webhookName)
WebhookNewEmailPayload	subject(String subject)
WebhookNewEmailPayload	to(List<String> to)
String	toJson() Convert an instance of WebhookNewEmailPayload 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
WebhookNewEmailPayload	webhookId(UUID webhookId)
WebhookNewEmailPayload	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_INBOX_ID

public static final String SERIALIZED_NAME_INBOX_ID

See Also:

Constant Field Values

SERIALIZED_NAME_DOMAIN_ID

public static final String SERIALIZED_NAME_DOMAIN_ID

See Also:

Constant Field Values

SERIALIZED_NAME_EMAIL_ID

public static final String SERIALIZED_NAME_EMAIL_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_TO

public static final String SERIALIZED_NAME_TO

See Also:

Constant Field Values

SERIALIZED_NAME_FROM

public static final String SERIALIZED_NAME_FROM

See Also:

Constant Field Values

SERIALIZED_NAME_CC

public static final String SERIALIZED_NAME_CC

See Also:

Constant Field Values

SERIALIZED_NAME_BCC

public static final String SERIALIZED_NAME_BCC

See Also:

Constant Field Values

SERIALIZED_NAME_SUBJECT

public static final String SERIALIZED_NAME_SUBJECT

See Also:

Constant Field Values

SERIALIZED_NAME_ATTACHMENT_META_DATAS

public static final String SERIALIZED_NAME_ATTACHMENT_META_DATAS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

WebhookNewEmailPayload

public WebhookNewEmailPayload()

Method Detail

messageId

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

getWebhookId

@Nonnull
public UUID getWebhookId()

ID of webhook entity being triggered

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

eventName

public WebhookNewEmailPayload eventName(WebhookNewEmailPayload.EventNameEnum eventName)

getEventName

@Nonnull
public WebhookNewEmailPayload.EventNameEnum getEventName()

Name of the event type webhook is being triggered for.

Returns:

eventName

setEventName

public void setEventName(WebhookNewEmailPayload.EventNameEnum eventName)

webhookName

public WebhookNewEmailPayload webhookName(String webhookName)

getWebhookName

@Nullable
public String getWebhookName()

Name of the webhook being triggered

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

inboxId

public WebhookNewEmailPayload inboxId(UUID inboxId)

getInboxId

@Nonnull
public UUID getInboxId()

Id of the inbox

Returns:

inboxId

setInboxId

public void setInboxId(UUID inboxId)

domainId

public WebhookNewEmailPayload domainId(UUID domainId)

getDomainId

@Nullable
public UUID getDomainId()

Id of the domain that received an email

Returns:

domainId

setDomainId

public void setDomainId(UUID domainId)

emailId

public WebhookNewEmailPayload 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)

createdAt

public WebhookNewEmailPayload createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nonnull
public OffsetDateTime getCreatedAt()

Date time of event creation

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

to

public WebhookNewEmailPayload to(List<String> to)

addToItem

public WebhookNewEmailPayload addToItem(String toItem)

getTo

@Nonnull
public List<String> getTo()

List of `To` recipient email addresses that the email was addressed to. See recipients object for names.

Returns:

to

setTo

public void setTo(List<String> to)

from

public WebhookNewEmailPayload from(String from)

getFrom

@Nonnull
public String getFrom()

Who the email was sent from. An email address - see fromName for the sender name.

Returns:

from

setFrom

public void setFrom(String from)

cc

public WebhookNewEmailPayload cc(List<String> cc)

addCcItem

public WebhookNewEmailPayload addCcItem(String ccItem)

getCc

@Nonnull
public List<String> getCc()

List of `CC` recipients email addresses that the email was addressed to. See recipients object for names.

Returns:

cc

setCc

public void setCc(List<String> cc)

bcc

public WebhookNewEmailPayload bcc(List<String> bcc)

addBccItem

public WebhookNewEmailPayload addBccItem(String bccItem)

getBcc

@Nonnull
public List<String> getBcc()

List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names.

Returns:

bcc

setBcc

public void setBcc(List<String> bcc)

subject

public WebhookNewEmailPayload subject(String subject)

getSubject

@Nullable
public String getSubject()

The subject line of the email message as specified by SMTP subject header

Returns:

subject

setSubject

public void setSubject(String subject)

attachmentMetaDatas

public WebhookNewEmailPayload attachmentMetaDatas(List<AttachmentMetaData> attachmentMetaDatas)

addAttachmentMetaDatasItem

public WebhookNewEmailPayload addAttachmentMetaDatasItem(AttachmentMetaData attachmentMetaDatasItem)

getAttachmentMetaDatas

@Nonnull
public List<AttachmentMetaData> getAttachmentMetaDatas()

List of attachment meta data objects if attachments present

Returns:

attachmentMetaDatas

setAttachmentMetaDatas

public void setAttachmentMetaDatas(List<AttachmentMetaData> attachmentMetaDatas)

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 WebhookNewEmailPayload

fromJson

public static WebhookNewEmailPayload fromJson(String jsonString)
                                       throws IOException

Create an instance of WebhookNewEmailPayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookNewEmailPayload

Throws:

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

toJson

public String toJson()

Convert an instance of WebhookNewEmailPayload to an JSON string

Returns:

JSON string