SmtpClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  SmtpClient.qm Copyright 2012 - 2023 Qore Technologies, s.r.o.
 
    Original Authors: Wolfgang Ritzinger, Marian Bonda, Pavol Potoncok
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum qore version
 
// need mime definitions
 
// need MailMessage classes
 
 
// assume local var scope, do not use "$" for vars, members, and method calls
 
 
 
namespace SmtpClient {
const DefaultReadTimeout = 15s;
 
const DefaultConnectTimeout = 30s;
 
public hashdecl SmtpResponseInfo {
    int code;
 
    string desc;
};
 
class Message : public MailMessage::Message {
 
public:
 
    constructor(string sender, string subject) ;
 
};
 
class Attachment : public MailMessage::Attachment {
 
public:
};
 
 
class SmtpClient {
 
public:
protected:
        Socket sock();
 
        // connect string
        string connect;
 
        // ensures exclusive access to the object
        Mutex mutex();
 
        bool nosend = False;
 
        // optional info log closure
        *code log_info;
 
        // optional debug log closure
        *code log_debug;
 
        // tls flag (ie \c "STARTTLS" flag; ie application layer security)
        bool tls = False;
 
        // ssl flag (for TLS/SSL connections - ie transport layer instead of application layer security)
        bool ssl = False;
 
        // esmtp flag
        bool esmtp;
 
        // authentication credentials
        *string user;
        *string pass;
 
        // logged in flag
        bool logged_in = False;
 
        // read timeout in milliseconds
        timeout readTimeout = DefaultReadTimeout;
 
        // connect timeout in milliseconds
        timeout connectTimeout = DefaultConnectTimeout;
 
        // HELO/EHLO reply
        hash<auto> hello_reply;
 
        const MaxDebugLine = 2048;
 
public:
 
        const SmtpPort = 25;
 
 
        const SmtpsPort = 465;
 
        const EsmtpPort = 587;
 
        const Protocols = {
            "smtp": (
                "port": SmtpPort,
                "ssl": False,
                "tls": False,
            ),
            "smtps": (
                "port": SmtpsPort,
                "ssl": True,
                "tls": False,
            ),
            "smtptls": (
                "port": SmtpsPort,
                "ssl": False,
                "tls": True,
            ),
            "esmtp": (
                "port": EsmtpPort,
                "ssl": False,
                "tls": False,
            ),
            "esmtps": (
                "port": SmtpsPort,
                "ssl": True,
                "tls": False,
            ),
            "esmtptls": (
                "port": EsmtpPort,
                "ssl": False,
                "tls": True,
            ),
        };
 
 
    constructor(string host, softint port, *code log, *code dbglog);
 
 
 
    constructor(string url, *code log, *code dbglog);
 
 
 
    destructor();
 
 
 
    hash<auto> getInfo();
 
 
    setInfoLogClosure(*code log);
 
 
    setDebugLogClosure(*code log);
 
 
 
    string getTarget();
 
 
 
    tls(bool n_tls);
 
 
    bool tls();
 
 
 
    ssl(bool n_ssl);
 
 
    bool ssl();
 
 
 
    setUserPass(string n_user, string n_pass);
 
 
    test(bool ns);
 
 
    bool test();
 
 
 
    connect();
 
 
    bool isConnected();
 
 
 
    disconnect();
 
 
    setReadTimeout(timeout to);
 
 
    int getReadTimeoutMs();
 
 
    date getReadTimeoutDate();
 
 
    setConnectTimeout(timeout to);
 
 
    int getConnectTimeoutMs();
 
 
    date getConnectTimeoutDate();
 
 
 
    hash<auto> sendMessage(MailMessage::Message message);
 
 
 
    forceDisconnect();
 
 
 
    nothing clearWarningQueue();
 
 
 
    nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, auto arg, timeout min_ms = 1s);
 
 
 
    hash<auto> getUsageInfo();
 
 
 
    clearStats();
 
 
 
    setEventQueue(Qore::Thread::Queue queue, auto arg, *bool with_data);
 
 
 
