Exchange Plugin
Exchange APIs are the methods by which the client can communicate with the Exchange Server for various operations such as Creating, Updating, Searching various objects such as Tasks, Contacts and Calendar. The Exchange APIs enable the client to provide proper input in the SOAP Request Template and get the valid SOAP Response from the Exchange Server. With the help of these the user can even get the information of a particular item such as Contact, Task or Calendar. Every Exchange Plugin API is associated with a web service.
For instance suppose if the User wants to create a new Task then the valid input expected by the ExchangeCreateTask is a structure containing all the fields with the corresponding values. The output is a structure containing the Id and the ChangeKey of the new Task created.
Amongst the Exchange APIs there is ExchangeGetUserInfo which retrieves the User Information provided a valid and Authenticated Username is given as Input. The search scope is limited to the Active Directory. Only authenticated users information is retrieved.
Exchange APIs also enables the user to get the complete list of Items such as Contacts, Calendar or Tasks present in the user's OWA Account. It also provides the functionality to get the Folder and the Sub-Folder Ids of the specified folder.
This Exchange Plugin enables communication with the server using the following set of functions:
- ExchangeOpenConnection()
- ExchangeCloseConnection()
- ExchangeGetUserInfo()
- ExchangeCreateTask()
- ExchangeCreateCalendarItem()
- ExchangeUpdateTask()
- ExchangeUpdateCalendarItem()
- ExchangeUpdateContact()
- ExchangeSearchTasks()
- ExchangeSearchContacts()
- ExchangeSearchCalendarItems()
- ExchangeGetContact()
- ExchangeGetTask()
- ExchangeGetCalendarItem()
- ExchangeGetAllContacts()
- ExchangeGetAllTasks()
- ExchangeGetAllCalendarItems()
- ExchangeFindFolders()
- ExchangeDeleteTask()
- ExchangeDeleteCalendarItem()
Open Conection
This API defines a request to the Exchange Server to open the connection with EWS.
You can open connection to the server by simply calling the function: ExchangeOpenConnection( connection, url, domain, username, password ), where connection is a connection object to communicate with Exchange server,url is the destination with which the connection is to be established, domain is a valid domain name, username and password are the credentials required to connect to the Exchange server.
This API will open connection with the EWS.
Example
<cfscript> variables.username = "shravan.t"; variables.password = "Pass*2010"; ExchangeOpenConnection( connection="myconnection", url="https://subdomain.domain.com/EWS/exchange.asmx", domain = "domain", username = variables.username, password = variables.password ); </cfscript>
Close Conection
This API defines a request to the Exchange Server to close the connection with EWS.
You can close connection with the server by simply calling the function: ExchangeCloseConnection( connection ), where connection is a connection object to communicate with Exchange server.
This API will close connection with the EWS.
Get User Information
This API defines a request to get the information about the User. It includes details such as Display Name, Given name, email Address.
You can get information of the expected User by simply calling the function: ExchangeGetUserInfo( connection, username ), where connection is a connection object to communicate with Exchange server and username is the distinguished name of the user.
This API will return cfData containing Information of the User whose username matches with that given in the input.
Example
<cfscript> GetUserInfo = ExchangeGetUserInfo( connection = "myconnection", username="abcdef" ); WriteDump( GetUserInfo ); </cfscript>
Creating a new task item
This API defines a request to create a new Task item in the Exchange store.
You can create a new Task Item by simply calling the function: ExchangeCreateTask( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing list of all Task field elements.
This API will return cfData containing either both the Id and the changekey of the newly created TaskItem or the Error Message Text.
| possible values | default | required | summary | |
|---|---|---|---|---|
| subject | false | Represents the subject for Exchange store items and response objects | ||
| duedate | false | Represents the date when a task item is due | ||
| startdate | false | Represents the start date of a task item | ||
| reminderdueby | false | Represents the date and time when the event occurs | ||
| reminderisset | false | false | Indicates whether a reminder has been set for an item in the Exchange store | |
| body | false | Represents the actual body content of a message | ||
| bodytype | HTML, Text | HTML | false | Describes how the item body is stored in the item |
| importance | Low, Normal, High | Normal | false | Describes the importance of an item |
| percentcomplete | 0 | false | Describes the completion status of a task | |
| status | Notstarted, InProgress, Completed, WaitingOnOthers, Deferred | Notstarted | false | Represents the status of a task item |
| reminderminutesbeforestart | false | Represents the number of minutes before an event when a reminder is displayed | ||
| inreplyto | false | Represents the identifier of the item to which this item is a reply | ||
| sensitivity | Normal, Personal, Private, Confidential | Normal | false | Contains the status for an item's sensitivity |
| mileage | false | Represents mileage for a task item | ||
| billingInformation | false | Holds billing information for a task | ||
| totalWork | false | Contains a description of how much work is associated with an item | ||
| actualWork | false | Represents the actual amount of time that is spent on a task | ||
| recurrence | Repeat Pattern: Daily, Weekly, Monthly, Yearly regeneration:true, false Month: January, February, March, April, May, June, July, August, September, October, November, December daysofweek: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday DayOfWeekIndex: First, Second, Third, Fourth, Last |
regeneration: false interval:1 |
false | Contains recurrence information for recurring tasks |
| companies | false | Represents the collection of companies that are associated with a contact or task | ||
| Contacts | false | Contains a list of contacts that are associated with a task |
Example
<cfscript>
task = {
subject:"ssscccccccccrecurrenceeeeeeeeeee",
duedate:createdatetime(year=2009, month=12, day=7, hour=13, minute=45, second=00),
startdate:createdatetime(year=2010, month=12, day=6, hour=13, minute=45, second=00),
reminderdueby:createdatetime(year=2010, month=12, day=8, hour=13, minute=45, second=00),
reminderisset:false,
body:"&bdf&",
bodytype:"HTML",
importance:"High",
percentcomplete:76,
status:"InProgress",
reminderminutesbeforestart:54,
inreplyto:"cool",
sensitivity:"Private",
mileage:"a&b",
billingInformation:"a&b",
totalWork:8,
actualWork:12,
recurrence:{
repeatpattern:"YeArly",
DayOfMonth:12,
Month:"January",
startdate:Createdate(year=2010, month=12, day=17),
numberofoccurrences:3
},
companies:["companyco&", "company2&"],
Contacts:["contact&1"]
};
val = ExchangeCreateTask( connection = "myconnection", inputData = task );
WriteDump( val );
</cfscript>
Creating a new calendar item
This API defines a request to create a new Calendar item in the Exchange store.
You can create a new Calendar Item by simply calling the function: ExchangeCreateCalendarItem( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing list of all calendar field elements.
This API will return cfData containing either both the Id and the changekey of the newly created CalendarItem or the Error Message Text.
| possible values | default | required | summary | |
|---|---|---|---|---|
| subject | false | Represents the subject for Exchange store items and response objects | ||
| sensitivity | Normal, Personal, Private, Confidential | Normal | false | Contains the status for an item's sensitivity |
| reminderdueby | false | Represents the date and time when the event occurs | ||
| body | false | Represents the actual body content of a message | ||
| bodytype | HTML, Text | HTML | false | Describes how the item body is stored in the item |
| importance | Low, Normal, High | Normal | false | Describes the importance of an item |
| reminderisset | true | false | Indicates whether a reminder has been set for an item in the Exchange store | |
| reminderminutesbeforestart | false | Represents the number of minutes before an event when a reminder is displayed | ||
| location | false | Represents the location of a meeting or appointment | ||
| isalldayevent | false | false | Indicates whether a calendar item or meeting request represents an all-day event | |
| start | false | Represents the start of a calendar item | ||
| end | false | Represents the end of a duration | ||
| inreplyto | false | Represents the identifier of the item to which this item is a reply | ||
| when | false | Provides information about when a calendar item occurs | ||
| netShowurl | false | Specifies the URL for a Microsoft NetShow online meeting | ||
| meetingworkspaceurl | false | Contains the URL for the meeting workspace that is linked to by the calendar item | ||
| allowNewtimeProposal | false | Indicates whether a new meeting time can be proposed for a meeting by an attendee | ||
| conferencetype | NetMeeting, NetShow, Chat | false | Describes the type of conferencing that is performed with a calendar item | |
| freebusystatus | Free, Tentative, Busy, OOF, NoData | Busy | false | Represents the free/busy status of the calendar item |
| requiredattendees | false | Represents attendees that are required to attend a meeting | ||
| optionalattendees | false | Represents attendees that are not required to attend a meeting | ||
| resources | false | Represents a scheduled resource for a meeting | ||
| recurrence | Repeat Pattern: Daily, Weekly, Monthly, Yearly Month: January, February, March, April, May, June, July, August, September, October, November, December daysofweek: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday DayOfWeekIndex: First, Second, Third, Fourth, Last |
interval:1 |
false | Contains recurrence information for recurring tasks |
| starttimezoneid | false | Represents the start time zone of the calendar item | ||
| endtimezoneid | false | Represents the end time zone of the calendar item |
Example
<cfscript>
params = {
subject:"final CI",
sensitivity:"Private",
reminderdueby:Createdatetime(year=2010, month=12, day=15, hour=01, minute=00, second=00),
bodytype:"Text",
body:"This is html body....",
importance:"High",
reminderisset:true,
reminderminutesbeforestart: 15 ,
location:"&&&&&",
isalldayevent:false,
start:Createdatetime(year=2011, month=12, day=16, hour=06, minute=00, second=00),
end:Createdatetime(year=2012, month=12, day=27, hour=06, minute=30, second=00),
inreplyto:"cool",
when:"vdfve&&bfg",
netShowurl:"ddd&&&&ddddd",
meetingworkspaceurl:"xxxxxxxxxx",
allowNewtimeProposal:true,
conferencetype:"NetMeeting",
freebusystatus:"Busy",
requiredattendees:[{name:"a&g",email:"a@c.com"},{name:"b",email:"b@c.com"}],
optionalattendees:[{name:"c",email:"c@c.com"},{name:"d",email:"d@c.com"}],
resources:[{name:"e",email:"e@c.com"},{name:"f",email:"f@c.com"}],
recurrence:{
repeatpattern:"YeArly",
DayOfMonth:12,
Month:"January",
startdate:Createdate(year=2010, month=12, day=17),
numberofoccurrences:3
},
starttimezoneid:"Central Asia Standard time",
endtimezoneid:"Central Asia Standard time"
};
val = ExchangeCreateCalendarItem( connection = "myconnection", inputData = params );
WriteDump( val );
</cfscript>
Updating a task item
This API defines a request to update a Task Item in a mailbox.
You can update a Task Item by simply calling the function: ExchangeUpdateTask( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing id and list of fields to be updated in a Task.
This API will return cfData containing either both the Id and the changekey of the updated TaskItem or the Error Message Text.
| possible values | default | required | summary | |
|---|---|---|---|---|
| id | true | Represents the Unique Identifier of a task | ||
| changekey | false | Represents the Change Key of a task | ||
| subject | false | Represents the subject for Exchange store items and response objects | ||
| duedate | false | Represents the date when a task item is due | ||
| startdate | false | Represents the start date of a task item | ||
| reminderdueby | false | Represents the date and time when the event occurs | ||
| reminderisset | false | Indicates whether a reminder has been set for an item in the Exchange store | ||
| body | false | Represents the actual body content of a message | ||
| bodytype | HTML, Text | HTML | false | Describes how the item body is stored in the item |
| importance | Low, Normal, High | false | Describes the importance of an item | |
| percentcomplete | false | Describes the completion status of a task | ||
| status | Notstarted, InProgress, Completed, WaitingOnOthers, Deferred | false | Represents the status of a task item | |
| reminderminutesbeforestart | false | Represents the number of minutes before an event when a reminder is displayed | ||
| inreplyto | false | Represents the identifier of the item to which this item is a reply | ||
| sensitivity | Normal, Personal, Private, Confidential | false | Contains the status for an item's sensitivity | |
| mileage | false | Represents mileage for a task item | ||
| billingInformation | false | Holds billing information for a task | ||
| totalWork | false | Contains a description of how much work is associated with an item | ||
| actualWork | false | Represents the actual amount of time that is spent on a task | ||
| recurrence | Repeat Pattern: Daily, Weekly, Monthly, Yearly regeneration:true, false Month: January, February, March, April, May, June, July, August, September, October, November, December daysofweek: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday DayOfWeekIndex: First, Second, Third, Fourth, Last |
regeneration: false interval:1 |
false | Contains recurrence information for recurring tasks |
| companies | false | Represents the collection of companies that are associated with a contact or task | ||
| Contacts | false | Contains a list of contacts that are associated with a task |
Example
<cfscript>
task = {
id:"snhTOxS5DZI3hjoguSAAAA/43fAADoD/snhTOxS5DZI3hjoguSAAAGKfkOAAA=",
changekey:"EwAAABYAAADUfdVn0tiqSreXBHySP2UcAAAAadTF",
subject:"bvbvbvbvbvbvb",
duedate:Createdatetime(year=2010, month=12, day=7, hour=01, minute=00, second=00),
startdate:Createdatetime(year=2009, month=12, day=6, hour=13, minute=45, second=00),
Completedate:Createdatetime(year=2010, month=12, day=6, hour=13, minute=45, second=00),
reminderdueby:Createdatetime(year=2010, month=12, day=8, hour=13, minute=45, second=00),
reminderisset:false,
body:"This is body element",
bodytype:"HTML",
importance:"High",
percentcomplete:16.6,
status:"InProgress",
mileage:"Veryhigh",
Contacts:["first", "second"],
companies:["first", "second"],
totalWork:10,
actualWork:76,
billingInformation:"Billing&Information",
sensitivity:"Private",
InReplyTo:"this is string",
recurrence:{
repeatpattern:"YeArly",
DayOfMonth:12,
Month:"January",
startdate:Createdate(year=2010, month=12, day=17),
numberofoccurrences:3
},
reminderminutesbeforestart:100
};
val = ExchangeUpdateTask( connection = "myconnection", inputData = task );
WriteDump( val );
</cfscript>
Updating a calendar item
This API defines a request to update a Calendar Item in a mailbox.
You can update a Calendar Item by simply calling the function: ExchangeUpdateCalendarItem( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing id and list of fields to be updated in a Calendar.
This API will return cfData containing either both the Id and the changekey of the updated CalendarItem or the Error Message Text.
| possible values | default | required | summary | |
|---|---|---|---|---|
| id | true | Represents the Unique Identifier of a calendaritem | ||
| changekey | false | Represents the ChangeKey of a calendaritem | ||
| subject | false | Represents the subject for Exchange store items and response objects | ||
| sensitivity | Normal, Personal, Private, Confidential | false | Contains the status for an item's sensitivity | |
| reminderdueby | false | Represents the date and time when the event occurs | ||
| body | false | Represents the actual body content of a message | ||
| bodytype | HTML, Text | HTML | false | Describes how the item body is stored in the item |
| importance | Low, Normal, High | false | Describes the importance of an item | |
| reminderisset | false | Indicates whether a reminder has been set for an item in the Exchange store | ||
| reminderminutesbeforestart | false | Represents the number of minutes before an event when a reminder is displayed | ||
| location | false | Represents the location of a meeting or appointment | ||
| isalldayevent | false | Indicates whether a calendar item or meeting request represents an all-day event | ||
| start | false | Represents the start of a calendar item | ||
| end | false | Represents the end of a duration | ||
| inreplyto | false | Represents the identifier of the item to which this item is a reply | ||
| when | false | Provides information about when a calendar item occurs | ||
| netShowurl | false | Specifies the URL for a Microsoft NetShow online meeting | ||
| meetingworkspaceurl | false | Contains the URL for the meeting workspace that is linked to by the calendar item | ||
| allowNewtimeProposal | false | Indicates whether a new meeting time can be proposed for a meeting by an attendee | ||
| conferencetype | NetMeeting, NetShow, Chat | false | Describes the type of conferencing that is performed with a calendar item | |
| freebusystatus | Free, Tentative, Busy, OOF, NoData | false | Represents the free/busy status of the calendar item | |
| requiredattendees | false | Represents attendees that are required to attend a meeting | ||
| optionalattendees | false | Represents attendees that are not required to attend a meeting | ||
| resources | false | Represents a scheduled resource for a meeting | ||
| recurrence | Repeat Pattern: Daily, Weekly, Monthly, Yearly Month: January, February, March, April, May, June, July, August, September, October, November, December daysofweek: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday DayOfWeekIndex: First, Second, Third, Fourth, Last |
interval:1 |
false | Contains recurrence information for recurring calendar items |
| starttimezoneid | false | Represents the start time zone of the calendar item | ||
| endtimezoneid | false | Represents the end time zone of the calendar item |
Example
<cfscript>
params = {
id:"snhTOxS5DZI3hjoguSAAAA/43aAADoD/snhTOxS5DZI3hjoguSAAAGKhknAAA=",
changekey:"DwAAABYAAADUfdVn0tiqSreXBHySP2UcAAAAadUA",
subject:"0987654321",
sensitivity:"Private",
reminderdueby:Createdatetime(year=2010, month=12, day=15, hour=01, minute=00, second=00),
bodytype:"Text",
body:"This is html body....",
importance:"High",
reminderisset:true,
reminderminutesbeforestart: 6,
location:"&NHG&NFH&",
isalldayevent:false,
start:createdatetime(year=2011, month=12, day=16, hour=06, minute=00, second=00),
end:createdatetime(year=2012, month=12, day=27, hour=06, minute=30, second=00),
inreplyto:"cool",
when:"&1&2&3",
netShowurl:"ddd&nghf",
meetingworkspaceurl:"&bgf&",
allowNewtimeProposal:true,
conferencetype:"NetMeeting",
freebusystatus:"Busy",
requiredattendees:[{name:"ah",email:"a.b@c.com"},{name:"b",email:"b.b@c.com"}],
optionalattendees:[{name:"ch",email:"c.b@c.com"},{name:"d",email:"d.bh@c.com"}],
resources:[{name:"e",email:"e.b7@c.com"},{name:"f",email:"f.b@c.com"}],
recurrence:{
repeatpattern:"YeArly",
DayOfMonth:12,
Month:"January",
startdate:createdate(year=2010, month=12, day=17),
numberofoccurrences:3
},
starttimezoneid:"Central Asia Standard time",
endtimezoneid:"Central Asia Standard time"
};
val = ExchangeUpdateCalendarItem( connection = "myconnection", inputData = params );
WriteDump( val );
</cfscript>
Updating a contact item
This API defines a request to update a Contact Item in a mailbox.
You can update a Contact Item by simply calling the function: ExchangeUpdateContact( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing id and list of fields to be updated in a Contact.
This API will return cfData containing either both the Id and the changekey of the updated ContactItem or the Error Message Text.
| possible values | default | required | summary | |
|---|---|---|---|---|
| id | true | Represents the Unique Identifier of a contact | ||
| changekey | false | Represents the ChangeKey of a contact | ||
| jobtitle | false | Represents the job title of a contact | ||
| assistantname | false | Represents an assistant to a contact | ||
| businesshomepage | false | Represents the home page (Web address) for the contact | ||
| businessphone1 | false | Represents the businessphone1 Number of the contact | ||
| businessphone2 | false | Represents the businessphone2 Number of the contact | ||
| company | false | Represents the company name that is associated with a contact | ||
| displayname | false | Defines the display name of a contact | ||
| givenname | false | Contains a contact's given name | ||
| surname | false | Represents the surname of a contact | ||
| middlename | false | Represents the middle name of a contact | ||
| mobilephone | false | Represents the mobilephone Number of the contact | ||
| businessfax | false | Represents the businessfax Number of the contact | ||
| homephone1 | false | Represents the homephone1 Number of the contact | ||
| homephone2 | false | Represents the homephone2 Number of the contact | ||
| homephonefax | false | Represents the homephonefax Number of the contact | ||
| assistantphone | false | Represents the assistantphone Number of the contact | ||
| false | Represents the contact's email Address | |||
| email2 | false | Represents the contact's email Address | ||
| email3 | false | Represents the contact's email Address | ||
| emaildisplayname1 | false | Represents the contact's email Address Display Name | ||
| emaildisplayname2 | false | Represents the contact's email Address Display Name | ||
| emaildisplayname3 | false | Represents the contact's email Address Display Name | ||
| department | false | Represents the contact's department at work | ||
| businessstreet | false | Represents a business street address for a contact item | ||
| businesscity | false | Represents the business city name that is associated with a contact | ||
| businessstate | false | Represents the business state of residence for a contact item | ||
| businesscountry | false | Represents the business country or region for a given physical address | ||
| businesspostalcode | false | Represents the business postal code for a contact item | ||
| homestreet | false | Represents a home street address for a contact item | ||
| homecity | false | Represents the home city name that is associated with a contact | ||
| homestate | false | Represents the home state of residence for a contact item | ||
| homecountry | false | Represents the home country or region for a given physical address | ||
| homePostalCode | false | Represents the home postal code for a contact item | ||
| otherStreet | false | Represents a street address for a contact item | ||
| otherCity | false | Represents the city name that is associated with a contact | ||
| otherState | false | Represents the state of residence for a contact item | ||
| otherCountry | false | Represents the country or region for a given physical address | ||
| otherPostalCode | false | Represents the other postal code for a contact item | ||
| callback | false | Represents the Callback Number of the contact | ||
| carphone | false | Represents the Carphone Number of the contact | ||
| othertelephone | false | Represents the othertelephone Number of the contact | ||
| pager | false | Represents the pager of the contact | ||
| companymainphone | false | Represents the CompanyMainphone of the contact | ||
| isdn | false | Represents the isdn of the contact | ||
| radiophone | false | Represents the radiophone Number of the contact | ||
| telex | false | Represents the Telex of the contact | ||
| ttytddphone | false | Represents the TtyTddphone Number of the contact | ||
| imaddress | false | Represents an instant messaging address for a contact | ||
| imaddress2 | false | Represents an instant messaging address for a contact | ||
| imaddress3 | false | Represents an instant messaging address for a contact | ||
| manager | false | Represents a contact's manager | ||
| officelocation | false | Represents the Office location | ||
| notes | false | Represents the Notes of the contact |
Example
<cfscript>
contact = {
id:"snhTOxS5DZI3hjoguSAAAA/43bAADoD/snhTOxS5DZI3hjoguSAAAGKl5+AAA=",
changekey:"cvvEQAAABYAAADoD/snhTOxS5DZI3hjoguSAAABAD+l",
jobtitle:"HR Manager",
assistantname:"Assis&&&&tant",
businesshomepage:"homepagebt56n676i87",
businessphone1:"745854",
businessphone2:"8568956",
company:"SNStech",
displayname:"aabbcc",
givenname:"HTML",
surname:"xyz",
middlename:"KUMAR",
mobilephone:"bnfb",
businessfax:"12345",
homephone1:"12345",
homephone2:"1234jh&&yjh",
homephonefax:"12345",
assistantphone:"12345",
email:"Billing@Inf&ormation",
email2:"Priv@ate",
email3:"this@isstring",
emaildisplayname1:"hello",
emaildisplayname2:"hello",
emaildisplayname3:"hello",
department:"abc",
businessstreet:"abc",
businesscity:"abc",
businessstate:"abc",
businesscountry:"abc",
businesspostalcode:"94306",
homestreet:"abc",
homecity:"abc",
homestate:"abc",
homecountry:"abc",
homepostalcode:"abc",
otherStreet:"abc",
otherCity:"abc",
otherState:"abc",
otherCountry:"abc",
otherPostalCode:"abc",
callback:"abc",
carphone:"abc",
othertelephone:"abc",
pager:"abc",
primaryphone:"abc",
companymainphone:"abc",
isdn:"abc",
radiophone:"abc",
telex:"abc",
ttytddphone:"abc",
imaddress:"uuymuymm79,u5756",
imaddress2:"abc",
imaddress3:"abc",
manager:"abc",
officelocation:"abc",
notes:"abc"
};
val = ExchangeUpdateContact( connection = "myconnection", inputData = contact);
WriteDump( val );
</cfscript>
Search Task Items
This API defines a request to find a Task Items in a mailbox.
You can search a Task Item by simply calling the function: ExchangeSearchTasks( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing fields of Task to be searched on.
This API will return cfData containing Information about the instances of TaskItem satisfying the search conditions.
| possible values | default | required | summary | |
|---|---|---|---|---|
| operator | And, Or | OR | false | Decides whether the individual results should be ANDed or ORed |
| keywords | false | Represents the keyword to be searched on | ||
| duedate | false | Represents the date when a task item is due | ||
| beginstartdate | false | Represents the beginning start date of the Task Item to be searched on | ||
| endstartdate | false | Represents the end start date of the Task Item to be searched on | ||
| statusNotequals | Notstarted, InProgress, Completed, WaitingOnOthers, Deferred | false | Represents the status of the Task on which the search should be performed | |
| importance | Low, Normal, High | false | Describes the importance of an item | |
| sensitivity | Normal, Personal, Private, Confidential | false | Contains the status for an item's sensitivity |
Example
<cfscript>
search = {
operator:"Or"
keywords:"AA",
duedate:createdatetime(year=2010, month=12, day=6, hour=00, minute=00, second=00),
beginstartdate:createdatetime(year=2010, month=12, day=10, hour=00, minute=00, second=00),
endstartdate:createdatetime(year=2010, month=12, day=20, hour=00, minute=00, second=00),
statusNotequals:"Notstarted",
importance:"High",
sensitivity:"Private"
};
val = ExchangeSearchTasks( connection = "myconnection", inputData = search);
WriteDump( val );
</cfscript>
Search contact Items
This API defines a request to find a Contact Items in a mailbox.
You can search a Contact Item by simply calling the function: ExchangeSearchContacts( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing fields of Contacts to be searched on.
This API will return cfData containing Information about the instances of ContactItem satisfying the search conditions.
| possible values | default | required | summary | |
|---|---|---|---|---|
| searchkeyword | false | Represents the keyword to be searched on | ||
| field | Either givenname, surname, subject, company, homestreet, homecity, homestate, homepostalcode, homecountry, businessstreet, businesscity, businessstate, businesspostalcode, businesscountry, fileas, emailaddress Or All |
Subject | false | Represents the fields on which the search is to be performed |
| searchmode | FullString, Prefixed, Substring, PrefixOnWords, ExactPhrase | Substring | false | Represents the searchmode for the search operation |
| limit | 100 | false | Represents the number of contacts that should be displayed in output | |
| offset | 0 | false | Represents the offset for the search operation | |
| operator | And, Or | OR | false | Decides whether the individual results should be ANDed or ORed |
| basepoint | beginning, end | beginning | false | Represents whether the search should start from the beginning or from the end |
| sensitivity | Normal, Personal, Private, Confidential | false | Contains the status for an item's sensitivity | |
| importance | Low, Normal, High | false | Describes the importance of an item. | |
| additionalfolders | false | Represent the additional folders on which the search operation is to be carried on |
Example
<cfscript>
params = {
searchkeyword:"x",
field : "surname",
searchmode:"Substring",
limit:1,
offset:0,
operator:"and",
basepoint:"eNd",
sensitivity:"Normal",
importance:"nOrmal",
additionalfolders:["04MTFkLTk4NzljNzM5NDA1MQAuAAAAAAAHnh9u4S9oTLKIZo9P9ejQAQDoD/snhTOxS5DZI3hjoguSAAAGKr7mAAA="]
};
folders= ExchangeSearchContacts( connection = "myconnection", inputData = params );
WriteDump( folders );
</cfscript>
Search Calendar Items
This API defines a request to find a Calendar Items in a mailbox.
You can search a Calendar Item by simply calling the function: ExchangeSearchCalendarItems( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing fields of Calendar to be searched on.
This API will return cfData containing Information about the instances of CalendarItem satisfying the search conditions.
| possible values | default | required | summary | |
|---|---|---|---|---|
| keywords | false | Represents the keyword to be searched on | ||
| freebusystatus | Free, Tentative, Busy, OOF, NoData | false | Represents the free/busy status of the calendar item | |
| operator | And, Or | OR | false | Decides whether the individual results should be ANDed or ORed |
| importance | Low, Normal, High | false | Describes the importance of an item | |
| sensitivity | Normal, Personal, Private, Confidential | false | Contains the status for an item's sensitivity | |
| start | false | Represents the start date of a calendar item | ||
| end | false | Represents the end date of a calendar item | ||
| spanstartdate | false | Represents the beginning start date of the Calendar Item to be searched on | ||
| spanenddate | false | Represents the end start date of the Calendar Item to be searched on |
Example
<cfscript>
search = {
keywords:"recurrence",
freebusystatus:"Tentative",
operator:"And",
importance:"High",
sensitivity:"Private",
start:createdatetime(year=2010, month=12, day=6, hour=00, minute=00, second=00),
end:createdatetime(year=2010, month=12, day=6, hour=00, minute=00, second=00),
spanstartdate:createdatetime(year=2009, month=12, day=6, hour=00, minute=00, second=00),
spanenddate:createdatetime(year=2011, month=12, day=6, hour=00, minute=00, second=00)
};
val=ExchangeSearchCalendarItems( connection = "myconnection", inputData = search );
WriteDump( val );
</cfscript>
Get Contact Information
This API defines a request to get the information of a Contact Item in a mailbox.
You can get information of a Contact Item by simply calling the function: ExchangeGetContact( connection, id ), where connection is a connection object to communicate with Exchange server and id is the unique identifier of a contact instance.
This API will return cfData containing Information about the ContactItem whose Id matches with that given in the input.
Example
<cfscript> GetContact = ExchangeGetContact( connection = "myconnection", id = "43bAADoD/snhTOxS5DZI3hjoguSAAAGKl6AAAA=" ); WriteDump( GetContact ); </cfscript>
Get Task Information
This API defines a request to get the information of a Task Item in a mailbox.
You can get information of a Task Item by simply calling the function: ExchangeGetTask( connection, id ), where connection is a connection object to communicate with Exchange server and id is the unique identifier of a task instance.
This API will return cfData containing Information about the TaskItem whose Id matches with that given in the input.
Example
<cfscript> GetTask = ExchangeGetTask( connection = "myconnection", id = "snhTOxS5DZI3hjoguSAAAA/43fAADoD/snhTOxS5DZI3hjoguSAAAGKfkSAAA=" ); WriteDump( GetTask ); </cfscript>
Get CalendarItem Information
This API defines a request to get the information of a Calendar Item in a mailbox.
You can get information of a Calendar Item by simply calling the function: ExchangeGetCalendarItem( connection, id ), where connection is a connection object to communicate with Exchange server and id is the unique identifier of a calendar item.
This API will return cfData containing Information about the CalendarItem whose Id matches with that given in the input.
Example
<cfscript> GetCalendarItem = ExchangeGetCalendarItem( connection = "myconnection", id = "43aAADoD/snhTOxS5DZI3hjoguSAAAGKhkmAAA=" ); WriteDump( GetCalendarItem ); </cfscript>
Get All Contacts
This API defines a request to get the information of all Contact Items in a mailbox.
You can get information of all the Contact Items by simply calling the function: ExchangeGetAllContacts( connection ), where connection is a connection object to communicate with Exchange server.
This API will return cfData containing Information of all Contact Items in a mailbox.
Example
<cfscript> GetAllContacts = ExchangeGetAllContacts( connection = "myconnection" ); WriteDump( GetAllContacts ); </cfscript>
Get All Tasks
This API defines a request to get the information of all Task Items in a mailbox.
You can get information of all the Task Items by simply calling the function: ExchangeGetAllTasks( connection ), where connection is a connection object to communicate with Exchange server.
This API will return cfData containing Information of all Task Items in a mailbox.
Example
<cfscript> GetAllTasks = ExchangeGetAllTasks( connection = "myconnection" ); WriteDump( GetAllTasks ); </cfscript>
Get All CalendarItems
This API defines a request to get the information of all Calendar Items in a mailbox.
You can get information of all the Calendar Items by simply calling the function: ExchangeGetAllCalendarItems( connection ), where connection is a connection object to communicate with Exchange server.
This API will return cfData containing Information of all Calendar Items in a mailbox.
Example
<cfscript> GetAllCalendarItems = ExchangeGetAllCalendarItems( connection = "myconnection" ); WriteDump( GetAllCalendarItems ); </cfscript>
Finding Folders
This API defines a request to find folders in a mailbox.
You can use API by simply calling the function: ExchangeFindFolders( connection, parentfolder ), where connection is a connection object to communicate with Exchange server and parentfolder is string containing one of these values calendar, contacts, deleteditems, drafts, inbox, journal, notes, outbox, sentitems, tasks, msgfolderroot, root, junkemail, searchfolders, voicemail.
This API will return cfData containing an Array of folder Ids.
Example
<cfscript> val = ExchangeFindFolders( connection = "myconnection", parentfolder = "msgfolderroot" ); WriteDump( val ); </cfscript>
Delete Task Items
This API defines a request to delete a Task items from a mailbox in the Exchange store.
You can delete a Task Item by simply calling the function: ExchangeDeleteTask( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing id and AffectedTaskOccurrences value.
This API will return TRUE( cfBooleanData) in case the deletion is successful else the Error Message Text( cfData).
Example
<cfscript>
params= {
Id:"snhTOxS5DZI3hjoguSAAAA/43fAADoD/snhTOxS5DZI3hjoguSAAAGKfkQAAA=",
AffectedTaskOccurrences:"SpecifiedOccurrenceOnly"
};
val = ExchangeDeleteTask( connection = "myconnection", inputData = params );
WriteDump( val );
</cfscript>
Delete Calendar Items
This API defines a request to delete a Calendar items from a mailbox in the Exchange store.
You can delete a Calendar Item by simply calling the function: ExchangeDeleteCalendarItem( connection, inputData ), where connection is a connection object to communicate with Exchange server and inputData is structure containing Different Id's and SendMeetingCancellations value.
This API will return TRUE( cfBooleanData) in case the deletion is successful else the Error Message Text( cfData).
Example
<cfscript>
params= {
Id:"snhTOxS5DZI3hjoguSAAAA/43fAADoD/snhTOxS5DZI3hjoguSAAAGKfkQAAA=",
SendMeetingCancellations:"SendToNone"
};
val = ExchangeDeleteCalendarItem( connection = "myconnection", inputData = params );
WriteDump( val );
</cfscript>