Class OrganizationInboxProjection

Organization team inbox

Inheritance

object

OrganizationInboxProjection

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

Constructors

View Source

OrganizationInboxProjection()

Initializes a new instance of the OrganizationInboxProjection class.

Declaration

[JsonConstructor]
protected OrganizationInboxProjection()

View Source

OrganizationInboxProjection(Guid, Guid?, DateTime, string, string, bool, List<string>, bool, InboxTypeEnum?, bool, bool, FunctionsAsEnum?, Guid, string, DateTime?, AccountRegionEnum?)

Initializes a new instance of the OrganizationInboxProjection class.

Declaration

public OrganizationInboxProjection(Guid id = default, Guid? domainId = null, DateTime createdAt = default, string name = null, string emailAddress = null, bool favourite = false, List<string> tags = null, bool teamAccess = false, OrganizationInboxProjection.InboxTypeEnum? inboxType = null, bool readOnly = false, bool virtualInbox = false, OrganizationInboxProjection.FunctionsAsEnum? functionsAs = null, Guid userId = default, string description = null, DateTime? expiresAt = null, OrganizationInboxProjection.AccountRegionEnum? accountRegion = null)

Parameters

Type	Name	Description
Guid	id	ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically. (required).
Guid?	domainId	ID of custom domain used by the inbox if any.
DateTime	createdAt	When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`. (required).
string	name	Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search.
string	emailAddress	The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (required).
bool	favourite	Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering (required).
List<string>	tags	Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI..
bool	teamAccess	Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/ (required).
OrganizationInboxProjection.InboxTypeEnum?	inboxType	Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send)..
bool	readOnly	Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes. (required).
bool	virtualInbox	Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions. (required).
OrganizationInboxProjection.FunctionsAsEnum?	functionsAs	Inbox function if used as a primitive for another system..
Guid	userId	ID of user that inbox belongs to (required).
string	description	Description of an inbox for labelling and searching purposes.
DateTime?	expiresAt	Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email..
OrganizationInboxProjection.AccountRegionEnum?	accountRegion	Region of the inbox.

Properties

View Source

AccountRegion

Region of the inbox

Declaration

[DataMember(Name = "accountRegion", EmitDefaultValue = true)]
public OrganizationInboxProjection.AccountRegionEnum? AccountRegion { get; set; }

Property Value

Type	Description
OrganizationInboxProjection.AccountRegionEnum?	Region of the inbox

View Source

CreatedAt

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX e.g. 2000-10-31T01:30:00.000-05:00.

Declaration

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

Property Value

Type	Description
DateTime	When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.

View Source

Description

Description of an inbox for labelling and searching purposes

Declaration

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

Property Value

Type	Description
string	Description of an inbox for labelling and searching purposes

View Source

DomainId

ID of custom domain used by the inbox if any

Declaration

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

Property Value

Type	Description
Guid?	ID of custom domain used by the inbox if any

View Source

EmailAddress

The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so +123 additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.

Declaration

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

Property Value

Type Description

Type	Description
string	The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.

string

View Source

ExpiresAt

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.

Declaration

[DataMember(Name = "expiresAt", EmitDefaultValue = true)]
public DateTime? ExpiresAt { get; set; }

Property Value

Type	Description
DateTime?	Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.

Type

Description

DateTime?

View Source

Favourite

Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering

Declaration

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

Property Value

Type	Description
bool	Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering

View Source

FunctionsAs

Inbox function if used as a primitive for another system.

Declaration

[DataMember(Name = "functionsAs", EmitDefaultValue = true)]
public OrganizationInboxProjection.FunctionsAsEnum? FunctionsAs { get; set; }

Property Value

Type	Description
OrganizationInboxProjection.FunctionsAsEnum?	Inbox function if used as a primitive for another system.

View Source

Id

ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods waitForLatestEmail and getEmails methods respectively. Inboxes can be used with aliases to forward emails automatically.

Declaration

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

Property Value

Type	Description
Guid	ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.

View Source

InboxType

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).

Declaration

[DataMember(Name = "inboxType", EmitDefaultValue = true)]
public OrganizationInboxProjection.InboxTypeEnum? InboxType { get; set; }

Property Value

Type	Description
OrganizationInboxProjection.InboxTypeEnum?	Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).

View Source

Name

Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search

Declaration

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

Property Value

Type	Description
string	Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search

View Source

ReadOnly

Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.

Declaration

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

Property Value

Type	Description
bool	Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.

View Source

Type	Description
List<string>	Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.

TeamAccess

Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/

Declaration

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

Property Value

Type	Description
bool	Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/

View Source

UserId

ID of user that inbox belongs to

Declaration

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

Property Value

Type	Description
Guid	ID of user that inbox belongs to

View Source

VirtualInbox

Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.

Declaration

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

Property Value

Type	Description
bool	Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.

Methods

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

Implements

IValidatableObject

Class OrganizationInboxProjection

Inheritance

Implements

Inherited Members

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

Constructors

OrganizationInboxProjection()

Declaration

OrganizationInboxProjection(Guid, Guid?, DateTime, string, string, bool, List<string>, bool, InboxTypeEnum?, bool, bool, FunctionsAsEnum?, Guid, string, DateTime?, AccountRegionEnum?)

Declaration

Parameters

Properties

AccountRegion

Declaration

Property Value

CreatedAt

Declaration

Property Value

Description

Declaration

Property Value

DomainId

Declaration

Property Value

EmailAddress

Declaration

Property Value

ExpiresAt

Declaration

Property Value

Favourite

Declaration

Property Value

FunctionsAs

Declaration

Property Value

Id

Declaration

Property Value

InboxType

Declaration

Property Value

Name

Declaration

Property Value

ReadOnly

Declaration

Property Value

Tags

Declaration

Property Value

TeamAccess

Declaration

Property Value

UserId

Declaration

Property Value

VirtualInbox

Declaration

Property Value

Methods

ToJson()

Declaration

Returns

ToString()

Declaration

Returns

Overrides

Implements