KABC::DistributionList Class Reference

#include <distributionlist.h>

Classes
class	Entry

Public Member Functions
	DistributionList (Resource *resource, const QString &name)
	DistributionList (Resource *resource, const QString &identifier, const QString &name)
	~DistributionList ()
QStringList	emails () const
Entry::List	entries () const
QString	identifier () const
void	insertEntry (const Addressee &, const QString &email=QString())
QString	name () const
void	removeEntry (const Addressee &, const QString &email=QString())
Resource *	resource () const
void	setIdentifier (const QString &identifier)
void	setName (const QString &)

Detailed Description

Distribution list of email addresses.

This class represents a list of email addresses. Each email address is associated with an address book entry. If the address book entry changes, the entry in the distribution list is automatically updated.

Definition at line 45 of file distributionlist.h.

Constructor & Destructor Documentation

DistributionList::DistributionList	(	Resource *	resource,
		const QString &	name
	)

Create distribution list object.

Parameters

resource	The resource the list belongs to.
name	Name of this list.

Definition at line 99 of file distributionlist.cpp.

DistributionList::DistributionList	(	Resource *	resource,
		const QString &	identifier,
		const QString &	name
	)

Create distribution list object.

Parameters

resource	The resource the list belongs to.
identifier	Identifier of this list.
name	Name of this list.

Definition at line 105 of file distributionlist.cpp.

DistributionList::~DistributionList

(

)

Destructor.

Definition at line 112 of file distributionlist.cpp.

Member Function Documentation

QStringList DistributionList::emails

(

)

const

Return list of email addresses, which belong to this distributon list.

These addresses can be directly used by e.g. a mail client.

Definition at line 174 of file distributionlist.cpp.

DistributionList::Entry::List DistributionList::entries

(

)

const

Return list of entries belonging to this distribution list.

This function is mainly useful for a distribution list editor.

Definition at line 192 of file distributionlist.cpp.

QString DistributionList::identifier

(

)

const

Returns the distribution list's identifier.

Definition at line 126 of file distributionlist.cpp.

void DistributionList::insertEntry	(	const Addressee &	a,
		const QString &	email = QString()
	)

Insert an entry into this distribution list.

If the entry already exists nothing happens.

Parameters

email

Email address to use for comparison with already inserted entries. If the same addressee is already in the list but the email is not the same, insert it again, otherwise update the already existing entry

We have to check if both email addresses contains no data, a simple 'email1 == email2' wont work here

Definition at line 141 of file distributionlist.cpp.

QString DistributionList::name

(

)

const

Get name of this list.

Definition at line 136 of file distributionlist.cpp.

void DistributionList::removeEntry	(	const Addressee &	a,
		const QString &	email = QString()
	)

Remove an entry from this distribution list.

If the entry doesn't exist nothing happens.

Parameters

email

Email address to use as an additional check, since the same addressee entry can be in the list multiple times but with different emails

Definition at line 163 of file distributionlist.cpp.

void DistributionList::setIdentifier

(

const QString &

identifier

)

Sets the identifier of this list which is used as key by resources.

Parameters

identifier

A unique identifier of the distribution list

Definition at line 121 of file distributionlist.cpp.

void DistributionList::setName

(

const QString &

name

)

Set name of this list.

This is a i18n string for display to the user

Definition at line 131 of file distributionlist.cpp.

---

The documentation for this class was generated from the following files:

• distributionlist.h
• distributionlist.cpp