1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*
This file is part of libtdepim.
Copyright (c) 2004-2005 David Faure <faure@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef DISTRIBUTIONLIST_H
#define DISTRIBUTIONLIST_H
#include <kabc/addressee.h>
namespace KABC {
class AddressBook;
}
namespace KPIM {
/**
* @short 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.
*
* This should go into kdelibs in KDE4.
*
* @author David Faure <faure@kde.org>
*/
class DistributionList : public KABC::Addressee
{
public:
/**
* @short Distribution List Entry
*
* This class represents an entry of a distribution list. It consists of an
* addressee and an email address. If the email address is null, the
* preferred email address of the addressee is used.
*/
struct Entry
{
typedef TQValueList<Entry> List;
Entry() {}
Entry( const Addressee &_addressee, const TQString &_email ) :
addressee( _addressee ), email( _email ) {}
Addressee addressee;
TQString email;
};
typedef TQValueList<DistributionList> List;
/**
* Create a distribution list.
*/
DistributionList();
/**
* Create a distribution list from an addressee object
* (this is a kind of down-cast)
*/
DistributionList( const KABC::Addressee& addr );
/**
* Destructor.
*/
~DistributionList() {}
/// HACK: reimplemented from Addressee, but it's NOT virtual there
void setName( const TQString &name );
/// HACK: reimplemented from Addressee, but it's NOT virtual there
TQString name() const { return formattedName(); }
/**
Insert an entry into this distribution list. If the entry already exists
nothing happens.
*/
void insertEntry( const Addressee &, const TQString &email=TQString() );
/**
Remove an entry from this distribution list. If the entry doesn't exist
nothing happens.
*/
void removeEntry( const Addressee &, const TQString &email=TQString() );
/// Overload, used by resources to avoid looking up the addressee
void insertEntry( const TQString& uid, const TQString& email=TQString() );
/// Overload, used by resources to avoid looking up the addressee
void removeEntry( const TQString& uid, const TQString& email=TQString() );
/**
Return list of email addresses, which belong to this distributon list.
These addresses can be directly used by e.g. a mail client.
@param book necessary to look up entries
*/
TQStringList emails( KABC::AddressBook* book ) const;
/**
Return list of entries belonging to this distribution list. This function
is mainly useful for a distribution list editor.
@param book necessary to look up entries
*/
Entry::List entries( KABC::AddressBook* book ) const;
// KDE4: should be a method of Addressee
static bool isDistributionList( const KABC::Addressee& addr );
// KDE4: should be a method of AddressBook
static DistributionList findByName( KABC::AddressBook* book,
const TQString& name,
bool caseSensitive = true );
// KDE4: should be a method of AddressBook
// A bit slow (but no more than findByName).
// From KAddressbook, use Core::distributionLists() instead.
static TQValueList<DistributionList> allDistributionLists( KABC::AddressBook* book );
private:
// can't have any data here, use Addressee's methods instead
};
}
#endif /* DISTRIBUTIONLIST_H */
|
