Outlook Plug-in

Servoy Properties Summary
Boolean	alternateRecipientAllowed
Array<Object>	attachments
Boolean	autoForwarded
String	bcc
String	billingInformation
String	body
String	categories
String	cc
String	companies
Boolean	deleteAfterSubmit
Date	expiryTime
String	htmlBody
String	mileage
Boolean	originatorDeliveryReportRequested
Boolean	readReceiptRequested
Date	reminderDate
Boolean	reminderOverrideDefault
Boolean	reminderPlaySound
Boolean	reminderSet
String	reminderSoundFile
SensitivityType	sensitivity
String	sentOnBehalfOfName
String	subject
String	to
String	votingOptions
String	votingResponse

Servoy Methods Summary
Boolean	createAttachment( String )
Boolean	createAttachment( File )
Boolean	display( Boolean )
Boolean	display( )
Number	getAttachmentsCount( )
String	getConversationIndex( )
String	getConversationTopic( )
Date	getCreationTime( )
Date	getLastModificationTime( )
Number	getLength( )
String	getNext( )
String	getOutlookID( )
String	getParentFolder( )
String	getReceivedByEntryID( )
String	getReceivedByName( )
String	getReceivedOnBehalfOfEntryID( )
String	getReceivedOnBehalfOfName( )
String	getReplyRecipientNames( )
String	getSenderAddress( )
String	getSenderEmailType( )
String	getSenderName( )
Date	getSentOn( )
Number	getSize( )
Boolean	hasNext( )
Boolean	isAutoResolvedWinner( )
Boolean	isSent( )
Boolean	isSubmitted( )
Boolean	isUnRead( )
void	reset( )
String	save( )
String	saveAs( String )
String	send( Function )
String	send( Boolean, Function )
String	send( )
String	send( Boolean )
void	setEnableSharedAttachments( Boolean )

Servoy Properties Details

alternateRecipientAllowed
Boolean alternateRecipientAllowed

Get/Set alternateRecipientAllowed.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().alternateRecipientAllowed);

attachments
Array<Object> attachments

Get/Set attachments.

Returns
Array<Object> Object[]

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().attachments);

autoForwarded
Boolean autoForwarded

Get/Set autoForwarded.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().autoForwarded);

bcc
String bcc

Get/Set bcc.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().bcc);

billingInformation
String billingInformation

Get/Set billingInformation.

Returns
String String

Supported Clients
SmartClient

Sample

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

body
String body

Get/Set body.

Returns
String String

Supported Clients
SmartClient

Sample

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

categories
String categories

Get/Set categories.

Returns
String String

Supported Clients
SmartClient

Sample

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

cc
String cc

Get/Set cc.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().cc);

companies
String companies

Get/Set companies.

Returns
String String

Supported Clients
SmartClient

Sample

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

deleteAfterSubmit
Boolean deleteAfterSubmit

Get/Set deleteAfterSubmit.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().deleteAfterSubmit);

expiryTime
Date expiryTime

Get/Set expiryTime.

Returns
Date Date

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().expiryTime);

htmlBody
String htmlBody

Get/Set htmlBody.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().htmlBody);

mileage
String mileage

Get/Set mileage.

Returns
String String

Supported Clients
SmartClient

Sample

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

originatorDeliveryReportRequested
Boolean originatorDeliveryReportRequested

Get/Set originatorDeliveryReportRequested.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().originatorDeliveryReportRequested);

readReceiptRequested
Boolean readReceiptRequested

Get/Set readReceiptRequested.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().readReceiptRequested);

reminderDate
Date reminderDate

Get/Set reminderDate.

Returns
Date Date

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().reminderDate);

reminderOverrideDefault
Boolean reminderOverrideDefault

Get/Set reminderOverrideDefault.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

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

reminderPlaySound
Boolean reminderPlaySound

Get/Set reminderPlaySound.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

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

reminderSet
Boolean reminderSet

Get/Set reminderSet.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

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

reminderSoundFile
String reminderSoundFile

Get/Set reminderSoundFile.

Returns
String String

Supported Clients
SmartClient

Sample

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

sensitivity
SensitivityType sensitivity

Get/Set sensitivity.

Returns
SensitivityType SensitivityType

Supported Clients
SmartClient

Sample

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

sentOnBehalfOfName
String sentOnBehalfOfName

Get/Set sentOnBehalfOfName.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().sentOnBehalfOfName);

subject
String subject

Get/Set subject.

Returns
String String

Supported Clients
SmartClient

Sample

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

to
String to

Get/Set to.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().to);

votingOptions
String votingOptions

Get/Set votingOptions.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().votingOptions);

votingResponse
String votingResponse

Get/Set votingResponse.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().votingResponse);

Servoy Methods Details

createAttachment
Boolean createAttachment( String )

Create an attachment from a file path.

Parameters
String filePath the file path

