Class NSEMailConnectionInfo

All information needed to connect to a mail server.

Constructors

NSEMailConnectionInfo()

Initializes a new instance of the NSEMailConnectionInfo class.

Declaration

NSEMailConnectionInfo

Methods

GetFolder()

Declaration

String GetFolder()

Examples

NSEMailConnectionInfo thing;
String folder = thing.GetFolder();

Returns

Type	Description
String	Optional folder to set as current after logging in.

GetPassword()

Declaration

String GetPassword()

Examples

NSEMailConnectionInfo thing;
String password = thing.GetPassword();

Returns

Type	Description
String	Password for the username.

GetServerName()

Declaration

String GetServerName()

Examples

NSEMailConnectionInfo thing;
String serverName = thing.GetServerName();

Returns

Type	Description
String	Hostname or IP to server to connect to. Custom ports may be specified by adding ':' and the port number after the name/ip. For example, '127.0.0.1:6543'

GetUserName()

Declaration

String GetUserName()

Examples

NSEMailConnectionInfo thing;
String userName = thing.GetUserName();

Returns

Type	Description
String	Name of user to log in with.

GetUseSSL()

Declaration

Bool GetUseSSL()

Examples

NSEMailConnectionInfo thing;
Bool useSSL = thing.GetUseSSL();

Returns

Type	Description
Bool	Use a secure connection with the server.

SetFolder(String)

Declaration

Void SetFolder(String folder)

Examples

NSEMailConnectionInfo thing;
String folder;
thing.SetFolder(folder);

Parameters

Type	Name	Description
String	folder	Optional folder to set as current after logging in.

Returns

Type	Description
Void

SetPassword(String)

Declaration

Void SetPassword(String password)

Examples

NSEMailConnectionInfo thing;
String password;
thing.SetPassword(password);

Parameters

Type	Name	Description
String	password	Password for the username.

Returns

Type	Description
Void

SetServerName(String)

Declaration

Void SetServerName(String serverName)

Examples

NSEMailConnectionInfo thing;
String serverName;
thing.SetServerName(serverName);

Parameters

Type	Name	Description
String	serverName	Hostname or IP to server to connect to. Custom ports may be specified by adding ':' and the port number after the name/ip. For example, '127.0.0.1:6543'

Returns

Type	Description
Void

SetUserName(String)

Declaration

Void SetUserName(String userName)

Examples

NSEMailConnectionInfo thing;
String userName;
thing.SetUserName(userName);

Parameters

Type	Name	Description
String	userName	Name of user to log in with.

Returns

Type	Description
Void

SetUseSSL(Bool)

Declaration

Void SetUseSSL(Bool useSSL)

Examples

NSEMailConnectionInfo thing;
Bool useSSL;
thing.SetUseSSL(useSSL);

Parameters

Type	Name	Description
Bool	useSSL	Use a secure connection with the server?

Returns

Type	Description
Void