Pop3Client.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  Pop3Client.qm Copyright 2013 - 2024 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
 
 
 
// assume local var scope, do not use "$" for vars, members, and method calls
 
 
 
namespace Pop3Client {
const DefaultIoTimeout = 15s;
 
const DefaultConnectTimeout = 30s;
 
 
class Pop3Client : public Logger::LoggerWrapper, public ConnectionProvider::OptionHelper {
 
public:
        const POP3Port = 110;
 
        const POP3SPort = 995;
 
        const Protocols = ...;
 
 
        const CtrlA = chr(1);
 
protected:
        Socket sock();
 
        // connect string
        string connect;
 
        // ensures exclusive access to the object
        Mutex mutex();
 
        // "tls" flag
        bool tls = False;
 
        // "starttls" flag
        bool starttls = False;
 
        // "noquit" flag
        bool noquit = False;
 
        // authentication credentials
        string user;
        string pass;
        string token;
 
        // logged in flag
        bool logged_in = False;
 
        // i/o timeout in milliseconds
        timeout ioTimeout;
 
        // connect timeout in milliseconds
        timeout connectTimeout;
 
        // log password
        bool log_pass = False;
 
        // sasl flag
        bool sasl;
 
        const MaxDebugLine = 2048;
 
public:
 
 
    constructor(string url, *hash<auto> opts);
 
 
 
    destructor();
 
 
 
    string getTarget();
 
 
 
    logPassword(bool pwd);
 
 
 
    bool logPassword();
 
 
 
    tls(bool tls);
 
 
 
    bool tls();
 
 
 
    starttls(bool starttls);
 
 
 
    bool starttls();
 
 
 
    noquit(bool noquit);
 
 
 
    bool noquit();
 
 
 
    connect();
 
 
 
    *hash<auto> getMail();
 
 
 
    MailMessage::Message getMessage(string id);
 
 
 
    hash<auto> stat();
 
 
 
    *hash<auto> list();
 
 
 
    del(softstring msg);
 
 
 
    del(list<auto> l);
 
 
 
    noop();
 
 
 
    reset();
 
 
 
    bool isConnected();
 
 
 
    disconnect();
 
 
 
    setIoTimeout(timeout to);
 
 
 
    int getIoTimeoutMs();
 
 
 
    date getIoTimeoutDate();
 
 
 
    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<auto> 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<string> 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:
     logError(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);
public:
 
 
    // don't reimplement this method; fix/enhance it in the module
protected:
    final  list<string> 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:
     doApopLogin(string apop);
public:
 
 
protected:
     doLogin();
public:
 
 
protected:
     doSaslXoauth2Login();
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 = ...;
 
 
 
    constructor(string name, string description, string url, hash attributes = {}, hash options = {})
 ;
 
 
 
    constructor(hash<auto> config, *hash<auto> attr) ;
 
 
    string getType();
 
 
 
protected:
     Pop3Client getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
};