Pop3Client.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  Pop3Client.qm Copyright 2013 - 2023 Qore Technologies, s.r.o.
 
    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
 
// requires the ConnectionProvider module
 
// assume local var scope, do not use "$" for vars, members, and method calls
 
 
 
namespace Pop3Client {
const DefaultReadTimeout = 15s;
 
const DefaultConnectTimeout = 30s;
 
 
class Pop3Client {
 
public:
protected:
        Socket sock();
 
        // connect string
        string connect;
 
        // ensures exclusive access to the object
        Mutex mutex();
 
        // optional info log closure
        *code log_info;
 
        // optional debug log closure
        *code log_debug;
 
        // "tls" flag
        bool tls = False;
 
        // "starttls" flag
        bool starttls = False;
 
        // "noquit" flag
        bool noquit = False;
 
        // 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;
 
        // log password
        bool log_pass = False;
 
        const MaxDebugLine = 2048;
 
public:
 
        const POP3Port = 110;
 
        const POP3SPort = 995;
 
        const Protocols = {
            "pop3": {"tls": False, "port": POP3Port},
            "pop3s": {"tls": True, "port": POP3SPort},
        };
 
 
    constructor(string url, *code log, *code dbglog);
 
 
 
    destructor();
 
 
 
    string getTarget();
 
 
 
    logPassword(bool pwd);
 
 
 
    bool logPassword();
 
 
 
    tls(bool n_tls);
 
 
 
    bool tls();
 
 
 
    starttls(bool n_starttls);
 
 
 
    bool starttls();
 
 
 
    noquit(bool n_noquit);
 
 
 
    bool noquit();
 
 
 
    connect();
 
 
 
    *hash getMail();
 
 
 
    hash stat();
 
 
 
    *hash list();
 
 
 
    del(softstring msg);
 
 
 
    del(list l);
 
 
 
    noop();
 
 
 
    reset();
 
 
 
    bool isConnected();
 
 
 
    disconnect();
 
 
 
    setReadTimeout(timeout to);
 
 
 
    int getReadTimeoutMs();
 
 
 
    date getReadTimeoutDate();
 
 
 
    setConnectTimeout(timeout to);
 
 
 
    int getConnectTimeoutMs();
 
 
 
    date getConnectTimeoutDate();
 
 
 
    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:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  MailMessage::Message retrIntern(softstring id);
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  hash statIntern();
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  *hash listIntern();
public:
 
 
    // read a line from the socket (terminated with \n)
protected:
     string readLine(timeout to);
public:
 
 
    // gets a trimmed one-line response from the server, throws an exception if an error response is received
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  string getResponse();
public:
 
 
    // gets a trimmed multi-line response from the server, throws an exception if an error response is received
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  list getResponseMulti();
public:
 
 
    // gets a multi-line response from the server, throws an exception if an error response is received
    // does not include the first line in the response
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  string getResponseMultiStr();
public:
 
 
protected:
     log(string msg);
public:
 
 
protected:
     logDbg(string msg);
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  sendCommandIntern(string str, bool masked = False);
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  list sendCommandMulti(string str);
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  string sendCommandMultiStr(string str);
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  string sendCommand(string str);
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  string sendCommandMasked(string str);
public:
 
 
protected:
     loginIntern(string r);
public:
 
 
protected:
     doSSLIntern();
public:
 
 
    // when this method returns without an exception, the object is in the TRANSACTION state
protected:
     connectIntern();
public:
 
 
protected:
     forceDisconnectIntern();
public:
 
};
 
 
class Pop3Connection : public ConnectionProvider::AbstractConnectionWithInfo {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("Pop3Connection"),
        };
 
 
    constructor(string name, string description, string url, hash attributes = {}, hash options = {})
 ;
 
 
    string getType();
 
 
 
    *hash<auto> getRuntimeOptions();
 
 
 
protected:
     Pop3Client getImpl(bool connect = True, *hash rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
};