AP&C API Reference
Public Member Functions | Protected Member Functions | Properties | List of all members
Apac.Configuration.SmtpSetup Class Reference

A simple class to convey SMTP email setup information for configuring the system to send email notifications. More...

Inheritance diagram for Apac.Configuration.SmtpSetup:

Public Member Functions

 SmtpSetup ()
 Initializes a new instance of the SmtpSetup class. More...
 
 SmtpSetup (SmtpNetworkElement config, bool useSsl)
 Initializes a new instance of the SmtpSetup class. More...
 
 SmtpSetup (string host, int port, string userName, string password, bool useSsl)
 Initializes a new instance of the SmtpSetup class. More...
 
void GetObjectData (SerializationInfo info, StreamingContext context)
 Populates a T:System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object. More...
 

Protected Member Functions

 SmtpSetup (SerializationInfo info, StreamingContext context)
 Initializes a new instance of the SmtpSetup class. More...
 

Properties

string Host [get, set]
 Gets or sets the host. More...
 
int Port [get, set]
 Gets or sets the port. More...
 
string UserName [get, set]
 Gets or sets the name of the user. More...
 
string Password [get, set]
 Gets or sets the password. More...
 
bool UseSsl [get, set]
 Gets or sets a value indicating whether use SSL to connect to the SMTP server. More...
 

Detailed Description

A simple class to convey SMTP email setup information for configuring the system to send email notifications.

Constructor & Destructor Documentation

◆ SmtpSetup() [1/4]

Apac.Configuration.SmtpSetup.SmtpSetup ( SerializationInfo  info,
StreamingContext  context 
)
inlineprotected

Initializes a new instance of the SmtpSetup class.

Parameters
infoThe information.
contextThe context.

◆ SmtpSetup() [2/4]

Apac.Configuration.SmtpSetup.SmtpSetup ( )
inline

Initializes a new instance of the SmtpSetup class.

◆ SmtpSetup() [3/4]

Apac.Configuration.SmtpSetup.SmtpSetup ( SmtpNetworkElement  config,
bool  useSsl 
)
inline

Initializes a new instance of the SmtpSetup class.

Parameters
configThe network setup from the configuration file.
useSslif set to true use SSL to connect to the SMTP server.

◆ SmtpSetup() [4/4]

Apac.Configuration.SmtpSetup.SmtpSetup ( string  host,
int  port,
string  userName,
string  password,
bool  useSsl 
)
inline

Initializes a new instance of the SmtpSetup class.

Parameters
hostThe host.
portThe port.
userNameName of the user.
passwordThe password.
useSslif set to true use SSL to connect to the SMTP server.

Member Function Documentation

◆ GetObjectData()

void Apac.Configuration.SmtpSetup.GetObjectData ( SerializationInfo  info,
StreamingContext  context 
)
inline

Populates a T:System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

Parameters
infoThe T:System.Runtime.Serialization.SerializationInfo to populate with data.
contextThe destination (see T:System.Runtime.Serialization.StreamingContext) for this serialization.

Property Documentation

◆ Host

string Apac.Configuration.SmtpSetup.Host
getset

Gets or sets the host.

The host.

◆ Password

string Apac.Configuration.SmtpSetup.Password
getset

Gets or sets the password.

The password.

◆ Port

int Apac.Configuration.SmtpSetup.Port
getset

Gets or sets the port.

The port.

◆ UserName

string Apac.Configuration.SmtpSetup.UserName
getset

Gets or sets the name of the user.

The name of the user.

◆ UseSsl

bool Apac.Configuration.SmtpSetup.UseSsl
getset

Gets or sets a value indicating whether use SSL to connect to the SMTP server.

true if [use SSL]; otherwise, false.


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