    setEventQueue();
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  disconnectIntern();
public:
 
 
protected:
     log(string msg);
public:
 
 
protected:
     logDbg(string msg);
public:
 
 
protected:
     connectIntern();
public:
 
 
protected:
     loginIntern();
public:
 
 
    // send data over the socket
protected:
     sendDataIntern(data str);
public:
 
 
    // send data and log in the debug log if set
protected:
     sendData(string str);
public:
 
 
    // send data and log in the debug log if set
protected:
     sendData(binary b);
public:
 
 
    // send a command over the socket and return the response as a hash
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  hash<SmtpResponseInfo> sendCommand(string str);
public:
 
 
    // read a line from the socket (terminated with \n)
protected:
     string readLine(timeout to);
public:
 
 
    // sends the message header (without body & attachments) to the SMTP server
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  hash<auto> sendMessageInfoIntern(MailMessage::Message message);
public:
 
 
protected:
     forceDisconnectIntern();
public:
 
};
 
class SmtpPingPollOperation : public Qore::AbstractPollOperation {
 
public:
        const SPS_CONNECT = "connect";
 
        const SPS_READ_HELLO = "read-hello";
 
        const SPS_SEND_HELLO = "send-hello";
 
        const SPS_READ_HELLO_REPLY = "read-hello-reply";
 
        const SPS_STARTTLS = "starttls";
 
        const SPS_READ_STARTTLS_REPLY = "read-starttls-reply";
 
        const SPS_UPGRADE_TO_TLS = "upgrade-tls";
 
        const SPS_LOGIN = "login";
 
        const SPS_READ_LOGIN_REPLY = "read-login-reply";
 
        const SPS_COMPLETE = "complete";
 
protected:
        hash<auto> info;
 
        Socket sock();
 
        AbstractPollOperation poller;
 
        Mutex m();
 
        string state;
 
        bool goal_reached = False;
 
        bool esmtp = False;
 
        int hello_reply_code;
 
        string hello_reply;
 
        int starttls_code;
 
        string starttls_reply;
 
        int login_code;
 
        string login_reply;
 
public:
 
    constructor(SmtpClient smtp);
 
 
 
    string getGoal();
 
 
 
    string getState();
 
 
 
    bool goalReached();
 
 
    *hash<SocketPollInfo> continuePoll();
 
 
protected:
     startLogin();
public:
 
 
 
protected:
     bool getReply(reference<int> rcode, reference<string> rmsg);
public:
 
};
 
 
class SmtpConnection : public ConnectionProvider::AbstractConnectionWithInfo {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("SmtpConnection"),
        };
 
 
    constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
 ;
 
 
    string getType();
 
 
 
    *hash<auto> getRuntimeOptions();
 
 
 
    DataProvider::AbstractDataProvider getDataProvider();
 
 
 
    bool hasDataProvider();
 
 
 
    bool supportsPollingApi();
 
 
 
    Qore::AbstractPollOperation startPollConnect();
 
 
protected:
     setChildCapabilities();
public:
 
 
 
protected:
     SmtpClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
 
 
class SmtpClientDataProvider : public DataProvider::AbstractDataProvider {
 
public:
        const ProviderInfo = <DataProviderInfo>{
            "type": "SmtpClientDataProvider",
            "supports_children": True,
            "constructor_options": ConstructorOptions,
            "children_can_support_apis": True,
            "children_can_support_records": False,
            "children_can_support_observers": False,
        };
 
        const ConstructorOptions = {
            "url": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "A URL for an SMTP server",
                "required": True,
            },
        };
 
protected:
        SmtpClient smtp;
 
        const ChildMap = {
            "send-email": Class::forName("SmtpClient::SmtpClientSendEmailDataProvider"),
        };
 
public:
 
    constructor(*hash<auto> options);
 
 
    constructor(SmtpClient smtp);
 
 
    string getName();
 
 
    *string getDesc();
 
 
    *list<hash<DataProviderSummaryInfo>> getChildProviderSummaryInfo();
 
 
 
protected:
     *list<string> getChildProviderNamesImpl();
public:
 
 
 
protected:
     *AbstractDataProvider getChildProviderImpl(string name);
public:
 
 
protected:
     hash<DataProviderInfo> getStaticInfoImpl();
public:
 
};
 
class SmtpClientSendEmailDataProvider : public AbstractDataProvider {
 
public:
        SmtpClient smtp;
 
        const ProviderInfo = <DataProviderInfo>{
            "name": "send-email",
            "desc": "SMTP send email data provider",
            "type": "SmtpClientSendEmailDataProvider",
            "constructor_options": SmtpClientDataProvider::ConstructorOptions,
            "supports_request": True,
        };
 
