/usr/include/Wt/Mail/Client is in libwt-dev 3.3.6+dfsg-1.1.
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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2011 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WT_MAIL_CLIENT_H_
#define WT_MAIL_CLIENT_H_
#include <string>
#include <Wt/WDllDefs.h>
namespace Wt {
/*! \brief Namespace for the \ref mail
*/
namespace Mail {
class Message;
/*! \defgroup mail SMTP client library (Wt::Mail)
* \brief An SMTP client implementation.
*/
/*! \class Client Wt/Mail/Client Wt/Mail/Client
* \brief An SMTP mail client.
*
* The SMTP client can send one or more mail messages to an SMTP host.
*
* \code
* #include <Wt/Mail/Client>
* #include <Wt/Mail/Message>
*
* Mail::Message message;
* message.setFrom(Mail::Mailbox("kudos@corp.org", "Kudos Dukos");
* message.addRecipient(Mail::To, Mail::Mailbox("koen@emweb.be", "Koen Deforche");
* message.setSubject("Hey there, koen!");
* message.setBody("That mail client seems to be working.");
* message.addHtmlBody ("<p>"
* "<a href=\"http://www.webtoolkit.eu/wt\">That mail client</a>"
* " seems to be working just great!</p>");
*
* Mail::Client client;
* client.connect("localhost");
* client.send(message);
* \endcode
*
* Only the bare essentials of the SMTP protocol are current implemented,
* although the Message itself supports proper unicode handling.
*
* \note Currently only a plain-text SMTP protocol is supported. SSL
* transport will be added in the future.
*
* \note Currently the client sends an email synchronously, and thus a slow
* connection to the SMTP server may block the current thread. We plan
* to change this in the future. It is thus beneficial to connect to a
* local SMTP daemon to minimize this deficiency.
*
* \ingroup mail
*/
class WT_API Client
{
public:
/*! \brief Constructor.
*
* The \p selfHost is how the mail client will identify itself to the
* mail server, in the EHLO command.
*
* If not defined, the "smtp-self-host" configuration property is used, and
* if that property is not defined, it defaults to "localhost".
*/
Client(const std::string& selfHost = std::string());
/*! \brief Destructor.
*
* If the client is still connected, this disconnects the client.
*/
~Client();
/*! \brief Connects to the default SMTP server.
*
* This connects to the SMTP server defined by the "smtp-host"
* property, on port defined by the "smtp-port" property. If these
* properties are not set, "localhost" and 25 are used as defaults
* respectively.
*
* Returns whether the connection could be established and the SMTP
* hand-shake was successful.
*/
bool connect();
/*! \brief Connects to a given STMP server and port.
*
* Returns whether the connection could be established and the SMTP
* hand-shake was successful.
*/
bool connect(const std::string& smtpHost, int smtpPort = 25);
/*! \brief Disconnects the client from the SMTP server.
*/
void disconnect();
/*! \brief Sends a message.
*
* The client must be connected before messages can be sent.
*
* The function returns true on success, false on error. The
* reason for the error is logged in the log file.
*/
bool send(const Message& message);
private:
Client(const Client&);
class Impl;
Impl *impl_;
std::string selfHost_;
};
}
}
#endif // WT_EMAIL_CLIENT_H_
|