Class MailboxEntity

This entity represent a mailbox used for importing emails in Service

Carrier object for MailboxEntity. Services for the MailboxEntity Carrier is available from the ICustomerServiceAgent.
Inheritance
Object
MailboxEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class MailboxEntity : Carrier
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }

Constructors

MailboxEntity()

Default constructor

Declaration
public MailboxEntity()
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

Properties

Address

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

Declaration
public virtual string Address { get; set; }
Property Value
Type Description
String
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

MailInFilterId

The primary key (auto-incremented)

Declaration
public virtual int MailInFilterId { get; set; }
Property Value
Type Description
Int32
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

Password

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

Declaration
public virtual string Password { get; set; }
Property Value
Type Description
String
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

Port

The port used to connect to the server

Declaration
public virtual int Port { get; set; }
Property Value
Type Description
Int32
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

Server

The email server to connect to

Declaration
public virtual string Server { get; set; }
Property Value
Type Description
String
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

ServerType

Enum indicating the protocol to use (POP/IMAP).

Declaration
public virtual MailboxType ServerType { get; set; }
Property Value
Type Description
MailboxType
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

Username

The username used to log onto the mail account

Declaration
public virtual string Username { get; set; }
Property Value
Type Description
String
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
Examples

Get MailboxEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new CustomerServiceAgent();
    var mailboxEntity = agent.GetMailboxEntity( 123 );
 }
See Also

See Also