Class WebhookEmailReadPayload

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.

Inheritance

object

WebhookEmailReadPayload

Implements

IValidatableObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "WebhookEmailReadPayload")]
public class WebhookEmailReadPayload : IValidatableObject

Constructors

WebhookEmailReadPayload()

Initializes a new instance of the WebhookEmailReadPayload class.

Declaration

[JsonConstructor]
protected WebhookEmailReadPayload()

WebhookEmailReadPayload(string, Guid, EventNameEnum, string, Guid, Guid, bool, DateTime)

Initializes a new instance of the WebhookEmailReadPayload class.

Declaration

public WebhookEmailReadPayload(string messageId = null, Guid webhookId = default, WebhookEmailReadPayload.EventNameEnum eventName = (WebhookEmailReadPayload.EventNameEnum)0, string webhookName = null, Guid emailId = default, Guid inboxId = default, bool emailIsRead = false, DateTime createdAt = default)

Parameters

Type	Name	Description
string	messageId	Idempotent message ID. Store this ID locally or in a database to prevent message duplication. (required).
Guid	webhookId	ID of webhook entity being triggered (required).
WebhookEmailReadPayload.EventNameEnum	eventName	Name of the event type webhook is being triggered for. (required).
string	webhookName	Name of the webhook being triggered.
Guid	emailId	ID of the email that was received. Use this ID for fetching the email with the EmailController. (required).
Guid	inboxId	Id of the inbox (required).
bool	emailIsRead	Is the email read (required).
DateTime	createdAt	Date time of event creation (required).

Properties

CreatedAt

Date time of event creation

Declaration

[DataMember(Name = "createdAt", IsRequired = true, EmitDefaultValue = true)]
public DateTime CreatedAt { get; set; }

Property Value

Type	Description
DateTime	Date time of event creation

EmailId

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

Declaration

[DataMember(Name = "emailId", IsRequired = true, EmitDefaultValue = true)]
public Guid EmailId { get; set; }

Property Value

Type	Description
Guid	ID of the email that was received. Use this ID for fetching the email with the EmailController.

EmailIsRead

Is the email read

Declaration

[DataMember(Name = "emailIsRead", IsRequired = true, EmitDefaultValue = true)]
public bool EmailIsRead { get; set; }

Property Value

Type	Description
bool	Is the email read

EventName

Name of the event type webhook is being triggered for.

Declaration

[DataMember(Name = "eventName", IsRequired = true, EmitDefaultValue = true)]
public WebhookEmailReadPayload.EventNameEnum EventName { get; set; }

Property Value

Type	Description
WebhookEmailReadPayload.EventNameEnum	Name of the event type webhook is being triggered for.

InboxId

Id of the inbox

Declaration

[DataMember(Name = "inboxId", IsRequired = true, EmitDefaultValue = true)]
public Guid InboxId { get; set; }

Property Value

Type	Description
Guid	Id of the inbox

MessageId

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

Declaration

[DataMember(Name = "messageId", IsRequired = true, EmitDefaultValue = true)]
public string MessageId { get; set; }

Property Value

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

WebhookId

ID of webhook entity being triggered

Declaration

[DataMember(Name = "webhookId", IsRequired = true, EmitDefaultValue = true)]
public Guid WebhookId { get; set; }

Property Value

Type	Description
Guid	ID of webhook entity being triggered

WebhookName

Name of the webhook being triggered

Declaration

[DataMember(Name = "webhookName", EmitDefaultValue = true)]
public string WebhookName { get; set; }

Property Value

Type	Description
string	Name of the webhook being triggered

Methods

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Implements

IValidatableObject