Aspose::Email::Clients::Proxy Class Referenceabstract

Base proxy client. More...

Inherits IDisposable.

Inherited by Aspose::Email::Clients::HttpProxy, and Aspose::Email::Clients::SocksProxy.

Public Member Functions

ASPOSE_EMAIL_SHARED_API System::String get_Address ()
 The domain name or IP address of the proxy server More...
 
ASPOSE_EMAIL_SHARED_API void set_Address (System::String value)
 The domain name or IP address of the proxy server More...
 
ASPOSE_EMAIL_SHARED_API int32_t get_Port ()
 The port number for the proxy server More...
 
ASPOSE_EMAIL_SHARED_API void set_Port (int32_t value)
 The port number for the proxy server More...
 
ASPOSE_EMAIL_SHARED_API System::String get_Username ()
 Username for proxy authentication More...
 
ASPOSE_EMAIL_SHARED_API void set_Username (System::String value)
 Username for proxy authentication More...
 
ASPOSE_EMAIL_SHARED_API System::String get_Password ()
 Password for proxy authentication More...
 
ASPOSE_EMAIL_SHARED_API void set_Password (System::String value)
 Password for proxy authentication More...
 
ASPOSE_EMAIL_SHARED_API Proxy (System::String address, int32_t port, System::String username, System::String password)
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::IO::Stream > GetStream (System::String address, int32_t port)
 Returns configured network stream to transport data to the required host through the proxy server. More...
 
virtual ASPOSE_EMAIL_SHARED_API void SetUpStream (System::SharedPtr< System::IO::Stream > stream, System::String address, int32_t port)=0
 Configures proxy-server to transport data to the target host. More...
 
virtual ASPOSE_EMAIL_SHARED_API void Dispose ()
 Disposes this instance and requests that the underlying TCP connection be closed. More...
 

Friends

class Aspose::Email::Clients::HttpProxy
 
class Aspose::Email::Clients::SocksProxy
 

Detailed Description

Base proxy client.

Constructor & Destructor Documentation

◆ Proxy()

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Proxy::Proxy ( System::String  address,
int32_t  port,
System::String  username,
System::String  password 
)

Member Function Documentation

◆ Dispose()

virtual ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Proxy::Dispose ( )
virtual

Disposes this instance and requests that the underlying TCP connection be closed.

◆ get_Address()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Clients::Proxy::get_Address ( )

The domain name or IP address of the proxy server

◆ get_Password()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Clients::Proxy::get_Password ( )

Password for proxy authentication

◆ get_Port()

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::Clients::Proxy::get_Port ( )

The port number for the proxy server

◆ get_Username()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Clients::Proxy::get_Username ( )

Username for proxy authentication

◆ GetStream()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Email::Clients::Proxy::GetStream ( System::String  address,
int32_t  port 
)

Returns configured network stream to transport data to the required host through the proxy server.

Parameters
addressThe domain name of the host we want to contact
portThe port number of the host we want to contact
Returns
Returns configure network stream to connect with required host through the proxy server.

◆ set_Address()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Proxy::set_Address ( System::String  value)

The domain name or IP address of the proxy server

◆ set_Password()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Proxy::set_Password ( System::String  value)

Password for proxy authentication

◆ set_Port()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Proxy::set_Port ( int32_t  value)

The port number for the proxy server

◆ set_Username()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Proxy::set_Username ( System::String  value)

Username for proxy authentication

◆ SetUpStream()

virtual ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Proxy::SetUpStream ( System::SharedPtr< System::IO::Stream >  stream,
System::String  address,
int32_t  port 
)
pure virtual

Configures proxy-server to transport data to the target host.

Parameters
streamStream which is connected to the proxy-server.
addressThe network address of the target host we want to contact
portThe port number of the target host we want to contact

Implemented in Aspose::Email::Clients::SocksProxy, and Aspose::Email::Clients::HttpProxy.

Friends And Related Function Documentation

◆ Aspose::Email::Clients::HttpProxy

friend class Aspose::Email::Clients::HttpProxy
friend

◆ Aspose::Email::Clients::SocksProxy