Class WebhookBounceRecipientPayload

BOUNCE_RECIPIENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email caused a bounce to occur for a recipient. Save the recipient to a ban list of your server and avoid email them again.

Inheritance

object

WebhookBounceRecipientPayload

Implements

IEquatable<WebhookBounceRecipientPayload>

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

Constructors

View Source

WebhookBounceRecipientPayload()

Initializes a new instance of the WebhookBounceRecipientPayload class.

Declaration

[JsonConstructor]
protected WebhookBounceRecipientPayload()

View Source

WebhookBounceRecipientPayload(string, Guid, EventNameEnum, string, string)

Initializes a new instance of the WebhookBounceRecipientPayload class.

Declaration

public WebhookBounceRecipientPayload(string messageId = null, Guid webhookId = default, WebhookBounceRecipientPayload.EventNameEnum eventName = (WebhookBounceRecipientPayload.EventNameEnum)0, string webhookName = null, string recipient = 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).
WebhookBounceRecipientPayload.EventNameEnum	eventName	Name of the event type webhook is being triggered for. (required).
string	webhookName	Name of the webhook being triggered.
string	recipient	Email address that caused a bounce. Make note of the address and try not to message it again to preserve your reputation. (required).

Properties

View Source

EventName

Name of the event type webhook is being triggered for.

Declaration

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

Property Value

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

View Source

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.

View Source

Recipient

Email address that caused a bounce. Make note of the address and try not to message it again to preserve your reputation.

Declaration

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

Property Value

Type	Description
string	Email address that caused a bounce. Make note of the address and try not to message it again to preserve your reputation.

View Source

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

View Source

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

View Source

Equals(WebhookBounceRecipientPayload)

Returns true if WebhookBounceRecipientPayload instances are equal

Declaration

public bool Equals(WebhookBounceRecipientPayload input)

Parameters

Type	Name	Description
WebhookBounceRecipientPayload	input	Instance of WebhookBounceRecipientPayload to be compared

Returns

Type	Description
bool	Boolean

View Source

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)

View Source

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hash code

Overrides

Object.GetHashCode()

View Source

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

View Source

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

View Source

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