Outlook Plug-in

Servoy Properties Summary
Boolean	allDayEvent
String	billingInformation
String	body
BusyStatus	busyStatus
String	categories
String	companies
Boolean	conferenceServerAllowExternal
String	conferenceServerPassword
Number	duration
Date	end
ImportanceType	importance
Number	internetCodepage
Boolean	isOnlineMeeting
String	location
MeetingStatus	meetingStatus
String	mileage
Boolean	netMeetingAutoStart
String	netMeetingDocPathName
String	netMeetingOrganizerAlias
String	netMeetingServer
String	netShowURL
Boolean	noAging
String	optionalAttendees
Number	reminderMinutesBeforeStart
Boolean	reminderOverrideDefault
Boolean	reminderPlaySound
Boolean	reminderSet
String	reminderSoundFile
Date	replyTime
String	requiredAttendees
String	resources
Boolean	responseRequested
SensitivityType	sensitivity
Date	start
String	subject

Servoy Methods Summary
Boolean	createAttachment( String )
Boolean	display( Boolean )
Boolean	display( )
Array<Object>	getAttachments( String )
Array<Object>	getAttachments( )
Number	getAttachmentsCount( )
Date	getCreationTime( )
Date	getLastModificationTime( )
Number	getLength( )
String	getMeetingWorkspaceURL( )
String	getNext( )
String	getOrganizer( )
String	getOutlookID( )
String	getParentFolder( )
Array<Object>	getRecipients( )
IORecurrence	getRecurrence( )
RecurrenceState	getRecurrenceState( )
ResponseStatus	getResponseStatus( )
Number	getSize( )
Boolean	hasNext( )
Boolean	isRecurring( )
Boolean	isUnRead( )
void	reset( )
String	save( )
Boolean	saveAsICal( String, String )

Servoy Properties Details

allDayEvent
Boolean allDayEvent

Get/Set the allDayEvent.

Returns
Boolean result boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().allDayEvent);

billingInformation
String billingInformation

Get/Set the billingInformation.

Returns
String information String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().billingInformation);

body
String body

Get/Set the body.

Returns
String body String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().body);

busyStatus
BusyStatus busyStatus

Get/Set the busy status.

Returns
BusyStatus status BusyStatus

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().busyStatus);

categories
String categories

Get/Set the categories.

Returns
String categories String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().categories);

companies
String companies

Get/Set the companies.

Returns
String companies String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().companies);

conferenceServerAllowExternal
Boolean conferenceServerAllowExternal

Get/Set the is conference server allow external.

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().conferenceServerAllowExternal);

conferenceServerPassword
String conferenceServerPassword

Get/Set the conference server password.

Returns
String password String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().conferenceServerPassword);

duration
Number duration

Get/Set the duration.

Returns
Number duration int

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().duration);

end
Date end

Get/Set the end.

Returns
Date date Date

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().end);

importance
ImportanceType importance

Get/Set the importance.

Returns
ImportanceType importance ImportanceType

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().importance);

internetCodepage
Number internetCodepage

Get/Set the internet codepage.

Returns
Number codepage int

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().internetCodepage);

isOnlineMeeting
Boolean isOnlineMeeting

Get/Set the is online meeting.

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().isOnlineMeeting);

location
String location

Get/Set the location.

Returns
String location String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().location);

meetingStatus
MeetingStatus meetingStatus

Get/Set the meeting status.

Returns
MeetingStatus status MeetingStatus

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().meetingStatus);

mileage
String mileage

Get/Set the mileage.

Returns
String mileage String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().mileage);

netMeetingAutoStart
Boolean netMeetingAutoStart

Get/Set the net is meeting autostart.

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().netMeetingAutoStart);

netMeetingDocPathName
String netMeetingDocPathName

Get/Set the net meeting docpath name.

Returns
String name String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().netMeetingDocPathName);

netMeetingOrganizerAlias
String netMeetingOrganizerAlias

Get/Set the net meeting organizer alias.

Returns
String alias String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().netMeetingOrganizerAlias);

netMeetingServer
String netMeetingServer

Get/Set the net meeting server.

Returns
String server String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().netMeetingServer);

netShowURL
String netShowURL

Get/Set the net show URL.

Returns
String url String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().netShowURL);

noAging
Boolean noAging

Get/Set is no aging.

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().noAging);

optionalAttendees
String optionalAttendees

Get/Set the optional attendees.

Returns
String attendees String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().optionalAttendees);

reminderMinutesBeforeStart
Number reminderMinutesBeforeStart

Get/Set the reminder minutes before start.

Returns
Number state int

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().reminderMinutesBeforeStart);

reminderOverrideDefault
Boolean reminderOverrideDefault

Get/Set is reminder override default.

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().reminderOverrideDefault);

reminderPlaySound
Boolean reminderPlaySound

Get/Set is reminder play sound.

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().reminderPlaySound);

reminderSet
Boolean reminderSet

Get/Set is reminder set.

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().reminderSet);

reminderSoundFile
String reminderSoundFile

Get/Set the reminder sound file.

Returns
String file String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().reminderSoundFile);

replyTime
Date replyTime

Get/Set the reply time.

Returns
Date date Date

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().replyTime);

requiredAttendees
String requiredAttendees

