Aspose::Email::Clients::CredentialsByHostClient Class Reference

Represents the client that creates server connection by using the host credentials. More...

Inherits Aspose::Email::Clients::EmailClient.

Inherited by Aspose::Email::Clients::Imap::FINAL, Aspose::Email::Clients::Pop3::FINAL, and Aspose::Email::Clients::Smtp::FINAL.

Protected Member Functions

ASPOSE_EMAIL_SHARED_API CredentialsByHostClient (System::String type)
 Initializes a new instance of the CredentialsByHostClient class. More...
 
ASPOSE_EMAIL_SHARED_API CredentialsByHostClient (System::String type, System::String host, int32_t port)
 Initializes a new instance of the CredentialsByHostClient class. More...
 
ASPOSE_EMAIL_SHARED_API CredentialsByHostClient (System::String type, System::String host, int32_t port, Aspose::Email::Clients::SecurityOptions securityOptions)
 Initializes a new instance of the CredentialsByHostClient class. More...
 
ASPOSE_EMAIL_SHARED_API CredentialsByHostClient (System::String type, System::String host, int32_t port, System::String username, System::String password)
 Initializes a new instance of the CredentialsByHostClient class. More...
 
ASPOSE_EMAIL_SHARED_API CredentialsByHostClient (System::String type, System::String host, int32_t port, System::String username, System::String password, Aspose::Email::Clients::SecurityOptions securityOptions)
 Initializes a new instance of the CredentialsByHostClient class. More...
 
ASPOSE_EMAIL_SHARED_API CredentialsByHostClient (System::String type, System::String host, int32_t port, System::String username, System::String authInfo, bool useOAuth)
 Initializes a new instance of the CredentialsByHostClient class. More...
 
ASPOSE_EMAIL_SHARED_API CredentialsByHostClient (System::String type, System::String host, int32_t port, System::String username, System::String authInfo, bool useOAuth, Aspose::Email::Clients::SecurityOptions securityOptions)
 Initializes a new instance of the CredentialsByHostClient class. More...
 
ASPOSE_EMAIL_SHARED_API CredentialsByHostClient (System::String type, System::String host, int32_t port, System::String username, System::SharedPtr< ITokenProvider > tokenProvider)
 Initializes a new instance of the CredentialsByHostClient class. More...
 
ASPOSE_EMAIL_SHARED_API CredentialsByHostClient (System::String type, System::String host, int32_t port, System::String username, System::SharedPtr< ITokenProvider > tokenProvider, Aspose::Email::Clients::SecurityOptions securityOptions)
 Initializes a new instance of the CredentialsByHostClient class. More...
 
- Protected Member Functions inherited from Aspose::Email::Clients::EmailClient
ASPOSE_EMAIL_SHARED_API EmailClient (System::String type)
 Initializes a new instance of the EmailClient class. More...
 
ASPOSE_EMAIL_SHARED_API EmailClient (System::String type, System::String host, int32_t port)
 Initializes a new instance of the EmailClient class. More...
 
ASPOSE_EMAIL_SHARED_API EmailClient (System::String type, System::String host, int32_t port, Aspose::Email::Clients::SecurityOptions securityOptions)
 Initializes a new instance of the EmailClient class. More...
 
ASPOSE_EMAIL_SHARED_API EmailClient (System::String type, System::String host, int32_t port, System::String username, System::String password)
 Initializes a new instance of the EmailClient class. More...
 
ASPOSE_EMAIL_SHARED_API EmailClient (System::String type, System::String host, int32_t port, System::String username, System::String password, Aspose::Email::Clients::SecurityOptions securityOptions)
 Initializes a new instance of the EmailClient class. More...
 
ASPOSE_EMAIL_SHARED_API EmailClient (System::String type, System::String host, int32_t port, System::String username, System::String authInfo, bool useOAuth)
 Initializes a new instance of the EmailClient class. More...
 
ASPOSE_EMAIL_SHARED_API EmailClient (System::String type, System::String host, int32_t port, System::String username, System::String authInfo, bool useOAuth, Aspose::Email::Clients::SecurityOptions securityOptions)
 Initializes a new instance of the EmailClient class. More...
 
ASPOSE_EMAIL_SHARED_API EmailClient (System::String type, System::String host, int32_t port, System::String username, System::SharedPtr< ITokenProvider > tokenProvider)
 Initializes a new instance of the EmailClient class. More...
 
ASPOSE_EMAIL_SHARED_API EmailClient (System::String type, System::String host, int32_t port, System::String username, System::SharedPtr< ITokenProvider > tokenProvider, Aspose::Email::Clients::SecurityOptions securityOptions)
 Initializes a new instance of the EmailClient class. More...
 
virtual ASPOSE_EMAIL_SHARED_API void Dispose (bool disposing)
 Finalizes all operations with a server. More...
 

