Attica 5.109.0
Public Types | Public Member Functions | List of all members
Attica::Folder

Represents a single mail folder. More...

#include <Attica/Folder>

Public Types

typedef QList< FolderList
 

Public Member Functions

 Folder ()
 Creates an empty Folder.
 
 Folder (const Folder &other)
 Copy constructor.
 
 ~Folder ()
 Destructor.
 
QString id () const
 Gets the id of the Folder.
 
bool isValid () const
 Checks whether this Folder has an id.
 
int messageCount () const
 Gets the number of messages in the Folder.
 
QString name () const
 Gets the name of the Folder.
 
Folderoperator= (const Folder &other)
 Assignment operator.
 
void setId (const QString &id)
 Sets the id of the Folder.
 
void setMessageCount (int messageCount)
 Sets the number of messages in the Folder.
 
void setName (const QString &name)
 Sets the name of the Folder.
 
void setType (const QString &type)
 Sets the type of the folder.
 
QString type () const
 Gets the type of the Folder.
 

Detailed Description

Represents a single mail folder.

Constructor & Destructor Documentation

◆ Folder() [1/2]

Attica::Folder::Folder ( )

Creates an empty Folder.

◆ Folder() [2/2]

Attica::Folder::Folder ( const Folder other)

Copy constructor.

Parameters
otherthe Folder to copy from

◆ ~Folder()

Attica::Folder::~Folder ( )

Destructor.

Member Function Documentation

◆ id()

QString Attica::Folder::id ( ) const

Gets the id of the Folder.

The id uniquely identifies a Folder with the OCS API.

Returns
the id

◆ isValid()

bool Attica::Folder::isValid ( ) const

Checks whether this Folder has an id.

Returns
true if an id has been set, false otherwise

◆ messageCount()

int Attica::Folder::messageCount ( ) const

Gets the number of messages in the Folder.

Returns
the number of messages

◆ name()

QString Attica::Folder::name ( ) const

Gets the name of the Folder.

Returns
the name

◆ operator=()

Folder & Attica::Folder::operator= ( const Folder other)

Assignment operator.

Parameters
otherthe Folder to assign from
Returns
pointer to this Folder

◆ setId()

void Attica::Folder::setId ( const QString &  id)

Sets the id of the Folder.

The id uniquely identifies a Folder with the OCS API.

Parameters
idthe new id

◆ setMessageCount()

void Attica::Folder::setMessageCount ( int  messageCount)

Sets the number of messages in the Folder.

Parameters
messageCountthe new number of messages

◆ setName()

void Attica::Folder::setName ( const QString &  name)

Sets the name of the Folder.

Parameters
namethe new name

◆ setType()

void Attica::Folder::setType ( const QString &  type)

Sets the type of the folder.

Parameters
typethe new type

◆ type()

QString Attica::Folder::type ( ) const

Gets the type of the Folder.

Returns
the type