Returns the current version (major, minor, build)

Returns date release date

Returns the component name

Returns the licensee

Returns the type that is valid for this license

Returns the current version (major, minor)

Returns the version that is valid for this license

Take the IEConnection Object and authenticate against the Exchange Server.

// Take the IEConnection Object and authenticate against the Exchange Server.
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");

// Optional arguments can be:
connection.appointmentFolderName = "Agenda";
connection.contactsFolderName = "Contactpersonen";
connection.deletedFolderName = "Verwijderde items";
connection.draftsFolderName = "Concepten";
connection.inboxFolderName = "Postvak IN";
connection.publicContactsFolderName = "Openbare mappen";
connection.tasksFolderName = "Taken";

// In which timezone is the Exchange server located
connection.timeZone = "GMT+1.00";

connection.domain = "exchange.vm.com";

// Check and authenticate the IEConnection Object against the Exchange Server
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;
}

Creates a new folder and returns the folderId for later use. Optionally create the folder in the root.

Create a contact.

// Create a contact.
var record = foundset.getRecord(foundset.getSelectedIndex());

// While working with only one connection you can use a global to define it
// For further use of the IEConnection Object please see the getConnection sample data
var connection = globals.getConnection();

// return when no record available
if (controller.getSelectedIndex() < 0) {
Return;
}

// create the contact in MS Exchange
// your root folder wil always be the contact folder on the exchange server
// when you don't work with an English version please set the contact folder name in the IEConnection Object
var contact = plugins.it2be_exchange.createContact(connection);

// you can also create a contact direct into a subfolder, seperate the folders with '/'
// you should always follow the complete structure in the correct language like below
// var contact = plugins.it2be_exchange.createContact(connection, "Contacts/private");

if (contact) {
// set the data, there are many more fields available than these
// for the purpose of this sample we use fixed data
contact.firstName = record.it2be_companies_to_it2be_contacts.firstname;
contact.lastName = record.it2be_companies_to_it2be_contacts.lastname;

contact.companyName = company_name;

// you should add a relation address here, in this case it is hard coded :)
contact.businessAddressStreet = "street 1";
contact.businessAddressCity = "city";
contact.businessAddressCountry = "country";

// save the data. this method returns the unique id which can be stored for
// synchronization and other purposes
record.it2be_companies_to_it2be_contacts.exchangeid = contact.save();

controller.saveData();
} else {
plugins.it2be_exchange.showErrorDialog("Error", "creating the contact failed");
}

Creates a new folder and returns the folderId for later use. Optionally create the folder in the root.

Create a new event

Creates a new folder and returns the folderId for later use. Optionally create the folder in the root.

Create an email.

// Create an email.
var record = foundset.getRecord(foundset.getSelectedIndex());

// While working with only one connection you can use a global to define it
// For further use of the IEConnection Object please see the getConnection sample data
var connection = globals.getConnection();

// return when no record available
if (controller.getSelectedIndex() < 0) {
Return;
}

// Send your email through MS Exchange mail.
// your root folder wil always be the 'outbox' folder on the exchange server
// when you don't work with an English version please set the mail and drafts folder name in the IEConnection Object
var mail = plugins.it2be_exchange.createMail(connection);

if (mail) {
// set the data, there are many more fields available than these
// for the purpose of this sample we use fixed data
mail.sender = "[email protected]";
mail.to = "[email protected]";
if (mail.cc) {
mail.cc = record.emailcc;
}
if (mail.bcc) {
mail.bcc = record.emailbcc;
}
mail.subject = "email subject";
mail.body = "email body text";

// or send an HTML message
// mail.htmlBody = "are you 
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
         happy 
        with the result?";

if (attachment) {
// set the path to attach a file to the email
// 	mail.createAttachment(attachment);
}

// send the email. this method returns the exchange id which can be stored for
// synchronization and other purposes
record.exchangeid = mail.send();

controller.saveData();
} else {
if (!mail.to) {
plugins.it2be_exchange.showErrorDialog("Error", "you forgot to set a mail to email message");
} else {
plugins.it2be_exchange.showErrorDialog("Error", "creating the email message failed");
}
}

Create a contact in the public folder.

// Create a contact in the public folder.
var record = foundset.getRecord(foundset.getSelectedIndex());

// While working with only one connection you can use a global to define it
// For further use of the IEConnection Object please see the getConnection sample data
var connection = globals.getConnection();

// return when no record available
if (controller.getSelectedIndex() < 0) {
Return;
}

