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

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

Constructors

EmailProjection()

Initializes a new instance of the EmailProjection class.

Declaration

[JsonConstructor]
protected EmailProjection()

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

Initializes a new instance of the EmailProjection class.

Declaration

public EmailProjection(Sender sender = null, EmailRecipients recipients = null, List<string> attachments = null, Guid inboxId = default, DateTime createdAt = default, List<string> to = null, List<string> cc = null, List<string> bcc = null, string messageId = null, Guid? domainId = null, bool? favourite = null, string inReplyTo = null, Guid? plusAddress = null, long? sizeBytes = null, bool read = false, string bodyExcerpt = null, string textExcerpt = null, List<string> bodyPartContentTypes = null, string bodyMD5Hash = null, bool teamAccess = false, string subject = null, Guid id = default, Guid? threadId = null, string from = null)

Parameters

Type	Name	Description
Sender	sender	sender.
EmailRecipients	recipients	recipients.
List<string>	attachments	attachments.
Guid	inboxId	inboxId (required).
DateTime	createdAt	createdAt (required).
List<string>	to	to (required).
List<string>	cc	cc.
List<string>	bcc	bcc.
string	messageId	messageId.
Guid?	domainId	domainId.
bool?	favourite	favourite.
string	inReplyTo	inReplyTo.
Guid?	plusAddress	plusAddress.
long?	sizeBytes	sizeBytes.
bool	read	read (required).
string	bodyExcerpt	bodyExcerpt.
string	textExcerpt	textExcerpt.
List<string>	bodyPartContentTypes	bodyPartContentTypes.
string	bodyMD5Hash	bodyMD5Hash.
bool	teamAccess	teamAccess (required).
string	subject	subject.
Guid	id	id (required).
Guid?	threadId	threadId.
string	from	from (required).

Properties

Attachments

Gets or Sets Attachments

Declaration

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

Property Value

Type	Description
List<string>

Bcc

Gets or Sets Bcc

Declaration

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

Property Value

Type	Description
List<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

BodyPartContentTypes

Gets or Sets BodyPartContentTypes

Declaration

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

Property Value

Type	Description
List<string>

Cc

Gets or Sets Cc

Declaration

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

Property Value

Type	Description
List<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
Guid?

Favourite

Gets or Sets Favourite

Declaration

[DataMember(Name = "favourite", EmitDefaultValue = true)]
public bool? Favourite { get; set; }

Property Value

Type	Description
bool?

From

Gets or Sets From

Declaration

[DataMember(Name = "from", IsRequired = true, 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
Guid

InReplyTo

Gets or Sets InReplyTo

Declaration

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

Property Value

Type	Description
string

InboxId

Gets or Sets InboxId

Declaration

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

Property Value

Type	Description
Guid

MessageId

Gets or Sets MessageId

Declaration

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

Property Value

Type	Description
string

PlusAddress

Gets or Sets PlusAddress

Declaration

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

Property Value

Type	Description
Guid?

Read

Gets or Sets Read

Declaration

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

Property Value

Type	Description
bool

Recipients

Gets or Sets Recipients

Declaration

[DataMember(Name = "recipients", EmitDefaultValue = true)]
public EmailRecipients Recipients { get; set; }

Property Value

Type	Description
EmailRecipients

Sender

Gets or Sets Sender

Declaration

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

Property Value

Type	Description
Sender

SizeBytes

Gets or Sets SizeBytes

Declaration

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

Property Value

Type	Description
long?

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

ThreadId

Gets or Sets ThreadId

Declaration

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

Property Value

Type	Description
Guid?

To

Gets or Sets To

Declaration

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

Property Value

Type	Description
List<string>

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