Returns
Boolean result boolean

Supported Clients
SmartClient

Sample

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

createAttachment
Boolean createAttachment( File )

Create an attachment from a file.

Parameters
File file the file

Returns
Boolean result boolean

Supported Clients
SmartClient

Sample

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

display
Boolean display( Boolean )

Display the current item.

Parameters
Boolean modal the modal

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

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

Return;
}

// load the mail by the id
var mail = plugins.it2be_outlook.getMail(globals.mailid);

// and display the mail
if (mail) {
mail.display(true); //make the appearance modal (true) or not (false)
} else {
plugins.dialogs.showErrorDialog("Error", "could not display the email message!");
}

display
Boolean display( )

Display the current item.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

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

Return;
}

// load the mail by the id
var mail = plugins.it2be_outlook.getMail(globals.mailid);

// and display the mail
if (mail) {
mail.display(true); //make the appearance modal (true) or not (false)
} else {
plugins.dialogs.showErrorDialog("Error", "could not display the email message!");
}

getAttachmentsCount
Number getAttachmentsCount( )

Get attachmentsCount.

Returns
Number int

Supported Clients
SmartClient

Sample

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

getConversationIndex
String getConversationIndex( )

Get/Set getConversationIndex.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getConversationIndex);

getConversationTopic
String getConversationTopic( )

Get conversationTopic.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getConversationTopic);

getCreationTime
Date getCreationTime( )

Get creationTime.

Returns
Date Date

Supported Clients
SmartClient

Sample

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

getLastModificationTime
Date getLastModificationTime( )

Get lastModificationTime.

Returns
Date Date

Supported Clients
SmartClient

Sample

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

getLength
Number getLength( )

Return the length of the selected set of items.

Returns
Number long

Supported Clients
SmartClient

Sample

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

getNext
String getNext( )

Get the next item of the selected set of items.

Returns
String String

Supported Clients
SmartClient

Sample

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

getOutlookID
String getOutlookID( )

Get the outlook ID of the item.

Returns
String String

Supported Clients
SmartClient

Sample

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

getParentFolder
String getParentFolder( )

Get/Set getParentFolder.

Returns
String String

Supported Clients
SmartClient

Sample

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

getReceivedByEntryID
String getReceivedByEntryID( )

Get receivedByEntryID.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getReceivedByEntryID);

getReceivedByName
String getReceivedByName( )

Get receivedByName.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getReceivedByName);

getReceivedOnBehalfOfEntryID
String getReceivedOnBehalfOfEntryID( )

Get receivedOnBehalfOfEntryID.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getReceivedOnBehalfOfEntryID);

getReceivedOnBehalfOfName
String getReceivedOnBehalfOfName( )

Get receivedOnBehalfOfName.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getReceivedOnBehalfOfName);

getReplyRecipientNames
String getReplyRecipientNames( )

Get replyRecipientNames.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getReplyRecipientNames);

getSenderAddress
String getSenderAddress( )

Get senderAddress.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getSenderAddress);

getSenderEmailType
String getSenderEmailType( )

Get senderEmailAddress.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getSenderEmailType);

getSenderName
String getSenderName( )

Get senderName.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getSenderName);

getSentOn
Date getSentOn( )

Get sentOn.

Returns
Date Date

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().getSentOn);

getSize
Number getSize( )

Get size.

Returns
Number int

Supported Clients
SmartClient

Sample

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

hasNext
Boolean hasNext( )

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

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

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

isAutoResolvedWinner
Boolean isAutoResolvedWinner( )

Get autoResolvedWinner boolean value.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().isAutoResolvedWinner);

isSent
Boolean isSent( )

Get sent boolean value.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().isSent);

isSubmitted
Boolean isSubmitted( )

Get submitted boolean value.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().isSubmitted);

isUnRead
Boolean isUnRead( )

Get unRead boolean value.

Returns
Boolean boolean

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().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 String

Supported Clients
SmartClient

Sample

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

saveAs
String saveAs( String )

Save the current item to the specified path.

Parameters
String path the path

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().saveAs);

send
String send( Function )

send the email with additional wait boolean and/or return method.

Parameters
Function method the method

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().send);

send
String send( Boolean, Function )

send the email with additional wait boolean and/or return method.

Parameters
Boolean  wait  the wait
Function  method  the method

Returns
String  String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().send);

send
String send( )

send the email with additional wait boolean and/or return method.

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().send);

send
String send( Boolean )

send the email with additional wait boolean and/or return method.

Parameters
Boolean wait the wait

Returns
String String

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().send);

setEnableSharedAttachments
void setEnableSharedAttachments( Boolean )

Get/Set setEnableSharedAttachments.

Parameters
Boolean AutoForwarded the auto forwarded

Returns
void

Supported Clients
SmartClient

Sample

application.output(plugins.it2be_outlook.mail().setEnableSharedAttachments);