|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 #include "qmessageaccount.h" |
|
42 |
|
43 /*! |
|
44 \class QMessageAccount |
|
45 |
|
46 \brief The QMessageAccount class represents a messaging account in the messaging store. |
|
47 |
|
48 \ingroup messaging |
|
49 |
|
50 A QMessageAccount is a logical entity that groups messages according to the |
|
51 method by which they are sent and received. An account may either transmit messages |
|
52 receive messages or both. |
|
53 |
|
54 The QMessageAccount class is used for accessing properties of the account related |
|
55 to dealing with the account's folders and messages, rather than for modifying |
|
56 the account itself. |
|
57 |
|
58 \sa QMessageManager::account() |
|
59 */ |
|
60 |
|
61 /*! |
|
62 \fn QMessageAccount::QMessageAccount() |
|
63 |
|
64 Creates an empty and invalid account object. |
|
65 */ |
|
66 |
|
67 /*! |
|
68 \fn QMessageAccount::QMessageAccount(const QMessageAccountId &id) |
|
69 |
|
70 |
|
71 Convenience constructor that creates a QMessageAccount by loading the data from the messaging |
|
72 store as specified by the QMessageAccountId \a id. If the account does not exist in the |
|
73 store, then this constructor will create an empty and invalid QMessageAccount. |
|
74 |
|
75 \sa QMessageManager::account() |
|
76 */ |
|
77 |
|
78 /*! |
|
79 \fn QMessageAccount::QMessageAccount(const QMessageAccount &other) |
|
80 |
|
81 Constructs a copy of \a other. |
|
82 */ |
|
83 |
|
84 /*! |
|
85 \internal |
|
86 \fn QMessageAccount::operator=(const QMessageAccount& other) |
|
87 */ |
|
88 |
|
89 /*! |
|
90 \fn QMessageAccount::~QMessageAccount() |
|
91 |
|
92 Destroys the account object. |
|
93 */ |
|
94 |
|
95 /*! |
|
96 \fn QMessageAccount::id() const |
|
97 |
|
98 Returns the identifier for this account. |
|
99 */ |
|
100 |
|
101 /*! |
|
102 \fn QMessageAccount::name() const |
|
103 |
|
104 Returns the name of the account for display purposes. |
|
105 */ |
|
106 |
|
107 /*! |
|
108 \fn QMessageAccount::messageTypes() const |
|
109 |
|
110 Returns the types of messages this account handles. |
|
111 */ |
|
112 |
|
113 /*! |
|
114 \fn QMessageAccount::defaultAccount(QMessage::Type type) |
|
115 |
|
116 Returns the default account for messages of type \a type. |
|
117 */ |