Friends

class Aspose::Email::Clients::Imap::ImapClient
 
class Aspose::Email::Clients::Pop3::Pop3Client
 
class Aspose::Email::Clients::Smtp::SmtpClient
 

Additional Inherited Members

- Public Member Functions inherited from Aspose::Email::Clients::EmailClient
ASPOSE_EMAIL_SHARED_API bool get_EnableLogger ()
 Gets value which allows enable/disable logger More...
 
ASPOSE_EMAIL_SHARED_API void set_EnableLogger (bool value)
 Sets value which allows enable/disable logger More...
 
ASPOSE_EMAIL_SHARED_API System::String get_LogFileName ()
 Gets log file name More...
 
ASPOSE_EMAIL_SHARED_API void set_LogFileName (System::String value)
 Sets log file name More...
 
ASPOSE_EMAIL_SHARED_API bool get_UseDateInLogFileName ()
 Gets value which indicates if date has to be used in log file name. More...
 
ASPOSE_EMAIL_SHARED_API void set_UseDateInLogFileName (bool value)
 Sets value which indicates if date has to be used in log file name. More...
 
virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr< Aspose::Email::Tools::Logging::Logger > get_Logger ()
 
virtual ASPOSE_EMAIL_SHARED_API void set_Logger (System::SharedPtr< Aspose::Email::Tools::Logging::Logger > value)
 
virtual ASPOSE_EMAIL_SHARED_API Base::EncryptionProtocols get_SupportedEncryption ()
 Defines the versions of SSL/TLS encription protocols to be uised. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_SupportedEncryption (Base::EncryptionProtocols value)
 Defines the versions of SSL/TLS encription protocols to be uised. More...
 
virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr< PipeliningStatusget_UsePipelining ()
 Gets object which indicates whether the pipelining mode is enabled. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_UsePipelining (System::SharedPtr< PipeliningStatus > value)
 Sets object which indicates whether the pipelining mode is enabled. More...
 
virtual ASPOSE_EMAIL_SHARED_API System::String get_Host ()
 Gets the host name. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_Host (System::String value)
 Sets the host name. More...
 
virtual ASPOSE_EMAIL_SHARED_API int32_t get_DefaultPort ()
 Gets default port for client More...
 
virtual ASPOSE_EMAIL_SHARED_API int32_t get_Port ()
 Gets the port. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_Port (int32_t value)
 Sets the port. More...
 
virtual ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::SecurityOptions get_SecurityOptions ()
 Security mode for a mail client More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_SecurityOptions (Aspose::Email::Clients::SecurityOptions value)
 Security mode for a mail client More...
 
virtual ASPOSE_EMAIL_SHARED_API bool get_UseAuthentication ()
 Indicates whether authentication is used. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_UseAuthentication (bool value)
 Indicates whether authentication is used. More...
 
virtual ASPOSE_EMAIL_SHARED_API int32_t get_ConnectionCheckupPeriod ()
 Period of connection checking up in milliseconds. Default value is 5 min. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_ConnectionCheckupPeriod (int32_t value)
 Period of connection checking up in milliseconds. Default value is 5 min. More...
 
virtual ASPOSE_EMAIL_SHARED_API bool get_UseDefaultCredentials ()
 Gets a Boolean value that controls whether the DefaultCredentials are sent with requests. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_UseDefaultCredentials (bool value)
 Sets a Boolean value that controls whether the DefaultCredentials are sent with requests. More...
 
virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr< Aspose::Email::Clients::SocksProxyget_SocksProxy ()
 Gets SOCKS proxy for the client More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_SocksProxy (System::SharedPtr< Aspose::Email::Clients::SocksProxy > value)
 Sets SOCKS proxy for the client More...
 
virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr< Aspose::Email::Clients::Proxyget_Proxy ()
 Gets proxy for the client More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_Proxy (System::SharedPtr< Aspose::Email::Clients::Proxy > value)
 Sets proxy for the client More...
 
ASPOSE_EMAIL_SHARED_API int32_t get_ConnectionTimeout ()
 Gets the connection timeout Please note: If connection consists of several server requests, for every request will assigned this timeout value. More...
 
ASPOSE_EMAIL_SHARED_API void set_ConnectionTimeout (int32_t value)
 Sets the connection timeout Please note: If connection consists of several server requests, for every request will assigned this timeout value. More...
 
ASPOSE_EMAIL_SHARED_API int32_t get_Timeout ()
 Gets the timeout for mail operations Please note: Timeout value can not be less then value of NetworkTimeout property More...
 
ASPOSE_EMAIL_SHARED_API void set_Timeout (int32_t value)
 Sets the timeout for mail operations Please note: Timeout value can not be less then value of NetworkTimeout property More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::Net::ICredentialsByHost > get_Credentials ()
 