        const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
            AbstractDataProvider::DataProviderSummaryInfoKeys
        });
 
        const RequestType = new SmtpSendEmailRequestDataType();
 
        const ResponseType = new SmtpSendEmailResponseDataType();
 
    constructor(*hash<auto> options);
 
 
    constructor(SmtpClient smtp);
 
 
    string getName();
 
 
 
protected:
     auto doRequestImpl(auto req, *hash<auto> request_options);
public:
 
 
 
protected:
     *AbstractDataProviderType getRequestTypeImpl();
public:
 
 
 
protected:
     *AbstractDataProviderType getResponseTypeImpl();
public:
 
 
    hash<DataProviderInfo> getStaticInfoImpl();
 
};
 
class SmtpSendEmailAttachmentDataType : public HashDataType {
 
public:
protected:
        const Fields = {
            "data": {
                "type": DataType,
                "desc": "The data for the attachment",
                "required": True,
            },
            "encoding": {
                "type": StringType,
                "desc": "The encoding to use for the attachment:\n"
                    "- `default`: `quoted-printable` for string data, `base64` for binary data\n"
                    "- `none`: no content encoding (not recommended)\n"
                    "- `quoted-printable`: quoted printable encoding \n"
                    "- `base64`: base64 encoding",
                "default_value": "default",
            },
            "hdr": {
                "type": HashOrNothingType,
                "desc": "Optional headers to send with the attachment",
            },
            "mime-type": {
                "type": StringType,
                "desc": "The MIME type of the attachment",
                "required": True,
            },
            "name": {
                "type": StringType,
                "desc": "The name or filename of the attachment",
                "required": True,
            },
        };
 
public:
 
    constructor();
 
};
 
class SmtpSendEmailRequestDataType : public HashDataType {
 
public:
protected:
        const Fields = {
            "attachments": {
                "type": new SoftListDataType(new SmtpSendEmailAttachmentDataType(), True),
                "desc": "Any attachments for the message",
            },
            "bcc": {
                "type": new SoftListDataType(StringType, True),
                "desc": "One or more `Bcc:` addresses for the email",
            },
            "body": {
                "type": DataType,
                "desc": "The message body",
            },
            "body-encoding": {
                "type": StringType,
                "desc": "The encoding to use for the attachment:\n"
                    "- `default`: `quoted-printable` for string data, `base64` for binary data\n"
                    "- `none`: no content encoding (not recommended)\n"
                    "- `quoted-printable`: quoted printable encoding \n"
                    "- `base64`: base64 encoding",
                "default_value": "default",
            },
            "body-mime-type": {
                "type": StringOrNothingType,
                "desc": "The MIME type of the message body",
            },
            "cc": {
                "type": new SoftListDataType(StringType, True),
                "desc": "One or more `Cc:` addresses for the email",
            },
            "sender": {
                "type": StringType,
                "desc": "The sender address for the email",
                "required": True,
            },
            "subject": {
                "type": StringType,
                "desc": "The subject for the email",
            },
            "to": {
                "type": new SoftListDataType(StringType, True),
                "desc": "One or more `To:` addresses for the email",
            },
        };
 
public:
 
    constructor();
 
};
 
class SmtpSendEmailResponseInfoDataType : public HashDataType {
 
public:
protected:
        const Fields = {
            "code": {
                "type": IntType,
                "desc": "The return code provided by the SMTP server for the command",
            },
            "desc": {
                "type": StringType,
                "desc": "The string description returned by the server",
            },
        };
 
public:
 
    constructor();
 
};
 
class SmtpSendEmailResponseDataType : public HashDataType {
 
public:
    constructor();
 
};
 
class SmtpClientDataProviderFactory : public AbstractDataProviderFactory {
 
public:
protected:
        static Class cls = new Class("SmtpClientDataProvider");
 
        const FactoryInfo = <DataProviderFactoryInfo>{
            "name": "smtpclient",
            "desc": "SMTP client data provider factory",
            "children_can_support_apis": True,
        };
 
public:
 
 
protected:
     hash<DataProviderFactoryInfo> getInfoImpl();
public:
 
 
 
protected:
     hash<DataProviderInfo> getProviderInfoImpl();
public:
 
 
protected:
     Class getClassImpl();
public:
 
};
};