/usr/include/KF5/AkonadiAgentBase/transportresourcebase.h is in libkf5akonadi-dev 4:15.12.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
Copyright (c) 2009 Constantin Berzan <exit3219@gmail.com>
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 AKONADI_TRANSPORTRESOURCEBASE_H
#define AKONADI_TRANSPORTRESOURCEBASE_H
#include "akonadiagentbase_export.h"
#include "item.h"
#include <QtCore/QString>
namespace Akonadi
{
class TransportResourceBasePrivate;
/**
* @short Resource implementing mail transport capability.
*
* This class allows a resource to provide mail transport (i.e. sending
* mail). A resource than can provide mail transport inherits from both
* ResourceBase and TransportResourceBase, implements the virtual method
* sendItem(), and calls itemSent() when finished sending.
*
* The resource must also have the "MailTransport" capability flag. For example
* the desktop file may contain:
\code
X-Akonadi-Capabilities=Resource,MailTransport
\endcode
*
* For an example of a transport-enabled resource, see
* kdepim/runtime/resources/mailtransport_dummy
*
* @author Constantin Berzan <exit3219@gmail.com>
* @since 4.4
*/
class AKONADIAGENTBASE_EXPORT TransportResourceBase
{
public:
/**
* Creates a new transport resource base.
*/
TransportResourceBase();
/**
* Destroys the transport resource base.
*/
virtual ~TransportResourceBase();
/**
* Describes the result of the transport process.
*/
enum TransportResult {
TransportSucceeded, ///< The transport process succeeded.
TransportFailed ///< The transport process failed.
};
/**
* This method is called when the given @p item shall be send.
* When the sending is done or an error occurred during
* sending, call itemSent() with the appropriate result flag.
*
* @param item The message item to be send.
* @see itemSent().
*/
virtual void sendItem(const Akonadi::Item &item) = 0;
/**
* This method marks the sending of the passed @p item
* as finished.
*
* @param item The item that was sent.
* @param result The result that indicates whether the sending
* was successful or not.
* @param message An optional text explanation of the result.
* @see Transport.
*/
void itemSent(const Akonadi::Item &item, TransportResult result,
const QString &message = QString());
private:
//@cond PRIVATE
TransportResourceBasePrivate *const d;
//@endcond
};
}
#endif
|