ASPOSE_EMAIL_SHARED_API void set_Credentials (System::SharedPtr< System::Net::ICredentialsByHost > value)
 
virtual ASPOSE_EMAIL_SHARED_API System::String get_Password ()
 Gets the password. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_Password (System::String value)
 Sets the password. More...
 
virtual ASPOSE_EMAIL_SHARED_API System::String get_AccessToken ()
 Gets the access token. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_AccessToken (System::String value)
 Sets the access token. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< ITokenProviderget_TokenProvider ()
 Gets TokenProvider allowing to retrieve access token. More...
 
ASPOSE_EMAIL_SHARED_API void set_TokenProvider (System::SharedPtr< ITokenProvider > value)
 Sets TokenProvider allowing to retrieve access token. More...
 
virtual ASPOSE_EMAIL_SHARED_API System::String get_Username ()
 Gets the username. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_Username (System::String value)
 Sets the username. More...
 
ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::ConnectionState get_ConnectionState ()
 Gets the current state of the connection. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< Aspose::Email::Clients::ConnectionPool > get_ConnectionPool ()
 Gets connection pool for the client More...
 
virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr< IConnectionget_CurrentConnection ()
 Gets current connection according to ConnectionAsgmtMode option More...
 
virtual ASPOSE_EMAIL_SHARED_API ConnectionAsgmtType get_ConnectionAsgmtMode ()
 Gets value which defines mode of connection allocation in multiple threads environment More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_ConnectionAsgmtMode (ConnectionAsgmtType value)
 Sets value which defines mode of connection allocation in multiple threads environment More...
 
virtual ASPOSE_EMAIL_SHARED_API MultyConnectionMode get_UseMultyConnection ()
 Gets value which indicates if client has to use multiple connections for heavy loaded operations. Please note, using of this mode not necessary has to lead to performance increasing. More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_UseMultyConnection (MultyConnectionMode value)
 Sets value which indicates if client has to use multiple connections for heavy loaded operations. Please note, using of this mode not necessary has to lead to performance increasing. More...
 
virtual ASPOSE_EMAIL_SHARED_API int32_t get_ConnectionsQuantity ()
 Gets quantity of connections in multy-connection mode More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_ConnectionsQuantity (int32_t value)
 Sets quantity of connections in multy-connection mode More...
 
ASPOSE_EMAIL_SHARED_API void InitializeConnectionPool ()
 
ASPOSE_EMAIL_SHARED_API void ResetLogSettings ()
 Resets logging settings to default. More...
 
ASPOSE_EMAIL_SHARED_API void initializeLogger ()
 
virtual ASPOSE_EMAIL_SHARED_API void CheckCredentials ()
 
virtual ASPOSE_EMAIL_SHARED_API System::ArrayPtr< System::String > GetCapabilities ()
 
template<class... Args>
void OnConnect_add (const Args &... value)
 
template<class... Args>
void OnConnect_remove (const Args &... value)
 
template<class... Args>
void BindIPEndPoint_add (const Args &... value)
 
template<class... Args>
void BindIPEndPoint_remove (const Args &... value)
 
ASPOSE_EMAIL_SHARED_API void CancelAsyncOperation (System::SharedPtr< System::IAsyncResult > asyncResult)
 Cancels asynchronous operation. More...
 
virtual ASPOSE_EMAIL_SHARED_API void Noop ()=0
 'No operation' command More...
 
virtual ASPOSE_EMAIL_SHARED_API void Noop (System::SharedPtr< IConnection > connection)=0
 'No operation' command More...
 
virtual ASPOSE_EMAIL_SHARED_API void Noop (System::SharedPtr< Connection > connection, int32_t timeout)=0
 'No operation' command More...
 
virtual ASPOSE_EMAIL_SHARED_API void ConnectionFinalize (System::SharedPtr< System::Object > sender, System::SharedPtr< Base::ConnectionEventArgs > args)
 Performs finalization operation for specified connection More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::Object > EndGroupOperation (System::SharedPtr< System::IAsyncResult > asyncResult)
 Waits for the pending asynchronous operation to complete. More...
 
virtual ASPOSE_EMAIL_SHARED_API void Dispose ()
 Finalizes all operations with a server. More...
 
virtual ASPOSE_EMAIL_SHARED_API ~EmailClient ()
 
virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr< IConnectionCreateConnection ()
 Creates new independent connection for operations not linked to threads (not default connection). Invocation of this method is similar to invocation of CreateConnection(createAsDefaultConnection = false) Please see more in documentation for EmailClient.ConnectionAsgmtMode property. More...
 
virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr< IConnectionCreateConnection (bool createAsDefaultConnection)
 Creates new (default or independent) connection for operations. Please see more in documentation for EmailClient.ConnectionAsgmtMode property. More...
 
