summaryrefslogtreecommitdiffstats
path: root/src/messaging/qmessageaccount.cpp
blob: 1161d344f2ddccfdb1b2f7e68c67e0239bebb004 (plain)
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
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qmessageaccount.h"

/*!
    \class QMessageAccount

    \brief The QMessageAccount class represents a messaging account in the messaging store.

    \inmodule QtMessaging

    \ingroup messaging
    \since 1.0

    A QMessageAccount is a logical entity that groups messages according to the
    method by which they are sent and received.  An account may either transmit messages
    receive messages or both.

    The QMessageAccount class is used for accessing properties of the account related
    to dealing with the account's folders and messages, rather than for modifying
    the account itself.

    \sa QMessageManager::account()
*/

/*!
    \fn QMessageAccount::QMessageAccount()

    Creates an empty and invalid account object.
*/

/*!
    \fn QMessageAccount::QMessageAccount(const QMessageAccountId &id)


    Convenience constructor that creates a QMessageAccount by loading the data from the messaging
    store as specified by the QMessageAccountId \a id. If the account does not exist in the
    store, then this constructor will create an empty and invalid QMessageAccount.

    \since 1.0
    \sa QMessageManager::account()
*/

/*!
    \fn QMessageAccount::QMessageAccount(const QMessageAccount &other)

    Constructs a copy of \a other.
    \since 1.0
*/

/*!
    \internal
    \fn QMessageAccount::operator=(const QMessageAccount& other)
    \since 1.0
*/

/*!
    \fn QMessageAccount::~QMessageAccount()

    Destroys the account object.
*/

/*!
    \fn QMessageAccount::id() const

    Returns the identifier for this account.
    \since 1.0
*/

/*!
    \fn QMessageAccount::name() const

    Returns the name of the account for display purposes.
    \since 1.0
*/

/*!
    \fn QMessageAccount::messageTypes() const

    Returns the types of messages this account handles.
    \since 1.0
*/

/*!
    \fn QMessageAccount::defaultAccount(QMessage::Type type)

    Returns the default account for messages of type \a type.
    \since 1.0
*/