> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.MailboxEntity

# <a id="SuperOffice_WebApi_Data_MailboxEntity" /> Class MailboxEntity

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for MailboxEntity.
This entity represent a mailbox used for importing emails in Service

```csharp theme={null}
public class MailboxEntity : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[MailboxEntity](SuperOffice.WebApi.Data.MailboxEntity.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get MailboxEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new CustomerServiceAgent(configuration);
var mailboxEntity = agent.GetMailboxEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_MailboxEntity__ctor" /> MailboxEntity()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public MailboxEntity()
```

## Properties

### <a id="SuperOffice_WebApi_Data_MailboxEntity_Address" /> Address

The address associated with this mailbox (used as FROM: address when sending emails).

```csharp theme={null}
public virtual string Address { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_MailboxEntity_MailInFilterId" /> MailInFilterId

The primary key (auto-incremented)

```csharp theme={null}
public virtual int MailInFilterId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_MailboxEntity_Password" /> Password

The password used to log into the mail account. This is hidden when reading

```csharp theme={null}
public virtual string Password { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_MailboxEntity_Port" /> Port

The port used to connect to the server

```csharp theme={null}
public virtual int Port { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_MailboxEntity_Server" /> Server

The email server to connect to

```csharp theme={null}
public virtual string Server { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_MailboxEntity_ServerType" /> ServerType

Enum indicating the protocol to use (POP/IMAP).
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public MailboxType? ServerType { get; set; }
```

#### Property Value

[MailboxType](SuperOffice.WebApi.Data.MailboxType.md)?

#### See Also

[MailboxEntity](SuperOffice.WebApi.Data.MailboxEntity.md).[ServerType\_String](SuperOffice.WebApi.Data.MailboxEntity.md#SuperOffice_WebApi_Data_MailboxEntity_ServerType_String)

### <a id="SuperOffice_WebApi_Data_MailboxEntity_ServerType_String" /> ServerType\_String

Enum indicating the protocol to use (POP/IMAP).
Raw string enum value.

```csharp theme={null}
[JsonProperty("ServerType")]
public string ServerType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[MailboxEntity](SuperOffice.WebApi.Data.MailboxEntity.md).[ServerType](SuperOffice.WebApi.Data.MailboxEntity.md#SuperOffice_WebApi_Data_MailboxEntity_ServerType)

### <a id="SuperOffice_WebApi_Data_MailboxEntity_Username" /> Username

The username used to log onto the mail account

```csharp theme={null}
public virtual string Username { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

## See Also

[CustomerServiceAgent](SuperOffice.WebApi.Agents.CustomerServiceAgent.md)


## Related topics

- [SuperOffice.WebApi.Agents.ICustomerServiceAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ICustomerServiceAgent.md)
- [SuperOffice.WebApi.Agents.CustomerServiceAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.CustomerServiceAgent.md)
- [SuperOffice.WebApi.Data.Mailbox](/en/api/reference/webapi/SuperOffice.WebApi.Data.Mailbox.md)
- [SuperOffice.WebApi.Data.MailboxType](/en/api/reference/webapi/SuperOffice.WebApi.Data.MailboxType.md)
- [SuperOffice.WebApi.Data.CustomerService GetMailboxesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomerService_GetMailboxesRequest.md)
- [SuperOffice.WebApi.Data.UserPreferenceStrings.HugoAI](/en/api/reference/webapi/SuperOffice.WebApi.Data.UserPreferenceStrings.HugoAI.md)