HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
NET_MailNetworkRequest Class Reference

#include <NET_MailNetworkRequest.h>

Public Types

enum  IntAttribute { INT_GLOBAL_SHARE, INT_VERBOSE }
 
enum  StrAttribute
 

Public Member Functions

 NET_MailNetworkRequest ()
 
 NET_MailNetworkRequest (const UT_Url &url)
 
ASIO_AnyExecutor executor () const
 
void setExecutor (const ASIO_AnyExecutor &executor)
 
void setUrl (const UT_Url &url)
 
const UT_Url & url () const
 
void setAttribute (IntAttribute attrib, int64 value)
 
void setAttribute (StrAttribute attrib, const UT_StringHolder &value)
 
const UT_Map< IntAttribute,
int64 > & 		intAttributes () const
 
const UT_Map< StrAttribute,
UT_StringHolder > & 		stringAttributes () const
 
void setFrom (const UT_StringHolder &from)
 
const UT_StringHolder & from () const
 
void setTo (const UT_StringHolder &to)
 
const UT_StringHolder & to () const
 
void setCc (const UT_StringHolder &cc)
 
const UT_StringHolder & cc () const
 
void setBcc (const UT_StringHolder &bcc)
 
const UT_StringHolder & bcc () const
 
void setSubject (const UT_StringHolder &subject)
 
const UT_StringHolder & subject () const
 
const UT_StringHolder & toAddress () const
 
const UT_StringHolder & fromAddress () const
 
const UT_StringHolder & ccAddress () const
 
const UT_StringHolder & bccAddress () const
 
void setDate (time_t now)
 
UT_StringHolder date () const
 
void setAuthentication (const UT_StringHolder &username, const UT_StringHolder &password)
 
const UT_StringHolder & username () const
 
const UT_StringHolder & password () const
 

Static Public Member Functions

static UT_StringHolder dateToString (time_t now)
 
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)
 

Detailed Description

Definition at line 32 of file NET_MailNetworkRequest.h.

Member Enumeration Documentation

enum NET_MailNetworkRequest::IntAttribute
Enumerator
INT_GLOBAL_SHARE 
INT_VERBOSE 

Definition at line 35 of file NET_MailNetworkRequest.h.

enum NET_MailNetworkRequest::StrAttribute

Definition at line 40 of file NET_MailNetworkRequest.h.

Constructor & Destructor Documentation

NET_MailNetworkRequest::NET_MailNetworkRequest ( )
inline

Definition at line 44 of file NET_MailNetworkRequest.h.

NET_MailNetworkRequest::NET_MailNetworkRequest ( const UT_Url &  url)
inline

Definition at line 45 of file NET_MailNetworkRequest.h.

Member Function Documentation

const UT_StringHolder& NET_MailNetworkRequest::bcc ( ) const
inline

Definition at line 102 of file NET_MailNetworkRequest.h.

const UT_StringHolder& NET_MailNetworkRequest::bccAddress ( ) const
inline

Definition at line 110 of file NET_MailNetworkRequest.h.

const UT_StringHolder& NET_MailNetworkRequest::cc ( ) const
inline

Definition at line 95 of file NET_MailNetworkRequest.h.

const UT_StringHolder& NET_MailNetworkRequest::ccAddress ( ) const
inline

Definition at line 109 of file NET_MailNetworkRequest.h.

UT_StringHolder NET_MailNetworkRequest::date ( ) const
inline

Definition at line 113 of file NET_MailNetworkRequest.h.

static UT_StringHolder NET_MailNetworkRequest::dateToString ( time_t  now)
static
ASIO_AnyExecutor NET_MailNetworkRequest::executor ( ) const
inline

Definition at line 50 of file NET_MailNetworkRequest.h.

static bool NET_MailNetworkRequest::extractAddresses ( UT_StringViewArray &  addresses,
const UT_StringView &  input 
)
static
static bool NET_MailNetworkRequest::extractAddresses ( UT_StringHolder &  addresses,
const UT_StringView &  input 
)
static
const UT_StringHolder& NET_MailNetworkRequest::from ( ) const
inline

Definition at line 81 of file NET_MailNetworkRequest.h.

const UT_StringHolder& NET_MailNetworkRequest::fromAddress ( ) const
inline

Definition at line 108 of file NET_MailNetworkRequest.h.

const UT_Map<IntAttribute, int64>& NET_MailNetworkRequest::intAttributes ( ) const
inline

Definition at line 67 of file NET_MailNetworkRequest.h.

static bool NET_MailNetworkRequest::isValidEmails ( const UT_StringView &  addr)
static

When specifying email addresses we need the correctly formatted address (eg. email.nosp@m.@ema.nosp@m.il.co.nosp@m.m and not email.nosp@m.@ema.nosp@m.il.co.nosp@m.m)

const UT_StringHolder& NET_MailNetworkRequest::password ( ) const
inline

Definition at line 123 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setAttribute ( IntAttribute  attrib,
int64  value 
)
inline

Definition at line 59 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setAttribute ( StrAttribute  attrib,
const UT_StringHolder &  value 
)
inline

Definition at line 63 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setAuthentication ( const UT_StringHolder &  username,
const UT_StringHolder &  password 
)
inline

Definition at line 115 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setBcc ( const UT_StringHolder &  bcc)
inline

Definition at line 97 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setCc ( const UT_StringHolder &  cc)
inline

Definition at line 90 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setDate ( time_t  now)
inline

Definition at line 112 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setExecutor ( const ASIO_AnyExecutor &  executor)
inline

Definition at line 51 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setFrom ( const UT_StringHolder &  from)
inline

Definition at line 76 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setSubject ( const UT_StringHolder &  subject)
inline

Definition at line 104 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setTo ( const UT_StringHolder &  to)
inline

Definition at line 83 of file NET_MailNetworkRequest.h.

void NET_MailNetworkRequest::setUrl ( const UT_Url &  url)
inline

Definition at line 56 of file NET_MailNetworkRequest.h.

const UT_Map<StrAttribute, UT_StringHolder>& NET_MailNetworkRequest::stringAttributes ( ) const
inline

Definition at line 71 of file NET_MailNetworkRequest.h.

const UT_StringHolder& NET_MailNetworkRequest::subject ( ) const
inline

Definition at line 105 of file NET_MailNetworkRequest.h.

const UT_StringHolder& NET_MailNetworkRequest::to ( ) const
inline

Definition at line 88 of file NET_MailNetworkRequest.h.

const UT_StringHolder& NET_MailNetworkRequest::toAddress ( ) const
inline

Definition at line 107 of file NET_MailNetworkRequest.h.

const UT_Url& NET_MailNetworkRequest::url ( ) const
inline

Definition at line 57 of file NET_MailNetworkRequest.h.

const UT_StringHolder& NET_MailNetworkRequest::username ( ) const
inline

Definition at line 122 of file NET_MailNetworkRequest.h.

The documentation for this class was generated from the following file: