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

System::String get_Address () const
 The domain name or IP address of the proxy server More...
 
void set_Address (System::String value)
 The domain name or IP address of the proxy server More...
 
int32_t get_Port () const
 The port number for the proxy server More...
 
void set_Port (int32_t value)
 The port number for the proxy server More...
 
System::String get_Username () const
 Username for proxy authentication More...
 
void set_Username (System::String value)
 Username for proxy authentication More...
 
System::String get_Password () const
 Password for proxy authentication More...
 
void set_Password (System::String value)
 Password for proxy authentication More...
 
 Proxy (System::String address, int32_t port, System::String username, System::String password)
 
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 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...
 
void Dispose () override
 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::Clients::Proxy::Proxy ( System::String  address,
int32_t  port,
System::String  username,
System::String  password 
)

Member Function Documentation

◆ Dispose()

void Aspose::Email::Clients::Proxy::Dispose ( )
override

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

◆ get_Address()

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

The domain name or IP address of the proxy server

◆ get_Password()

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

Password for proxy authentication

◆ get_Port()

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

The port number for the proxy server

◆ get_Username()

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

Username for proxy authentication

◆ GetStream()

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()

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

The domain name or IP address of the proxy server

◆ set_Password()

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

Password for proxy authentication

◆ set_Port()

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

The port number for the proxy server

◆ set_Username()

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

Username for proxy authentication

◆ SetUpStream()

virtual 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