AfterLogic API Documentation
  • Package
  • Class

Packages

  • Calendar
    • Classes
    • Storages
  • Capability
  • Channels
    • Classes
    • Storages
  • Collaboration
  • Contacts
    • Helpers
    • Storages
  • Dav
  • Db
    • Classes
    • Enum
    • Storages
  • Domains
    • Classes
    • Storages
  • Fetchers
    • Classes
    • Storages
  • Filecache
    • Storages
  • Filestorage
    • Classes
    • Storages
  • GContacts
    • Storages
  • Helpdesk
    • Classes
    • Enum
    • Storages
  • Integrator
  • IOS
  • Logger
  • Mail
    • Classes
    • Enum
    • Storages
  • Mailsuite
    • Classes
    • Storages
  • Min
    • Storages
  • Sieve
    • Classes
    • Enum
  • Social
    • Classes
    • Storages
  • Subscription
    • Classes
  • Subscriptions
    • Storages
  • Tenants
    • Classes
    • Storages
  • Twofactorauth
    • Classes
    • Storages
  • Users
    • Classes
    • Enum
    • Storages
  • Voice
  • WebMail
    • Storages

Classes

  • CAccount
  • CCalUser
  • CIdentity
  • CUser

Class CIdentity

api_AContainer
Extended by CIdentity
Package: Users\Classes
Located at users/classes/identity.php

Methods summary

public
# __construct( CDomain $oDomain,… )

Creates a new instance of the object.

Creates a new instance of the object.

Parameters

$oDomain,…
CDomain object for the identity.
public boolean
# isValid( )

Checks if the identity has only valid data.

Checks if the identity has only valid data.

Returns

boolean
public string
# getFriendlyEmail( )

If display name is non-empty, returns email address with display name attached; otherwise, just the email.

If display name is non-empty, returns email address with display name attached; otherwise, just the email.

Returns

string
public array
# getMap( )

Obtains static map of identity fields. Function with the same name is used for other objects in a unified container api_AContainer.

Obtains static map of identity fields. Function with the same name is used for other objects in a unified container api_AContainer.

Returns

array
public static array
# getStaticMap( )

Obtains static map of identity fields.

Obtains static map of identity fields.

Returns

array

Properties summary

Magic properties

public integer $IdIdentity

Identifier of identity.

public integer $IdUser

Identifier of user wich contains the identity.

public integer $IdAccount

Identifier of account wich contains the identity.

public boolean $Virtual

If true the identity is not present in the database.

public boolean $Enabled

If true the identity is enabled for using.

public string $Email

Email of identity.

public string $FriendlyName

Display name of identity.

public string $Signature

Signature of identity.

public integer $SignatureType

Deprecated.

public boolean $UseSignature

If true and this identity is used for message sending the identity signature will be attached to message body.

AfterLogic API Documentation API documentation generated by ApiGen