Class PageEmailProjection

Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full email entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments.

Inheritance
object
PageEmailProjection
Implements
System.ComponentModel.DataAnnotations.IValidatableObject
Inherited Members
object.Equals(object, object)
object.MemberwiseClone()
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "PageEmailProjection")]
public class PageEmailProjection : IEquatable<PageEmailProjection>, IValidatableObject

Constructors

View Source

PageEmailProjection()

Initializes a new instance of the PageEmailProjection class.

Declaration
[JsonConstructor]
protected PageEmailProjection()
View Source

PageEmailProjection(List<EmailProjection>, PageableObject, int, long, bool, int, bool, int, int, SortObject, bool)

Initializes a new instance of the PageEmailProjection class.

Declaration
public PageEmailProjection(List<EmailProjection> content = null, PageableObject pageable = null, int totalPages = 0, long totalElements = 0, bool last = false, int numberOfElements = 0, bool first = false, int size = 0, int number = 0, SortObject sort = null, bool empty = false)
Parameters
Type Name Description
System.Collections.Generic.List<T><EmailProjection> content

content.
PageableObject pageable

pageable.
int totalPages

totalPages (required).
long totalElements

totalElements (required).
bool last

last.
int numberOfElements

numberOfElements.
bool first

first.
int size

size.
int number

number.
SortObject sort

sort.
bool empty

empty.

Properties

View Source

Content

Gets or Sets Content

Declaration
[DataMember(Name = "content", EmitDefaultValue = false)]
public List<EmailProjection> Content { get; set; }
Property Value
Type Description
System.Collections.Generic.List<T><EmailProjection>
View Source

Empty

Gets or Sets Empty

Declaration
[DataMember(Name = "empty", EmitDefaultValue = true)]
public bool Empty { get; set; }
Property Value
Type Description
bool
View Source

First

Gets or Sets First

Declaration
[DataMember(Name = "first", EmitDefaultValue = true)]
public bool First { get; set; }
Property Value
Type Description
bool
View Source

Last

Gets or Sets Last

Declaration
[DataMember(Name = "last", EmitDefaultValue = true)]
public bool Last { get; set; }
Property Value
Type Description
bool
View Source

Number

Gets or Sets Number

Declaration
[DataMember(Name = "number", EmitDefaultValue = false)]
public int Number { get; set; }
Property Value
Type Description
int
View Source

NumberOfElements

Gets or Sets NumberOfElements

Declaration
[DataMember(Name = "numberOfElements", EmitDefaultValue = false)]
public int NumberOfElements { get; set; }
Property Value
Type Description
int
View Source

Pageable

Gets or Sets Pageable

Declaration
[DataMember(Name = "pageable", EmitDefaultValue = false)]
public PageableObject Pageable { get; set; }
Property Value
Type Description
PageableObject
View Source

Size

Gets or Sets Size

Declaration
[DataMember(Name = "size", EmitDefaultValue = false)]
public int Size { get; set; }
Property Value
Type Description
int
View Source

Sort

Gets or Sets Sort

Declaration
[DataMember(Name = "sort", EmitDefaultValue = false)]
public SortObject Sort { get; set; }
Property Value
Type Description
SortObject
View Source

TotalElements

Gets or Sets TotalElements

Declaration
[DataMember(Name = "totalElements", IsRequired = true, EmitDefaultValue = true)]
public long TotalElements { get; set; }
Property Value
Type Description
long
View Source

TotalPages

Gets or Sets TotalPages

Declaration
[DataMember(Name = "totalPages", IsRequired = true, EmitDefaultValue = true)]
public int TotalPages { get; set; }
Property Value
Type Description
int

Methods

View Source

Equals(PageEmailProjection)

Returns true if PageEmailProjection instances are equal

Declaration
public bool Equals(PageEmailProjection input)
Parameters
Type Name Description
PageEmailProjection input

Instance of PageEmailProjection 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
View Source

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
Type Description
int

Hash code
Overrides
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.ComponentModel.DataAnnotations.IValidatableObject