Class NSEMailConnectionInfo
All information needed to connect to a mail server.
Syntax
Constructors
NSEMailConnectionInfo()
Initializes a new instance of the NSEMailConnectionInfo class.
Declaration
NSEMailConnectionInfoMethods
GetFolder()
All information needed to connect to a mail server.
Declaration
String GetFolder()Returns
| Type | Description |
|---|---|
| String | Optional folder to set as current after logging in. |
Examples
NSEMailConnectionInfo thing;
String folder = thing.GetFolder();GetPassword()
All information needed to connect to a mail server.
Declaration
String GetPassword()Returns
| Type | Description |
|---|---|
| String | Password for the username. |
Examples
NSEMailConnectionInfo thing;
String password = thing.GetPassword();GetServerName()
All information needed to connect to a mail server.
Declaration
String 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' |
Examples
NSEMailConnectionInfo thing;
String serverName = thing.GetServerName();GetUserName()
All information needed to connect to a mail server.
Declaration
String GetUserName()Returns
| Type | Description |
|---|---|
| String | Name of user to log in with. |
Examples
NSEMailConnectionInfo thing;
String userName = thing.GetUserName();GetUseSSL()
All information needed to connect to a mail server.
Declaration
Bool GetUseSSL()Returns
| Type | Description |
|---|---|
| Bool | Use a secure connection with the server. |
Examples
NSEMailConnectionInfo thing;
Bool useSSL = thing.GetUseSSL();SetFolder(String)
All information needed to connect to a mail server.
Declaration
Void SetFolder(String folder)Parameters
| Type | Name | Description |
|---|---|---|
| String | folder | Optional folder to set as current after logging in. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSEMailConnectionInfo thing;
String folder;
thing.SetFolder(folder);SetPassword(String)
All information needed to connect to a mail server.
Declaration
Void SetPassword(String password)Parameters
| Type | Name | Description |
|---|---|---|
| String | password | Password for the username. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSEMailConnectionInfo thing;
String password;
thing.SetPassword(password);SetServerName(String)
All information needed to connect to a mail server.
Declaration
Void SetServerName(String 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 |
Examples
NSEMailConnectionInfo thing;
String serverName;
thing.SetServerName(serverName);SetUserName(String)
All information needed to connect to a mail server.
Declaration
Void SetUserName(String userName)Parameters
| Type | Name | Description |
|---|---|---|
| String | userName | Name of user to log in with. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSEMailConnectionInfo thing;
String userName;
thing.SetUserName(userName);SetUseSSL(Bool)
All information needed to connect to a mail server.
Declaration
Void SetUseSSL(Bool useSSL)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | useSSL | Use a secure connection with the server? |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSEMailConnectionInfo thing;
Bool useSSL;
thing.SetUseSSL(useSSL);