// create the contact in MS Exchange
// your root folder wil always be the contact folder on the exchange server
// when you don't work with an English version please set the contact folder name in the IEConnection Object
var contact = plugins.it2be_exchange.createContact(connection);

// you can also create a contact direct into a subfolder, seperate the folders with '/'
// you should always follow the complete structure in the correct language like below
// var contact = plugins.it2be_exchange.createContact(connection, "Contacts/private");

if (contact) {
// set the data, there are many more fields available than these
// for the purpose of this sample we use fixed data
contact.firstName = record.it2be_companies_to_it2be_contacts.firstname;
contact.lastName = record.it2be_companies_to_it2be_contacts.lastname;

contact.companyName = company_name;

// you should add a relation address here, in this case it is hard coded :)
contact.businessAddressStreet = "street 1";
contact.businessAddressCity = "city";
contact.businessAddressCountry = "country";

// save the data. this method returns the unique id which can be stored for
// synchronization and other purposes
record.it2be_companies_to_it2be_contacts.exchangeid = contact.save();

controller.saveData();
} else {
plugins.it2be_exchange.showErrorDialog("Error", "creating the contact failed");
}

Create a task.

// Create a task.
var record = foundset.getRecord(foundset.getSelectedIndex());

// While working with only one connection you can use a global to define it
// For further use of the IEConnection Object please see the getConnection sample data
var connection = globals.getConnection();

// create the task in MS Exchange
// your root folder wil always be the task folder on the exchange server
// when you don't work with an English version please set the tasks folder name in the IEConnection Object
var task = plugins.it2be_exchange.createTask(connection);

// you can also create a task direct into a subfolder, seperate the folders with '/'
// you should always follow the complete structure in the correct language like below
// var task = plugins.it2be_exchange.createTask(connection, "Tasks/private");

if (task) {
// set the data, there are many more fields available than these
// for the purpose of this sample we use fixed data
var today = new Date();
var date1 = new Date(today.getFullYear(), today.getMonth(), today.getDate(), today.getHours());
var date2 = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 1, today.getHours());

task.subject = "task subject";
task.body = "task body";
task.startDate = date1;
task.dueDate = date2;
task.status = plugins.it2be_exchange.type.taskStatus_WAITING

// save the data. this method returns the unique id which can be stored for
// synchronization and other purposes
record.exchangeid = task.save();

controller.saveData();

} else {
plugins.dialogs.showErrorDialog("Error", "creating the task failed");
}

Creates a new folder and returns the folderId for later use. Optionally create the folder in the root.

// Creates a new folder and returns the folderId for later use. Optionally create the folder in the root.
// While working with only one connection you can use a global to define it
// For further use of the IEConnection Object please see the getConnection sample data
var connection = globals.getConnection();

// When you create a new folder this can be done in the 'root'
// Or you can create a complete structure
// IMPORTANT: the parent folder must always be created first
plugins.it2be_exchange.createTaskFolder(connection, connection.tasksFolderName + "/servoy");

// Give the connection the time to 'recover' for the next action
application.sleep(1000);

plugins.it2be_exchange.createTaskFolder(connection, connection.tasksFolderName + "/servoy/test");

Delete an attachment by ID.

Delete a contact by ID, changeKey (can be null) and deleteType (hard Delete or move to trash).

Delete a batch of IEContacts (hard Delete or move to trash).

Delete an event by ID, changeKey (can be null), deleteType (hard Delete or move to trash) and meetingCancellationType.

Delete an batch of IEEvents (hard Delete or move to trash) and meetingCancellationType.

Delete an email message by ID and optional changeKey and deleteType (hard Delete or move to trash).

Delete a batch of IEMail messages (hard Delete or move to trash).

Delete a task by ID, changeKey (can be null) and deleteType (hard Delete or move to trash).

Delete a batch of IETasks (hard Delete or move to trash).

Encode the text in case you need html body text for mail etc.

Retrieve all subfolders of the root or enter folder ID (optional boolean isDeepTraversel).

// While working with only one connection you can use a global to define it
// For further use of the IEConnection Object please see the getConnection sample data
var connection = globals.getConnection();

// This way you can retrieve all folders in the root
var folders = plugins.it2be_exchange.getAllFolders(connection);
var message = "";

// Loop through the found set.
if (folders) {
for (var i = 0 ; i < folders.length ; i++) {
message += folders[i] + "\n";
}
}