Get/Set the required attendees.

Returns
String attendees String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().requiredAttendees);

resources
String resources

Get/Set the resources.

Returns
String resources String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().resources);

responseRequested
Boolean responseRequested

Get/Set the is response requested.

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().responseRequested);

sensitivity
SensitivityType sensitivity

Get/Set the sensitivity type

Returns
SensitivityType type SensitivityType

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().sensitivity);

start
Date start

Get/Set the start.

Returns
Date date Date

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().start);

subject
String subject

Get/Set the subject.

Returns
String subject String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().subject);

Servoy Methods Details

createAttachment
Boolean createAttachment( String )

Create an attachment.

Parameters
String filepath the filepath

Returns
Boolean result boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().createAttachment);

display
Boolean display( Boolean )

Display the current item.

Parameters
Boolean modal the modal

Returns
Boolean result boolean

Supported Clients
SmartClient

Sample

// check the global appointmentid or take a stored id from the database
if (!globals.appointmentid) {
plugins.dialogs.showErrorDialog("Error", "No outlook id found");

Return;
}

// load the appointment by the id
var appointment = plugins.it2be_outlook.getAppointment(globals.appointmentid);

// and display the appointment
if (appointment) {
appointment.display();
} else {
plugins.dialogs.showErrorDialog("Error", "could not display the appointment!");
}

display
Boolean display( )

Display the current item.

Returns
Boolean result boolean

Supported Clients
SmartClient

Sample

// check the global appointmentid or take a stored id from the database
if (!globals.appointmentid) {
plugins.dialogs.showErrorDialog("Error", "No outlook id found");

Return;
}

// load the appointment by the id
var appointment = plugins.it2be_outlook.getAppointment(globals.appointmentid);

// and display the appointment
if (appointment) {
appointment.display();
} else {
plugins.dialogs.showErrorDialog("Error", "could not display the appointment!");
}

getAttachments
Array<Object> getAttachments( String )

Get the attachments

Parameters
String folderPath the folder path

Returns
Array<Object> attachments Object[]

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getAttachments);

getAttachments
Array<Object> getAttachments( )

Get the attachments

Returns
Array<Object> attachments Object[]

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getAttachments);

getAttachmentsCount
Number getAttachmentsCount( )

Get the attachment count.

Returns
Number count int

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getAttachmentsCount);

getCreationTime
Date getCreationTime( )

Get the creationTime.

Returns
Date date Date

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getCreationTime);

getLastModificationTime
Date getLastModificationTime( )

Get the last modification Ttime.

Returns
Date date Date

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getLastModificationTime);

getLength
Number getLength( )

Return the length of the selected set of items.

Returns
Number length long

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getLength);

getMeetingWorkspaceURL
String getMeetingWorkspaceURL( )

Get the meeting workspace URL.

Returns
String url String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getMeetingWorkspaceURL);

getNext
String getNext( )

Get the next item of the selected set of items.

Returns
String item String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getNext);

getOrganizer
String getOrganizer( )

Get the organizer.

Returns
String organizer String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getOrganizer);

getOutlookID
String getOutlookID( )

Get the outlook ID of the item.

Returns
String id String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getOutlookID);

getParentFolder
String getParentFolder( )

Get the parent folder

Returns
String folder String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getParentFolder);

getRecipients
Array<Object> getRecipients( )

Get the recipients.

Returns
Array<Object> recipients Object[]

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getRecipients);

getRecurrence
IORecurrence getRecurrence( )

Get the recurrence

Returns
IORecurrence recurrence IORecurrence

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getRecurrence);

getRecurrenceState
RecurrenceState getRecurrenceState( )

Get the recurrence state

Returns
RecurrenceState state RecurrenceState

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getRecurrenceState);

getResponseStatus
ResponseStatus getResponseStatus( )

Get the response status.

Returns
ResponseStatus status ResponseStatus

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getResponseStatus);

getSize
Number getSize( )

Get the size.

Returns
Number size int

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().getSize);

hasNext
Boolean hasNext( )

Check that the selected set of items has a 'next' item.

Returns
Boolean result boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().hasNext);

isRecurring
Boolean isRecurring( )

Get is recurring.

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().isRecurring);

isUnRead
Boolean isUnRead( )

Get the is unread

Returns
Boolean is boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().isUnRead);

reset
void reset( )

Reset the set to the first item.

Returns
void

Supported Clients
SmartClient

save
String save( )

Save the current item.

Returns
String id String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.appointment().save);

saveAsICal
Boolean saveAsICal( String, String )

Save the appointment as an iCal file.

Parameters
String  filename  the filename
String  outlookid  the outlookid

Returns
Boolean  result boolean

Supported Clients
SmartClient

Sample

// check the global appointmentid or take a stored id from the database
if (!globals.appointmentid) {
plugins.dialogs.showErrorDialog("Error", "No outlook id found");

Return;
}

// set the name of the file
var filename = plugins.file.showFileSaveDialog();

if (filename) {
//when the filename is not empty get the appointment record from MS Outlook
//and create an iCal (iso exchange format) file with the given filename from the selected appointment
appointment.saveAsICal(filename, globals.appointmentid);
} else {
application.output("appointment empty");
}