Modules/Groupware/Email/Folder.php

Show: inherited
Table of Contents

\Conjoon_Modules_Groupware_Email_Folder

Package: Conjoon\Groupware\Email

An email folder represents an abstract storage location for email-items. It defines itself as an object with the following properties:

id : The id of the folder idForPath : As special id from which a path can be build, needed for imap protocol. name : the name of the folder isChildAllowed : wether or not this folder may have child folders isLocked : wether or not this folder is locked for editing type : the storage type the folder represents. This can be any of "inbox "outbox, "draft", "spam", "sent", "folder" childCount : The number of child folders this folder has, if any pendingCount : Depending on the folder type, "pending" denotes either the number of unread emails, or the total number of emails in this folder

Parent(s)
\Conjoon_BeanContext
Author
Thorsten-Suckow-Homberg  
Category
Conjoon_Groupware  
Uses
\Conjoon_BeanContext  

Properties

Propertyprivate  $childCount= ''
Details
Type
n/a
Propertyprivate  $id= ''
Details
Type
n/a
Propertyprivate  $idForPath= ''
Details
Type
n/a
Propertyprivate  $isChildAllowed= ''
Details
Type
n/a
Propertyprivate  $isLocked= ''
Details
Type
n/a
Propertyprivate  $isSelectable= ''
Details
Type
n/a
Propertyprivate  $name= ''
Details
Type
n/a
Propertyprivate  $pendingCount= ''
Details
Type
n/a
Propertyprivate  $type= ''
Details
Type
n/a

Methods

methodpublic__construct( ) : void

Constructor.

methodpublic__toString( ) : string

Returns a textual representation of the current object.

Returns
Type Description
string
methodpublicgetChildCount( ) : void

methodpublicgetDto( ) : \Conjoon_Groupware_Email_AccountDto

Returns a Dto for an instance of this class.

Returns
Type Description
\Conjoon_Groupware_Email_AccountDto
methodpublicgetId( ) : void

methodpublicgetIdForPath( ) : void

methodpublicgetName( ) : void

methodpublicgetPendingCount( ) : void

methodpublicgetType( ) : void

methodpublicisChildAllowed( ) : void

methodpublicisLocked( ) : void

methodpublicisSelectable( ) : void

methodpublicserialize( ) : string

Serializes properties and returns them as a string which can later on be unserialized.

Returns
Type Description
string
methodpublicsetChildAllowed(  $isChildAllowed ) : void

Parameters
Name Type Description
$isChildAllowed
methodpublicsetChildCount(  $childCount ) : void

Parameters
Name Type Description
$childCount
methodpublicsetId(  $id ) : void

Parameters
Name Type Description
$id
methodpublicsetIdForPath(  $idForPath ) : void

Parameters
Name Type Description
$idForPath
methodpublicsetLocked(  $isLocked ) : void

Parameters
Name Type Description
$isLocked
methodpublicsetName(  $name ) : void

Parameters
Name Type Description
$name
methodpublicsetPendingCount(  $pendingCount ) : void

Parameters
Name Type Description
$pendingCount
methodpublicsetSelectable(  $isSelectable ) : void

Parameters
Name Type Description
$isSelectable
methodpublicsetType(  $type ) : void

Parameters
Name Type Description
$type
methodpublictoArray( ) : array

Returns an associative array, which key/value pairs represent the properties stored by this object.

Returns
Type Description
array
methodpublicunserialize( string $serialized ) : void

Unserializes $serialized and assigns the specific values found to the members in this class.

Parameters
Name Type Description
$serialized string

The serialized representation of a former instance of this class.

Documentation was generated by DocBlox 0.18.1.