Class EmailProjection

A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and attachments are not included. To get all fields of the email use the getEmail method with the email projection's ID. See EmailDto for documentation on projection properties.

Inheritance

object

EmailProjection

Implements

IEquatable<EmailProjection>

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

Constructors

EmailProjection()

Initializes a new instance of the EmailProjection class.

Declaration

[JsonConstructor]
protected EmailProjection()

EmailProjection(DateTime, List<string>, Guid, List<string>, Guid?, List<string>, List<string>, bool, string, bool, string, string, string, Guid, string)

Initializes a new instance of the EmailProjection class.

Declaration

public EmailProjection(DateTime createdAt = default, List<string> attachments = null, Guid inboxId = default, List<string> to = null, Guid? domainId = null, List<string> bcc = null, List<string> cc = null, bool read = false, string bodyExcerpt = null, bool teamAccess = false, string bodyMD5Hash = null, string textExcerpt = null, string subject = null, Guid id = default, string from = null)

Parameters

Type	Name	Description
DateTime	createdAt	createdAt (required).
System.Collections.Generic.List<T><string>	attachments	attachments.
System.Guid	inboxId	inboxId (required).
System.Collections.Generic.List<T><string>	to	to (required).
System.Guid?	domainId	domainId.
System.Collections.Generic.List<T><string>	bcc	bcc.
System.Collections.Generic.List<T><string>	cc	cc.
bool	read	read (required).
string	bodyExcerpt	bodyExcerpt.
bool	teamAccess	teamAccess (required).
string	bodyMD5Hash	bodyMD5Hash.
string	textExcerpt	textExcerpt.
string	subject	subject.
System.Guid	id	id (required).
string	from	from.

Properties

Attachments

Gets or Sets Attachments

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<T><string>

Bcc

Gets or Sets Bcc

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<T><string>

BodyExcerpt

Gets or Sets BodyExcerpt

Declaration

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

Property Value

Type	Description
string

BodyMD5Hash

Gets or Sets BodyMD5Hash

Declaration

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

Property Value

Type	Description
string

Cc

Gets or Sets Cc

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<T><string>

CreatedAt

Gets or Sets CreatedAt

Declaration

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

Property Value

Type	Description
DateTime

DomainId

Gets or Sets DomainId

Declaration

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

Property Value

Type	Description
System.Guid?

From

Gets or Sets From

Declaration

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

Property Value

Type	Description
string

Id

Gets or Sets Id

Declaration

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

Property Value

Type	Description
System.Guid

InboxId

Gets or Sets InboxId

Declaration

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

Property Value

Type	Description
System.Guid

Read

Gets or Sets Read

Declaration

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

Property Value

Type	Description
bool

Subject

Gets or Sets Subject

Declaration

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

Property Value

Type	Description
string

TeamAccess

Gets or Sets TeamAccess

Declaration

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

Property Value

Type	Description
bool

TextExcerpt

Gets or Sets TextExcerpt

Declaration

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

Property Value

Type	Description
string

To

Gets or Sets To

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<T><string>

Methods

Equals(EmailProjection)

Returns true if EmailProjection instances are equal

Declaration

public bool Equals(EmailProjection input)

Parameters

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