API Documentation
\

\Horde_Kolab_Server_Object_Kolabpop3account

This class provides a representation of pop3 mail accounts.

Copyright 2008-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
getFilter()
prepareObjectInformation()
getActions()
__construct()
getGuid()
getExternalAttributes()
getInternalAttributes()
exists()
readInternal()
getInternal()
getExternal()
save()
delete()
generateId()
getSearchOperations()
pop3AccountsForMail()
$attributes
$object_classes
$sort_by
$init_attributes
OBJECTCLASS_TOP
ATTRIBUTE_SERVER
ATTRIBUTE_LOGINNAME
ATTRIBUTE_PASSWORD
ATTRIBUTE_DESCRIPTION
ATTRIBUTE_MAIL
ATTRIBUTE_PORT
ATTRIBUTE_USESSL
ATTRIBUTE_USETLS
ATTRIBUTE_LOGINMETHOD
ATTRIBUTE_CHECKCERTIFICATE
ATTRIBUTE_KEEPMAILONSERVER
ATTRIBUTE_OWNERUID
OBJECTCLASS_KOLABEXTERNALPOP3ACCOUNT
getNewInternal()
$guid
N/A
No private methods found
$_composite
N/A

Constants

OBJECTCLASS_TOP

OBJECTCLASS_TOP

Define the possible Kolab object classes

ATTRIBUTE_SERVER

ATTRIBUTE_SERVER

Server the account resides on

ATTRIBUTE_LOGINNAME

ATTRIBUTE_LOGINNAME

User name for the account

ATTRIBUTE_PASSWORD

ATTRIBUTE_PASSWORD

Password for the account

ATTRIBUTE_DESCRIPTION

ATTRIBUTE_DESCRIPTION

Description of the account

ATTRIBUTE_MAIL

ATTRIBUTE_MAIL

Mail address of the account

ATTRIBUTE_PORT

ATTRIBUTE_PORT

Port to connect to

ATTRIBUTE_USESSL

ATTRIBUTE_USESSL

Use SSL when fetching mail from the account?

ATTRIBUTE_USETLS

ATTRIBUTE_USETLS

Use TLS when fetching mail from the account?

ATTRIBUTE_LOGINMETHOD

ATTRIBUTE_LOGINMETHOD

Login method for the external account

ATTRIBUTE_CHECKCERTIFICATE

ATTRIBUTE_CHECKCERTIFICATE

Validate the server certificate when connecting via SSL/TLS?

ATTRIBUTE_KEEPMAILONSERVER

ATTRIBUTE_KEEPMAILONSERVER

Should the fetched mail be deleted on the external account or not?

ATTRIBUTE_OWNERUID

ATTRIBUTE_OWNERUID

The uid of the owner of this account

OBJECTCLASS_KOLABEXTERNALPOP3ACCOUNT

OBJECTCLASS_KOLABEXTERNALPOP3ACCOUNT

The specific object class of this object type

Properties

$attributes

$attributes : array

The attributes defined for this class.

Type

array

$object_classes

$object_classes :

Type

$sort_by

$sort_by : string

Sort by this attributes.

Type

string

$init_attributes

$init_attributes : array

A structure to initialize the attribute structure for this class.

Type

array

$guid

$guid : string

GUID of this object on the Kolab server.

Type

string

Methods

getFilter()

getFilter() : string

Return the filter string to retrieve this object type.

Returns

string —

The filter to retrieve this object type from the server database.

prepareObjectInformation()

prepareObjectInformation(array  $info) : \NULL.

Distill the server side object information to save.

Parameters

array $info

Throws

\Horde_Kolab_Server_Exception

If the given information contains errors.

Returns

\NULL.

getActions()

getActions() : array

Returns the set of actions supported by this object type.

Returns

array —

An array of supported actions.

__construct()

__construct(\Horde_Kolab_Server_Composite  $composite, string  $guid = null)

Initialize the Kolab Object. Provide either the GUID

Parameters

\Horde_Kolab_Server_Composite $composite

The link to the Kolab server.
string $guid

GUID of the object.

getGuid()

getGuid() : string

Get the GUID of this object

Returns

string —

the GUID of this object

getExternalAttributes()

getExternalAttributes() : array

Get the external attributes supported by this object.

Returns

array —

The external attributes supported by this object. This is a list of abbreviated attribute class names.

getInternalAttributes()

getInternalAttributes() : array

Get the internal attributes supported by this object.

Returns

array —

The internal attributes supported by this object.

exists()

exists() : boolean

Does the object exist?

Returns

boolean —

True if the object exists, false otherwise.

readInternal()

readInternal() : array

Read the object data.

Returns

array —

The read data.

getInternal()

getInternal(array  $attributes) : array

Get the specified internal attributes.

Parameters

array $attributes

The internal attribute.

Returns

array —

The value(s) of these attribute

getExternal()

getExternal(string  $attr) : mixed

Get the specified attribute of this object.

Parameters

string $attr

The attribute to read.

Returns

mixed —

The value of this attribute.

save()

save(array  $info) : NULL

Saves object information. This may either create a new entry or modify an existing entry.

Please note that fields with multiple allowed values require the callee to provide the full set of values for the field. Any old values that are not resubmitted will be considered to be deleted.

Parameters

array $info

The information about the object.

Throws

\Horde_Kolab_Server_Exception

If saving the data failed.

Returns

NULL

delete()

delete() : NULL

Delete this object.

Throws

\Horde_Kolab_Server_Exception

If deleting the object failed.

Returns

NULL

generateId()

generateId(array  $info) : string|\PEAR_Error

Generates an ID for the given information.

Parameters

array $info

Returns

string|\PEAR_Error —

The ID.

getSearchOperations()

getSearchOperations() : array

Returns the set of search operations supported by this object type.

Returns

array —

An array of supported search operations.

pop3AccountsForMail()

pop3AccountsForMail(\Horde_Kolab_Server  $server, string  $mail) : mixed

Returns the UIDs of the pop3 accounts for the user with the given mail address.

Parameters

\Horde_Kolab_Server $server

The server to query.
string $mail

Search objects with this mail alias.

Throws

\Horde_Kolab_Server_Exception

Returns

mixed —

The UIDs or false if there was no result.

getNewInternal()

getNewInternal(array  $info) : NULL

Transform the given data array into the new internal dataset.

Parameters

array $info

The information about the object.

Throws

\Horde_Kolab_Server_Exception

If transforming the data failed.

Returns

NULL