Show / Hide Table of Contents

Class NSMailboxEntity

Syntax

Constructors

NSMailboxEntity()

Declaration
NSMailboxEntity

Methods

GetAddress()

Declaration
String GetAddress()
Returns
Type Description
String

The address associated with this mailbox (used as FROM address when sending emails).

Examples
NSMailboxEntity thing;
String address = thing.GetAddress();

GetMailInFilterId()

Declaration
Integer GetMailInFilterId()
Returns
Type Description
Integer

The primary key (auto-incremented).

Examples
NSMailboxEntity thing;
Integer mailInFilterId = thing.GetMailInFilterId();

GetPassword()

Declaration
String GetPassword()
Returns
Type Description
String

The password used to log into the mail account. This is hidden when reading.

Examples
NSMailboxEntity thing;
String password = thing.GetPassword();

GetPort()

Declaration
Integer GetPort()
Returns
Type Description
Integer

The port used to connect to the server.

Examples
NSMailboxEntity thing;
Integer port = thing.GetPort();

GetServer()

Declaration
String GetServer()
Returns
Type Description
String

The email server to connect to.

Examples
NSMailboxEntity thing;
String server = thing.GetServer();

GetServerType()

Declaration
Integer GetServerType()
Returns
Type Description
Integer

The protocol to use (POP/IMAP). See MailboxType

Examples
NSMailboxEntity thing;
Integer serverType = thing.GetServerType();

GetUsername()

\n

Declaration
String GetUsername()
Returns
Type Description
String

nThe username used to log onto the mail account.

Examples
NSMailboxEntity thing;
String username = thing.GetUsername();

SetAddress(String)

Declaration
Void SetAddress(String address)
Parameters
Type Name Description
String address

The address associated with this mailbox (used as FROM address when sending emails).

Returns
Type Description
Void
Examples
NSMailboxEntity thing;
String address;
thing.SetAddress(address);

SetMailInFilterId(Integer)

Declaration
Void SetMailInFilterId(Integer mailInFilterId)
Parameters
Type Name Description
Integer mailInFilterId

The primary key (auto-incremented).

Returns
Type Description
Void
Examples
NSMailboxEntity thing;
Integer mailInFilterId;
thing.SetMailInFilterId(mailInFilterId);

SetPassword(String)

Declaration
Void SetPassword(String password)
Parameters
Type Name Description
String password

The password used to log into the mail account. This is hidden when reading.

Returns
Type Description
Void
Examples
NSMailboxEntity thing;
String password;
thing.SetPassword(password);

SetPort(Integer)

Declaration
Void SetPort(Integer port)
Parameters
Type Name Description
Integer port

The port used to connect to the server.

Returns
Type Description
Void
Examples
NSMailboxEntity thing;
Integer port;
thing.SetPort(port);

SetServer(String)

Declaration
Void SetServer(String server)
Parameters
Type Name Description
String server

The email server to connect to.

Returns
Type Description
Void
Examples
NSMailboxEntity thing;
String server;
thing.SetServer(server);

SetServerType(Integer)

Declaration
Void SetServerType(Integer serverType)
Parameters
Type Name Description
Integer serverType

The protocol to use (POP/IMAP). See MailboxType.

Returns
Type Description
Void
Examples
NSMailboxEntity thing;
Integer serverType;
thing.SetServerType(serverType);

SetUsername(String)

Declaration
Void SetUsername(String username)
Parameters
Type Name Description
String username

The username used to log onto the mail account.

Returns
Type Description
Void
Examples
NSMailboxEntity thing;
String username;
thing.SetUsername(username);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top