- Public Attributes inherited from Aspose::Email::Clients::EmailClient
System::SharedPtr< System::Object > loggerSyncObj
 
System::SharedPtr< Aspose::Email::Tools::Logging::Logger > logger
 
System::String password
 
System::String username
 
System::String accessToken
 
System::SharedPtr< ITokenProvidertokenProvider
 
System::SharedPtr< Aspose::Email::Clients::ConnectionPool > connectionPool
 
System::String clientType
 
- Static Public Attributes inherited from Aspose::Email::Clients::EmailClient
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::Object > logManagerSyncObj
 

Detailed Description

Represents the client that creates server connection by using the host credentials.

Constructor & Destructor Documentation

◆ CredentialsByHostClient() [1/9]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::CredentialsByHostClient::CredentialsByHostClient ( System::String  type)
protected

Initializes a new instance of the CredentialsByHostClient class.

◆ CredentialsByHostClient() [2/9]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::CredentialsByHostClient::CredentialsByHostClient ( System::String  type,
System::String  host,
int32_t  port 
)
protected

Initializes a new instance of the CredentialsByHostClient class.

Parameters
hostThe host name.
portThe port number.

◆ CredentialsByHostClient() [3/9]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::CredentialsByHostClient::CredentialsByHostClient ( System::String  type,
System::String  host,
int32_t  port,
Aspose::Email::Clients::SecurityOptions  securityOptions 
)
protected

Initializes a new instance of the CredentialsByHostClient class.

Parameters
hostThe host name.
portThe port number.
securityOptionsSecurity mode for a mail client

◆ CredentialsByHostClient() [4/9]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::CredentialsByHostClient::CredentialsByHostClient ( System::String  type,
System::String  host,
int32_t  port,
System::String  username,
System::String  password 
)
protected

Initializes a new instance of the CredentialsByHostClient class.

Parameters
hostThe host name.
portThe port number.
usernameThe username.
passwordThe password.

◆ CredentialsByHostClient() [5/9]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::CredentialsByHostClient::CredentialsByHostClient ( System::String  type,
System::String  host,
int32_t  port,
System::String  username,
System::String  password,
Aspose::Email::Clients::SecurityOptions  securityOptions 
)
protected

Initializes a new instance of the CredentialsByHostClient class.

Parameters
hostThe host name.
portThe port number.
usernameThe username.
passwordThe password.
securityOptionsSecurity mode for a mail client

◆ CredentialsByHostClient() [6/9]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::CredentialsByHostClient::CredentialsByHostClient ( System::String  type,
System::String  host,
int32_t  port,
System::String  username,
System::String  authInfo,
bool  useOAuth 
)
protected

Initializes a new instance of the CredentialsByHostClient class.

Parameters
hostThe host.
portThe port.
usernameThe username.
authInfoA string representation of the user password or the access token.
useOAuthDefines whether OAuth is used to login to the server

◆ CredentialsByHostClient() [7/9]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::CredentialsByHostClient::CredentialsByHostClient ( System::String  type,
System::String  host,
int32_t  port,
System::String  username,
System::String  authInfo,
bool  useOAuth,
Aspose::Email::Clients::SecurityOptions  securityOptions 
)
protected

Initializes a new instance of the CredentialsByHostClient class.

Parameters
hostThe host.
portThe port.
usernameThe username.
authInfoA string representation of the user password or the access token.
useOAuthDefines whether OAuth is used to login to the server
securityOptionsSecurity mode for a mail client

◆ CredentialsByHostClient() [8/9]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::CredentialsByHostClient::CredentialsByHostClient ( System::String  type,
System::String  host,
int32_t  port,
System::String  username,
System::SharedPtr< ITokenProvider tokenProvider 
)
protected

Initializes a new instance of the CredentialsByHostClient class.

Parameters
hostThe host.
portThe port.
usernameThe username.
tokenProviderTokenProvider allowing to retrieve access token.

◆ CredentialsByHostClient() [9/9]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::CredentialsByHostClient::CredentialsByHostClient ( System::String  type,
System::String  host,
int32_t  port,
System::String  username,
System::SharedPtr< ITokenProvider tokenProvider,
Aspose::Email::Clients::SecurityOptions  securityOptions 
)
protected

Initializes a new instance of the CredentialsByHostClient class.

Parameters
hostThe host.
portThe port.
usernameThe username.
tokenProviderTokenProvider allowing to retrieve access token.
securityOptions

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Imap::ImapClient

friend class Aspose::Email::Clients::Imap::ImapClient
friend

◆ Aspose::Email::Clients::Pop3::Pop3Client

friend class Aspose::Email::Clients::Pop3::Pop3Client
friend

◆ Aspose::Email::Clients::Smtp::SmtpClient

friend class Aspose::Email::Clients::Smtp::SmtpClient
friend