Class WebhookDeliveryStatusPayload

DELIVERY_STATUS webhook payload. Sent to your webhook url endpoint via HTTP POST when an email delivery status is created. This could be a successful delivery or a delivery failure.

Inheritance

object

WebhookDeliveryStatusPayload

Implements

IEquatable<WebhookDeliveryStatusPayload>

System.ComponentModel.DataAnnotations.IValidatableObject

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "WebhookDeliveryStatusPayload")]
public class WebhookDeliveryStatusPayload : IEquatable<WebhookDeliveryStatusPayload>, IValidatableObject

Constructors

WebhookDeliveryStatusPayload()

Initializes a new instance of the WebhookDeliveryStatusPayload class.

Declaration

[JsonConstructor]
protected WebhookDeliveryStatusPayload()

WebhookDeliveryStatusPayload(string, Guid, EventNameEnum, string, Guid, Guid, Guid?, string, Guid?, string, List<string>, string, int?, long?, DateTime?, string)

Initializes a new instance of the WebhookDeliveryStatusPayload class.

Declaration

public WebhookDeliveryStatusPayload(string messageId = null, Guid webhookId = default, WebhookDeliveryStatusPayload.EventNameEnum eventName = (WebhookDeliveryStatusPayload.EventNameEnum)0, string webhookName = null, Guid id = default, Guid userId = default, Guid? sentId = null, string remoteMtaIp = null, Guid? inboxId = null, string reportingMta = null, List<string> recipients = null, string smtpResponse = null, int? smtpStatusCode = null, long? processingTimeMillis = null, DateTime? received = null, string subject = null)

Parameters

Type	Name	Description
string	messageId	Idempotent message ID. Store this ID locally or in a database to prevent message duplication. (required).
System.Guid	webhookId	ID of webhook entity being triggered (required).
WebhookDeliveryStatusPayload.EventNameEnum	eventName	Name of the event type webhook is being triggered for. (required).
string	webhookName	Name of the webhook being triggered.
System.Guid	id	ID of delivery status (required).
System.Guid	userId	User ID of event (required).
System.Guid?	sentId	ID of sent email.
string	remoteMtaIp	IP address of the remote Mail Transfer Agent.
System.Guid?	inboxId	Id of the inbox.
string	reportingMta	Mail Transfer Agent reporting delivery status.
System.Collections.Generic.List<T><string>	recipients	Recipients for delivery.
string	smtpResponse	SMTP server response message.
int?	smtpStatusCode	SMTP server status.
long?	processingTimeMillis	Time in milliseconds for delivery processing.
DateTime?	received	Time event was received.
string	subject	Email subject.

Properties

EventName

Name of the event type webhook is being triggered for.

Declaration

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

Property Value

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

Id

ID of delivery status

Declaration

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

Property Value

Type	Description
System.Guid	ID of delivery status

InboxId

Id of the inbox

Declaration

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

Property Value

Type	Description
System.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.

ProcessingTimeMillis

Time in milliseconds for delivery processing

Declaration

[DataMember(Name = "processingTimeMillis", EmitDefaultValue = true)]
public long? ProcessingTimeMillis { get; set; }

Property Value

Type	Description
long?	Time in milliseconds for delivery processing

Received

Time event was received

Declaration

[DataMember(Name = "received", EmitDefaultValue = true)]
public DateTime? Received { get; set; }

Property Value

Type	Description
DateTime?	Time event was received

Recipients

Recipients for delivery

Declaration

[DataMember(Name = "recipients", EmitDefaultValue = true)]
public List<string> Recipients { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<T><string>	Recipients for delivery

RemoteMtaIp

IP address of the remote Mail Transfer Agent

Declaration

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

Property Value

Type	Description
string	IP address of the remote Mail Transfer Agent

ReportingMta

Mail Transfer Agent reporting delivery status

Declaration

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

Property Value

Type	Description
string	Mail Transfer Agent reporting delivery status

SentId

ID of sent email

Declaration

[DataMember(Name = "sentId", EmitDefaultValue = true)]
public Guid? SentId { get; set; }

Property Value

Type	Description
System.Guid?	ID of sent email

SmtpResponse

SMTP server response message

Declaration

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

Property Value

Type	Description
string	SMTP server response message

SmtpStatusCode

SMTP server status

Declaration

[DataMember(Name = "smtpStatusCode", EmitDefaultValue = true)]
public int? SmtpStatusCode { get; set; }

Property Value

Type	Description
int?	SMTP server status

Subject

Email subject

Declaration

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

Property Value

Type	Description
string	Email subject

UserId

User ID of event

Declaration

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

Property Value

Type	Description
System.Guid	User ID of event

WebhookId

ID of webhook entity being triggered

Declaration

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

Property Value

Type	Description
System.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

Equals(WebhookDeliveryStatusPayload)

Returns true if WebhookDeliveryStatusPayload instances are equal

Declaration

public bool Equals(WebhookDeliveryStatusPayload input)

Parameters

Type	Name	Description
WebhookDeliveryStatusPayload	input	Instance of WebhookDeliveryStatusPayload to be compared

Returns

Type	Description
bool	Boolean

Equals(object)

Returns true if objects are equal

Declaration

public override bool Equals(object input)

Parameters

Type	Name	Description
object	input	Object to be compared

Returns

Type	Description
bool	Boolean

Overrides

Object.Equals(Object)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hash code

Overrides

Object.GetHashCode()

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()

Validate(ValidationContext)

To validate all properties of the instance

Declaration

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)

Parameters

Type	Name	Description
ValidationContext	validationContext	Validation context

Returns

Type	Description
IEnumerable<ValidationResult>	Validation Result

Implements

System.IEquatable<T>

System.ComponentModel.DataAnnotations.IValidatableObject