Class WebhookBouncePayload

BOUNCE webhook payload. Sent to your webhook url endpoint via HTTP POST when an email bounced or was rejected by a recipient. Save the recipients to a ban list on your server and avoid emailing them again. It is recommended you also listen to the BOUNCE_RECIPIENT payload.

Inheritance

object

WebhookBouncePayload

Implements

IEquatable<WebhookBouncePayload>

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 = "WebhookBouncePayload")]
public class WebhookBouncePayload : IEquatable<WebhookBouncePayload>, IValidatableObject

Constructors

WebhookBouncePayload()

Initializes a new instance of the WebhookBouncePayload class.

Declaration

[JsonConstructor]
protected WebhookBouncePayload()

WebhookBouncePayload(string, Guid, EventNameEnum, string, Guid, List<string>, string, List<string>)

Initializes a new instance of the WebhookBouncePayload class.

Declaration

public WebhookBouncePayload(string messageId = null, Guid webhookId = default, WebhookBouncePayload.EventNameEnum eventName = (WebhookBouncePayload.EventNameEnum)0, string webhookName = null, Guid bounceId = default, List<string> sentToRecipients = null, string sender = null, List<string> bounceRecipients = 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).
WebhookBouncePayload.EventNameEnum	eventName	Name of the event type webhook is being triggered for. (required).
string	webhookName	Name of the webhook being triggered.
System.Guid	bounceId	ID of the bounce email record. Use the ID with the bounce controller to view more information (required).
System.Collections.Generic.List<T><string>	sentToRecipients	Email sent to recipients.
string	sender	Sender causing bounce (required).
System.Collections.Generic.List<T><string>	bounceRecipients	Email addresses that resulted in a bounce or email being rejected. Please save these recipients and avoid emailing them in the future to maintain your reputation..

Properties

BounceId

ID of the bounce email record. Use the ID with the bounce controller to view more information

Declaration

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

Property Value

Type	Description
System.Guid	ID of the bounce email record. Use the ID with the bounce controller to view more information

BounceRecipients

Email addresses that resulted in a bounce or email being rejected. Please save these recipients and avoid emailing them in the future to maintain your reputation.

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<T><string>	Email addresses that resulted in a bounce or email being rejected. Please save these recipients and avoid emailing them in the future to maintain your reputation.

EventName

Name of the event type webhook is being triggered for.

Declaration

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

Property Value

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

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.

Sender

Sender causing bounce

Declaration

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

Property Value

Type	Description
string	Sender causing bounce

SentToRecipients

Email sent to recipients

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<T><string>	Email sent to recipients

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

Returns true if WebhookBouncePayload instances are equal

Declaration

public bool Equals(WebhookBouncePayload input)

Parameters

Type	Name	Description
WebhookBouncePayload	input	Instance of WebhookBouncePayload 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