transportjob.h 2.77 KB
Newer Older
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
  /*
    Copyright (c) 2007 Volker Krause <vkrause@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 KPIM_TRANSPORTJOB_H
#define KPIM_TRANSPORTJOB_H

#include <mailtransport/mailtransport_export.h>
#include <kcompositejob.h>
#include <QStringList>

class QBuffer;

namespace KPIM {

class Transport;

/**
  Abstract base class for all mail transport jobs.
  This is a job that is supposed to send exactly one mail.
*/
class MAILTRANSPORT_EXPORT TransportJob : public KCompositeJob
{
  public:
    /**
      Creates a new mail transport job.
      @param transport The transport configuration.
      @param parent The parent object.
    */
    TransportJob( Transport* transport, QObject* parent = 0 );

Volker Krause's avatar
Volker Krause committed
47
48
49
50
51
    /**
      Deletes this transport job.
    */
    virtual ~TransportJob();

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
    /**
      Sets the sender of the mail.
    */
    void setSender( const QString &sender );

    /**
      Sets the "To" receiver(s) of the mail.
    */
    void setTo( const QStringList &to );

    /**
      Sets the "Cc" receiver(s) of the mail.
    */
    void setCc( const QStringList &cc );

    /**
      Sets the "Bcc" receiver(s) of the mail.
    */
    void setBcc( const QStringList &bcc );

    /**
      Sets the content of the mail.
    */
    void setData( const QByteArray &data );

  protected:
    /**
      Returns the Transport object containing the mail transport settings.
    */
    Transport* transport() const;

    /**
      Returns the sender of the mail.
    */
    QString sender() const;

    /**
      Returns the "To" receiver(s) of the mail.
    */
    QStringList to() const;

    /**
      Returns the "Cc" receiver(s) of the mail.
    */
    QStringList cc() const;

    /**
      Returns the "Bcc" receiver(s) of the mail.
    */
    QStringList bcc() const;

    /**
      Returns the data of the mail.
    */
    QByteArray data() const;

    /**
      Returns a QBuffer opened on the message data. This is useful for
      processing the data in smaller chunks.
    */
    QBuffer* buffer();

  private:
    class Private;
    Private* const d;
};


}

#endif