NET_MailNetworkRequest.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        NET_MailNetworkRequest.h
 *
 * COMMENTS:
 *
 *
 */

#ifndef __NET_MAILNETWORKREQUEST_H__
#define __NET_MAILNETWORKREQUEST_H__

#include "NET_API.h"

#include "NET_WebTypes.h"

#include <UT/UT_BoostAsio.h>
#include <UT/UT_Url.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_Map.h>

class NET_API NET_MailResponse
{
public:
    UT_ErrorCode myErrorCode;
    UT_StringHolder myErrorMsg;
};

class NET_API NET_MailNetworkRequest
{
public:
    enum IntAttribute
    {
        INT_GLOBAL_SHARE,
        INT_VERBOSE
    };
    enum StrAttribute
    {
    };

    NET_MailNetworkRequest() { initDefaultAttributes_(); }
    NET_MailNetworkRequest(const UT_Url& url) : myUrl(url)
    {
        initDefaultAttributes_();
    }

    hboost::asio::executor executor() const { return myExecutor; }
    void setExecutor(const hboost::asio::executor& executor)
    {
        myExecutor = executor;
    }

    void setUrl(const UT_Url& url) { myUrl = url; }
    const UT_Url& url() const { return myUrl; }

    void setAttribute(IntAttribute attrib, int64 value)
    {
        myIntAttributes[attrib] = value;
    }
    void setAttribute(StrAttribute attrib, const UT_StringHolder& value)
    {
        myStringAttributes[attrib] = value;
    }
    const UT_Map<IntAttribute, int64>& intAttributes() const
    {
        return myIntAttributes;
    }
    const UT_Map<StrAttribute, UT_StringHolder>& stringAttributes() const
    {
        return myStringAttributes;
    }

    void setFrom(const UT_StringHolder& from)
    {
        myFrom = from;
        extractAddresses(myFromAddress, from);
    }
    const UT_StringHolder& from() const { return myFrom; }

    void setTo(const UT_StringHolder& to)
    {
        myTo = to;
        extractAddresses(myToAddresses, to);
    }
    const UT_StringHolder& to() const { return myTo; }

    void setCc(const UT_StringHolder& cc)
    {
        myCc = cc;
        extractAddresses(myCcAddresses, cc);
    }
    const UT_StringHolder& cc() const { return myCc; }

    void setBcc(const UT_StringHolder& bcc)
    {
        myBcc = bcc;
        extractAddresses(myBccAddresses, bcc);
    }
    const UT_StringHolder& bcc() const { return myBcc; }

    void setSubject(const UT_StringHolder& subject) { mySubject = subject; }
    const UT_StringHolder& subject() const { return mySubject; }

    const UT_StringHolder& toAddress() const { return myToAddresses; }
    const UT_StringHolder& fromAddress() const { return myFromAddress; }
    const UT_StringHolder& ccAddress() const { return myCcAddresses; }
    const UT_StringHolder& bccAddress() const { return myBccAddresses; }
    
    void setDate(time_t now) { myDate = dateToString(now); }
    UT_StringHolder date() const { return myDate; }

    void setAuthentication(
            const UT_StringHolder& username,
            const UT_StringHolder& password)
    {
        myUsername = username;
        myPassword = password;
    }
    const UT_StringHolder& username() const { return myUsername; }
    const UT_StringHolder& password() const { return myPassword; }

    static UT_StringHolder dateToString(time_t now);
    /// When specifying email addresses we need the correctly formatted address
    /// (eg. <email@email.com> and not email@email.com)
    static bool isValidEmails(const UT_StringView& addr);
    static bool extractAddresses(
            UT_StringViewArray& addresses,
            const UT_StringView& input);
    static bool extractAddresses(
            UT_StringHolder& addresses,
            const UT_StringView& input);

private:
    void initDefaultAttributes_();

    UT_Url myUrl;

    UT_StringHolder mySubject;
    UT_StringHolder myTo;
    UT_StringHolder myToAddresses;
    UT_StringHolder myCc;
    UT_StringHolder myCcAddresses;
    UT_StringHolder myBcc;
    UT_StringHolder myBccAddresses;
    UT_StringHolder myFrom;
    UT_StringHolder myFromAddress;
    UT_StringHolder myDate;
    UT_StringHolder myUsername;
    UT_StringHolder myPassword;

    UT_Map<IntAttribute, int64> myIntAttributes;
    UT_Map<StrAttribute, UT_StringHolder> myStringAttributes;

    hboost::asio::executor myExecutor;
};

#endif // __NET_MAILNETWORKREQUEST_H__