Show / Hide Table of Contents

Class EMailAccount

Properties for an email account

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

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }

Constructors

EMailAccount()

Default constructor

Declaration
public EMailAccount()
Examples

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

Properties

AccountStatus

The account status (Disabled or...) Readonly field

Declaration
public virtual short AccountStatus { get; set; }
Property Value
Type Description
Int16
Examples

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

AssociateId

Id of the associate who owns this account

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

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

EMailAccountId

The account primary key

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

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

EMailAddress

The account (from) address

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

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

ErrorCount

Count of concurring errors of fetching email. Readonly field

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

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

ErrorReason

Reason/Error message. Readonly field

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

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

InboxFolder

Inbox folder name if available in the db

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

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

IncomingCredentials

Account credentials for imap

Declaration
public virtual ServiceAuth IncomingCredentials { get; set; }
Property Value
Type Description
ServiceAuth
Examples

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

LastFetch

When we last fetched email in UTC.

Declaration
public virtual DateTime LastFetch { get; set; }
Property Value
Type Description
DateTime
Examples

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

OutgoingCredentials

Account credentials for smtp

Declaration
public virtual ServiceAuth OutgoingCredentials { get; set; }
Property Value
Type Description
ServiceAuth
Examples

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

SentFolder

Sent email folder name if available in the db

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

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

SimpleMode

Simple mode used for sending and retrieving invitations, accept/decline etc. without the full Inbox GUI experience

Declaration
public virtual short SimpleMode { get; set; }
Property Value
Type Description
Int16
Examples

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.

Examples

Get EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

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 EMailAccount 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new EMailAgent();
    var eMailAccount = agent.GetEMailAccount( 123 );
 }
See Also
EMailAgent
IEMailAgent

See Also

EMailAgent
IEMailAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top