Servoy Methods Summary | |
---|---|
String | getAuthenticationError( ) |
String | getInfo( ) |
Object | getParameter( Object ) |
Boolean | isAuthenticated( ) |
void | setParameter( Object, Object ) |
void | setPersistSession( Boolean ) |
Servoy Properties Details |
---|
account
String account
Get/Set the name of the account.Returns
String account String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
domain
String domain
Get/Set the domain name (required when using NTLM).Returns
String domain String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
exchangeVersion
String exchangeVersion
Get/Set the Exchange Version String.Returns
String version String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
host
String host
Get/Set the host name/ip.Returns
String host String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
identifier
Number identifier
Convenience method to 'bind' the connection to a single user.Returns
Number identifier int
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
licenseLocation
String licenseLocation
Get/Set the location of the licenseReturns
String filePath String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
mailbox
String mailbox
Get/Set the mailbox name (optional, normally this is equal to the account name).Returns
String mailbox String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
password
String password
Get/Set the password.Returns
String password String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
prefix
String prefix
Get/Set the prefix (normally this is "Exchange").Returns
String prefix String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
privateKeystoreLocation
String privateKeystoreLocation
Get/Set the location of the keystore when you use your own keystore.Returns
String filePath String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
serverTypeKerio
Boolean serverTypeKerio
Get/Set the server type to Kerio.Returns
Boolean kerio boolean
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
timeZone
String timeZone
Get/Set the timezoneReturns
String timezone String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
useNTLM
Boolean useNTLM
Get/Set NTLM enabled (domain name required).Returns
Boolean use boolean
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
useSSL
Boolean useSSL
Get/Set SSL enabled.Returns
Boolean enabled boolean
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
Servoy Methods Details |
---|
getAuthenticationError
String getAuthenticationError( )
Retrieve the authentication error when applicable.Returns
String error String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
getInfo
String getInfo( )
Will return a string with information about the connection when authenticating.Returns
String info String
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
getParameter
Object getParameter( Object )
Use this to retrieve your own custom parameters (by name).Parameters
Object key the key
Returns
Object parameter Object
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
isAuthenticated
Boolean isAuthenticated( )
Retrieve the authentication status (returns true/false).Returns
Boolean result boolean
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
setParameter
void setParameter( Object, Object )
Use this to set your own custom parameters (by name) for later use.Parameters
Object key the key
Object value the value
Returns
void
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}
setPersistSession
void setPersistSession( Boolean )
Set this to true when you are going to work on more than one item to speed things up (don't forget to set to false afterwards) .Parameters
Boolean persist the persist
Returns
void
Supported Clients
SmartClient, WebClient, NGClient
Sample
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
// Mandatory arguments are: hostname, account, password and prefix (prefix will normally be 'Exchange')
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");
// Optional arguments can be:
// connection.mailbox (defaults to the account name)
// connection.useSSL (defaults to false)
// Check and authenticate the IEConnection Object against the Exchange Server
// This method returns a boolean true (success) or false (failed)
if (plugins.it2be_exchange.authenticate(connection)) {
// Output the connection with success
application.output(connection);
// And return the connection for later use
Return connection;
} else {
// Output the connection error
application.output(connection.getAuthenticationError());
// Return a null value to inform the calling method about the failed connection
Return null;
}