summaryrefslogtreecommitdiffstats
path: root/src/plugins/messageservices/imap/imapservice.h
blob: 7b24794af2321148e9b077a8c1ba2827ec68b235 (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Messaging Framework.
**
** $QT_BEGIN_LICENSE:LGPL21$
** 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 The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/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 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef IMAPSERVICE_H
#define IMAPSERVICE_H

#include "imapclient.h"
#include "idlenetworksession.h"
#include <qmailmessageservice.h>

class ImapService : public QMailMessageService
{
    Q_OBJECT

public:
    using QMailMessageService::updateStatus;

    ImapService(const QMailAccountId &accountId);
    ~ImapService();

    void enable();
    void disable();

    QString service() const override;
    QMailAccountId accountId() const override;

    bool hasSource() const override;
    QMailMessageSource &source() const override;

    bool available() const override;

public slots:
    bool cancelOperation(QMailServiceAction::Status::ErrorCode code, const QString &text) override;
    virtual void restartPushEmail();
    virtual void initiatePushEmail();

protected slots:
    virtual void accountsUpdated(const QMailAccountIdList &ids);
    void errorOccurred(int code, const QString &text);
    void errorOccurred(QMailServiceAction::Status::ErrorCode code, const QString &text);

    void updateStatus(const QString& text);
    // Only used for IMAP IDLE, network session for other request types are managed by the caller.
    void createIdleSession();
    void openIdleSession();
    void closeIdleSession();

private slots:
    void onOnlineStateChanged(bool isOnline);
    void onSessionOpened();
    void onSessionStateChanged(IdleNetworkSession::State status);
    void onSessionError(IdleNetworkSession::Error error);
    void onSessionConnectionTimeout();

private:
    class Source;
    friend class Source;

    bool accountPushEnabled();
    void retryPushEmail();
    void setPersistentConnectionStatus(bool status);
    void enablePushEmail();
    void disablePushEmail();

    QMailAccountId _accountId;
    ImapClient *_client;
    Source *_source;
    QTimer *_restartPushEmailTimer;
    bool _establishingPushEmail;
    bool _idling;
    int _pushRetry;
    bool _accountWasPushEnabled;
    QStringList _previousPushFolders;
    enum { ThirtySeconds = 30 };
    IdleNetworkSession              *_networkSession;          // IDLE network session
    QTimer                          *_networkSessionTimer;
};

class ImapServicePlugin : public QMailMessageServicePlugin
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.ImapServicePluginHandlerFactoryInterface")

public:
    ImapServicePlugin();

    QString key() const override;
    bool supports(QMailMessageServiceFactory::ServiceType type) const override;
    bool supports(QMailMessage::MessageType type) const override;

    QMailMessageService *createService(const QMailAccountId &id) override;
    QMailMessageServiceConfigurator *createServiceConfigurator() override;
};


#endif