if (message) {
plugins.it2be_exchange.showInfoDialog("folders", message);
} else {
plugins.it2be_exchange.showErrorDialog("folders", "there are no subfolders!");
}

Returns connection object after authenticating. Returns null when not valid.

// TReturns connection object after authenticating. Returns null when not valid.
// First thing to do is create a IEConnection Object to store credentials and Exchange Server details
var connection = plugins.it2be_exchange.getConnection("192.168.1.69", "marcel.test", "test", "Exchange");

// Optional arguments can be:
connection.appointmentFolderName = "Agenda";
connection.contactsFolderName = "Contactpersonen";
connection.deletedFolderName = "Verwijderde items";
connection.draftsFolderName = "Concepten";
connection.inboxFolderName = "Postvak IN";
connection.publicContactsFolderName = "Openbare mappen";
connection.tasksFolderName = "Taken";

// In which timezone is the Exchange server located
connection.timeZone = "GMT+1.00";

connection.domain = "exchange.vm.com";

// Check and authenticate the IEConnection Object against the Exchange Server
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;
}

Retrieve a contact by ID and optional changeKey (can be null) for display and/or update purposes.

var record = foundset.getRecord(foundset.getSelectedIndex());

// While working with only one connection you can use a global to define it
// For further use of the IEConnection Object please see the getConnection sample data
var connection = globals.getConnection();

// return when no record available
if (controller.getSelectedIndex() < 0) {
Return;
}

// check the stored id in the database
if (!databaseManager.hasRecords(record.it2be_companies_to_it2be_contacts) || !record.it2be_companies_to_it2be_contacts.exchangeid) {
plugins.it2be_exchange.showErrorDialog("Error", "No exchange (unique) id found");

Return;
}

// and retrieve the actual contact from MS Exchange
var contact = plugins.it2be_exchange.getContact(connection, record.it2be_companies_to_it2be_contacts.exchangeid);

if (contact != null) {
var message = contact.firstName + " " + contact.lastName + "\n";

plugins.it2be_exchange.showInfoDialog("Information", message);
} else {
plugins.it2be_exchange.showErrorDialog("Error", "no records found");
}

Retrieve an array of contacts with an optional offset and maximum count (this method is the only one supported by Kerio).

Retrieve an array of all contacts or by xmlSearchExpression.

// Retrieve an array of all contacts or by xmlSearchExpression.
var record = foundset.getRecord(foundset.getSelectedIndex());

// While working with only one connection you can use a global to define it
// For further use of the IEConnection Object please see the getConnection sample data
var connection = globals.getConnection();

// retrieve a set from the root
var	set = plugins.it2be_exchange.getContacts(connection)

// or retrieve a set from a subfolder system
// var set = plugins.it2be_exchange.getContacts(connection, "private:friends");

var message = "";

// and loop through the result set, make sure it is not too big to avoid memory issues
if (set.length > 0) {
for (var i = 0 ; i < set.length ; i++) {
var contact = set[i];

message += contact.firstName + " " + contact.lastName + "\n";
}
} else {
message = "No contacts found.";
}

if (message) {
plugins.it2be_exchange.showInfoDialog("find result", message);
} else {
plugins.it2be_exchange.showErrorDialog("find result", "no records found");
}

Retrieve an event by ID and optional changeKey (can be null) for display and/or update purposes.

Retrieve an array of calendar events with an optional offset and maximum count (this method is the only one supported by Kerio).

Retrieve an array of events started between start and end date or by xmlSearchExpression.

// Retrieve a task by ID and optional changeKey (can be null) for display and/or update purposes.
var record = foundset.getRecord(foundset.getSelectedIndex());

// While working with only one connection you can use a global to define it
// For further use of the IEConnection Object please see the getConnection sample data
var connection = globals.getConnection();

// check the stored id in the database
if (!record.exchangeid) {
plugins.it2be_exchange.showErrorDialog("Error", "No exchange (unique) id found");

Return;
}

// and retrieve the actual appointment from MS Exchange
var task = plugins.it2be_exchange.getTask(connection, record.exchangeid);

if (task != null) {
var message = task.startDate + " " + task.status + " " + task.subject + "\n";

plugins.it2be_exchange.showInfoDialog("Information", message);
} else {
plugins.it2be_exchange.showErrorDialog("Error", "no record found");
}

// You have to register your plug-in(s) and beans before you start using them
// One way to do so is create an 'onOpenSolution' method and add the 'register(.)' method(s) there
plugins.it2be_exchange.register("Insert the license string(s) from your '*_runtime_license.txt' file here!");