cfexchangefolder

Last updated on Feb 25, 2025 | Also applies to ColdFusion

ColdFusion

Open app

CFML Reference User Guide

ColdFusion functions

ColdFusion functions by category
Functions a-b
1. Abs
2. ACos
3. AddSOAPRequestHeader
4. AddSOAPResponseHeader
5. AjaxLink
6. AjaxOnLoad
7. ApplicationStop
8. ArrayAppend
9. ArrayAvg
10. ArrayClear
11. ArrayContains
12. ArrayContainsNoCase
13. ArrayDelete
14. ArrayDeleteAt
15. ArrayDeleteNoCase
16. ArrayEach
17. ArrayFilter
18. ArrayFind
19. ArrayFindAll
20. ArrayFindAllNoCase
21. ArrayFindNoCase
22. ArrayInsertAt
23. ArrayIsDefined
24. ArrayIsEmpty
25. ArrayLen
26. ArrayMap
27. ArrayMax
28. ArrayMin
29. ArrayNew
30. ArrayPrepend
31. ArrayReduce
32. ArrayResize
33. ArraySet
34. ArraySetMetadata
35. ArraySlice
36. ArraySort
37. ArraySum
38. ArraySwap
39. ArrayToList
40. Asc
41. ASin
42. Atn
43. AuthenticatedContext
44. AuthenticatedUser
45. BinaryDecode
46. BinaryEncode
47. BitAnd
48. BitMaskClear
49. BitMaskRead
50. BitMaskSet
51. BitNot
52. BitOr
53. BitSHLN
54. BitSHRN
55. BitXor
56. BooleanFormat
Functions-c-d
Functions-e-g
Functions-h-im
Functions-in-k
Functions-l
Functions-m-r
Functions-s
Functions-t-z
1. Tan
2. ThreadJoin
3. ThreadTerminate
4. Throw
5. TimeFormat
6. ToBase64
7. ToBinary
8. ToScript
9. ToString
10. Trace
11. Transactionandconcurrency
12. TransactionCommit
13. TransactionRollback
14. TransactionSetSavePoint
15. Trim
16. UCase
17. URLDecode
18. URLEncodedFormat
19. URLSessionFormat
20. Val
21. ValueList
22. VerifyClient
23. Week
24. Wrap
25. WriteDump
26. WriteLog
27. WriteOutput
28. WSGetAllChannels
29. WSGetSubscribers
30. WSPublish
31. WSSendMessage
32. XmlChildPos
33. XmlElemNew
34. XmlFormat
35. XmlGetNodeType
36. XmlNew
37. XmlParse
38. XmlSearch
39. XmlTransform
40. XmlValidate
41. Year
42. YesNoFormat

ColdFusion tags

ColdFusion tag summary
ColdFusion tags by category
1. Application framework tags
  1. cfapplication
  2. cfassociate
  3. cferror
  4. cfimport
  5. cfinterface
  6. cflock
  7. cfscript
  8. cfthread
2. Communications tags
3. Database manipulation tags
4. Data output tags
  1. cfchart
5. Debugging tags
  1. cfdump
  2. cftimer
  3. cftrace
6. Exception handling tags
  1. cfcatch
  2. cferror
  3. cffinally
  4. cfrethrow
  5. cfthrow
  6. cftry
7. Extensibility tags
  1. cfchart
  2. cfchartdata
  3. cfchartseries
  4. cfcollection
  5. cfcomponent
  6. cfexecute
  7. cfftp
  8. function
  9. cfindex
  10. cfinterface
  11. cfinvoke
  12. cfinvokeargument
  13. cfobject
  14. cfproperty
  15. cfreport
  16. cfreportparam
  17. cfreturn
  18. cfsearch
  19. cfsharepoint
  20. cfspreadsheet
  21. cfwddx
  22. cfxml
8. File management tags
  1. cfdirectory
  2. cffile
  3. cffileupload
  4. cfftp
  5. cfzip
  6. cfzipparam
9. Flow-control tags
  1. cfabort
  2. cfbreak
  3. cfcase
  4. cfcontinue
  5. cfdefaultcase
  6. cfelse
  7. cfelseif
  8. cfexecute
  9. cfexit
  10. cfif
  11. cfinclude
  12. cflocation
  13. cfloop
  14. cfrethrow
  15. cfswitch
  16. cfthrow
  17. cftry
10. Forms tags
  1. cfapplet
  2. cfcalendar
  3. cffileupload
  4. cfform
  5. cfformgroup
  6. cfformitem
  7. cfgrid
  8. cfgridcolumn
  9. cfgridrow
  10. cfgridupdate
  11. cfinput
  12. cfpdf
  13. cfpdfform
  14. cfpdfformparam
  15. cfpdfparam
  16. cfpdfsubform
  17. cfselect
  18. cfslider
  19. cftextarea
  20. cftree
  21. cftreeitem
11. Internet Protocol tags
  1. cfajaximport
  2. cfajaxproxy
  3. cfftp
  4. cffeed
  5. cfimap
  6. cfhttp
  7. cfhttpparam
  8. cfldap
  9. cfmail
  10. cfmailparam
  11. cfmailpart
  12. cfpop
  13. cfsprydataset
12. Page processing tags
  1. cfcache
  2. cfcontent
  3. cfflush
  4. cfheader
  5. cfhtmlhead
  6. cfinclude
  7. cfprocessingdirective
  8. cfsetting
  9. cfsilent
13. Security tags
14. Variable manipulation tags
  1. cfcookie
  2. cfdump
  3. cfparam
  4. cfregistry
  5. cfsavecontent
  6. cfschedule
  7. cfset
  8. cfsetting
15. Other tags
  1. cfimage
  2. cflog
  3. cfregistry
Tags a-b
Tags c
Tags f
Tags g-h
1. cfgraph
2. cfgraphdata
3. cfgrid
4. cfgridcolumn
5. cfgridrow
6. cfgridupdate
7. cfheader
8. cfhtmlhead
9. cfhtmltopdf
10. cfhtmltopdfitem
11. cfhttp
12. cfhttpparam
Tags i
1. cfif
2. cfimage
3. cfimap
4. cfimapfilter
5. cfimpersonate
6. cfimport
7. cfinclude
8. cfindex
9. cfinput
10. cfinsert
11. cfinterface
12. cfinvoke
13. cfinvokeargument
Tags j-l
Tags m-o
Tags p-q
1. cfparam
2. cfpdf
3. cfpdfform
4. cfpdfformparam
5. cfpdfparam
6. cfpdfsubform
7. cfpod
8. cfpop
9. cfpresentation
10. cfpresentationslide
11. cfpresenter
12. cfprint
13. cfprocessingdirective
14. cfprocparam
15. cfprocresult
16. cfprogressbar
17. cfproperty
18. cfquery
19. cfqueryparam
Tags r-s
1. cfregistry
2. cfreport
3. cfreportparam
4. cfrethrow
5. cfreturn
6. cfsavecontent
7. cfschedule
8. cfscript
9. cfsearch
10. cfselect
11. cfservlet
12. cfservletparam
13. cfset
14. cfsetting
15. cfsharepoint
16. cfsilent
17. cfslider
18. cfspreadsheet
19. cfsprydataset
20. cfstoredproc
21. cfswitch
Tags t
1. cftable
2. cftextarea
3. cftextinput
4. cfthread
5. cfthrow
6. cftimer
7. cftooltip
8. cftrace
9. cftransaction
10. cftree
11. cftreeitem
12. cftry
Tags u-z
1. cfupdate
2. cfwddx
3. cfwebsocket
4. cfwindow
5. cfxml
6. cfzip
7. cfzipparam

CFML Reference

Cloud services

CFML Reference User Guide
ColdFusion functions
ColdFusion tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

Description

Lets you perform various actions on the mail folder, such as get folder information, find folders, or create, copy, modify, move, delete, and empty the contents of a folder.

History

ColdFusion (2025 release):
- Changes:
  - FolderClass is not supported in Exchange Online; it defaults to mailFolder.
  - Hard deletion is not possible via Microsoft Graph API (soft-deleted items are automatically hard-deleted after 30 days).
  - An empty operation is not supported online but can be done by deleting specific resources.
  - getExtendedInfo will not include folder permission details.
- Deviation:
  - FolderClass was previously used to describe folder types, but currently in ColdFusion for Exchange Online, it defaults to the mail folder.
ColdFusion 10: Added this tag.

Syntax

getExtendedInfo
<cfexchangefolder
action = "getExtendedInfo"
folderID = "Exchange folder UID"
connection = "connection_ID"
name = "query_name"/>
OR

getExtendedInfo
<cfexchangefolder
action = "getExtendedInfo"
folderPath = "Exchange_folder_Path"
connection = "connection_ID"
name = "query_name"
pathDelimitter = "delimiter_characters"/>
getlnfo
<cfexchangefolder
action = "getInfo"
connection = "connection_ID"
folderID = "Exchange folder UID"
name = "query_name"/>
OR
getlnfo
<cfexchangefolder
action = "getInfo"
folderPath = "Exchange_folder_Name"
connection = "connection_ID"
name = "query_name"
pathDelimitter = "delimiter_characters"/>
findSubFolders
<cfexchangefolder
action = "findSubFolders"
folderID = "Exchange folder UID"
connection = "connection_ID"
name = "query_name"/>
create
<cfexchangefolder
action = "create"
folder = "struct"
parentFolderID = "folder_UID"
connection = "connection_ID"
result = "variable for contact UID"/>
copy
<cfexchangefolder
action = "copy"
destinationFolderID = "Folder_UID"
sourceFolderID = "folder_UID">
connection = "connection_ID"
result = "variable for contact UID"/>
delete
<cfexchangefolder
action = "delete"
deleteType = "hardDelete|softDelete|moveToDeletedItems"
uid = "folder UID">
connection = "connection_ID"/>
move
<cfexchangefolder
action = "move"
destinationFolderID = "Folder_UID"
sourceFolderID = "folder_UID">
connection = "connection_ID"
result = "variable for contact UID"/>
modify
<cfexchangefolder
action = "modify"
uid = "folder UID"
folder = "strut"
connection = "connection_ID"/>
empty
<cfexchangefolder
action = "empty"
uid = "folder UID"
deleteType = "hardDelete|softDelete|moveToDeletedItems">
deleteSubFolder = "true|false"
connection = "connection_ID"/>

Attributes

Attribute	Action	Req/Opt	Default	Description
action	N/A	Required		The action to take. Must be one of the following values: getInfo getExtendedInfo findSubFolders create copy delete move modify empty
uid	getExtendedInfo / getInfo	Not required for getExtendedInfo and getInfo, if folder path is specified.		UID that is used to identify the folder in which the actions are performed.
name	getExtendedInfo / getInfo / findSubFolders	Required		The name of the ColdFusion query variable that contains the returned information about the folder.
folderID	getExtendedInfo / getInfo / findSubFolders / delete / modify / empty	Not required for getExtendedInfo and getInfo, if folder path is specified.		UID that is used to identify the folder in which the actions are performed.
folderPath	getExtendedInfo / getInfo	Not required if folderID is specified.		Full path to the folder where the action has to be performed. If you do not specify the path delimiter, / is taken by default.
pathDelimiter	getExtendedInfo / getInfo	Optional	/	Lets you specify the delimiter that is used to separate the folders.
parentFolderId	create	Required		UID that is used to identify the folder in which you create subfolders.
connection	All actions	Required		The name of the connection to the Exchange server, as specified in the cfexchangeconnection tag. If you omit this attribute, create a temporary connection by specifying cfexchangeconnection tag connection openaction attributes in the cfexchangecontact tag.
result	create / copy / move	Required		A query variable that contains the result returned from the exchange server when one of the action is performed.
destinationFolderID	copy / move	Required		A case-sensitive Exchange UID value that uniquely identifies the destination folder.
sourceFolderID	copy / move	Required		The UID that is used to identify the folder from which you copy or move folders to the destination folder.
deleteType	delete / move	Optional	moveToDeletedItems	hardDelete: Removes a folder permanently from the Exchange server. softDelete: Moves a folder to the dumpster in Exchange server, if dumpster is enabled. moveToDeletedItems: Moves a folder to the deleted items folder.
deleteSubFolders	empty	Optional	False	If true, deletes the subfolder.
folder	create / modify	Required		A struct that contains the required information of the folder that has to be created or modified, such as display name and folder class.

Result struct values for cfexchangefolder action = "getExtendedInfo"

For the action getExtendedInfo, the result is a struct that contains the following fields:

Field	Description
ChildFolderCount	The number of child folders that the parent folder has.
displayName	The display name of the folder.
folderClass	The folder class.
FolderPath	Path to the exchange server folder.
ManagedFolder	Struct that contains the following properties: canDelete: Boolean value that indicates if the user can delete objects in the folder. canRenameOrMove: Boolean value that indicates if the user can rename or move objects in the folder. mustDisplayComment: Boolean value that indicates if the client application must display the comment property to the user. HasQouta: Boolean value that indicates if the folder has a quota. IsManagedFoldersRoot: Boolean value that indicates if the folder is the root of the managed folder hierarchy. ManagedFolderId: The ID of the managed folder. comment: The comment that is associated with the folder. StorageQuota: The storage quota of the folder. FolderSize: The size of the folder. HomePage: The home page associated with the folder.
mustDisplayComment	Boolean value that indicates if the client application must display the comment property to the user.
ParentFolderId	The ID of the folder's parent folder.
Permission	List of permissions for the folder. This is an array of permission structs with the following values: canCreateItems: Boolean value that indicates if the user can create new items. canCreateSubFolders: Boolean value that indicates if the user can create sub-folders. deleteItems: Indicates if/how the user can delete existing items. The values are None (the user does not have the associated permission), Owned (the user has the associated permission on items that it owns), and All (the user has the associated permission on all items). displayPermissionLevel: The permission level that Outlook displays for this folder permission. It can have the following values: None, Owner, PublishingEditor, Editor, PublishingAuthor, Freebusytimeandsubjectandlocation, FreebusytimeOnly, Author, NonEditingAuthor, Reveiwer, Contributor, and Custom. EditItems: Indicates the items in a folder that the user has permission to edit. Values are none, owned, or all. isFolderContact: Boolean value that indicates if the user is a contact for the folder. isFolderOwner: Boolean value that indicates if the user owns the folder. isFolderVisible: Boolean value that indicates if the folder is visible to the user. PermissionLevel: Represents the combination of permissions that a user has on a folder. The values are same as that of displayPermissionLevel except Freebusytimeandsubjectandlocation and FreebusytimeOnly. readItems: The read item access permission. The values are as follows: None (user has no read access on the items in the folder), TimeOnly (user can read the start and end date and time of appointments; applies only to Calendar folders, TimeAndSubjectAndLocation (user can read the start and end date and time, subject, and location of appointments; applies only to calendar folders, and FullDetails (user has access to full details of items). UserIDDisplayName: Display name of the user. UserIDprimarySMTPAddress: The primary SMTP address of the user. userIDSID: SID of the user. UserIdstandardUser: Indicates the standard user, if default (the default delegate user, used to define default delegate permissions and Anonymous (the anonymous delegate user, used to define delegate permissions for unauthenticated users).
TotalCount	Total number of items contained in the folder.
UnreadCount	Number of unread items in the folder.

Result struct values for cfexchangefolder action = "getInfo"

For the action getInfo, the result is a struct that contains the following fields:

Field	Description
ChildFolderCount	The number of child folders this folder has
displayName	The display name of the folder
folderClass	Folder class
folderPath	Path to the exchange server folder.
UID	ID of the folder
ParentFolderId	The Id of the current folder's parent folder
TotalCount	Total number of items contained in the folder
UnreadCount	The number of unread items in the folder

Filter parameters for cfexchangefolder action = "findSubFolders"

For the action findSubFolders, the result is a query that contains details of the subfolders. The values are same as that of cfexchangefolder action = "getInfo".

Example

The following code shows how you can perform the actions getExtendedInfo, findSubFolders, getInfo, copy, delete, modify, move, and create.

<cfexchangeconnection action="open" username="folder" password="Password" server="IP_Address"
serverversion="2010" connection="conn1">
<cfexchangefolder action="getExtendedInfo" connection="conn1" name="result" folderpath="Drafts">
<cfexchangefolder action="getExtendedInfo" connection="conn1" name="result3" folderpath="Inbox">

<cfexchangefolder action="findsubfolders" connection="conn1" name="final" uid="#result3.uid#">
<cfexchangefilter name="displayname" value="folder1">
</cfexchangefolder>
<cfexchangefolder action="findsubfolders" connection="conn1" name="final1" uid="#result.uid#">
<cfexchangefilter name="displayname" value="folder1">
</cfexchangefolder>
<cfif (#final.displayname# EQ "folder1")>
<cfexchangefolder action="delete" connection="conn1" uid="#final.uid#" deletetype="harddelete">
<cfscript>
sleep(1000);
</cfscript>
<cfelseif (#final1.displayname# EQ "folder1")>
<cfexchangefolder action="delete" connection="conn1" uid="#final1.uid#" deletetype="harddelete">
<cfscript>
sleep(1000);
</cfscript>
</cfif>
<cfset newfolder = structnew()>
<cfset newfolder.displayname = "folder1">
<cfset newfolder.folderclass = "IPF.Note">
<cfexchangefolder action="create" connection="conn1" parentfolderid="#result.uid#"
folder="#newfolder#" result="result1">
</cfexchangefolder>

<cfexchangefolder action="findsubfolders" connection="conn1" name="result2" uid="#result.uid#">
<cfexchangefilter name="displayname" value="folder1">
</cfexchangefolder>

<cfset modfolder = structnew()>
<cfset modfolder.displayname = "exchange">
<cfset modfolder.folderclass = "IPF.Calendar">
<cfexchangefolder action="modify" connection="conn1" uid="#result2.uid#" folder="#modfolder#">
</cfexchangefolder>
<cfexchangefolder action="findsubfolders" connection="conn1" name="result5" uid="#result.uid#">
<cfexchangefilter name="displayname" value="exchange">
</cfexchangefolder>
<cfdump var="#result5#">

<cfexchangefolder action="getInfo" connection="conn1" name="result3" folderpath="Inbox">
<cfexchangefolder action="copy" connection="conn1" result="copiedfolderid"
sourcefolderid="#result2.uid#" destinationfolderid="#result3.uid#">
<cfexchangefolder action="findsubfolders" connection="conn1" name="result2" uid="#result.uid#">
<cfexchangefilter name="displayname" value="exchange">
</cfexchangefolder>
<cfdump var="#result2#">
<cfexchangefolder action="findsubfolders" connection="conn1" name="result4" uid="#result3.uid#">
<cfexchangefilter name="displayname" value="exchange">
</cfexchangefolder>
<cfdump var="#result4#">

<cfexchangefolder action="delete" connection="conn1" uid="#result2.uid#" deletetype="harddelete">
<cfexchangefolder action="move" connection="conn1" result="movedfolderid"
sourcefolderid="#result4.uid#" destinationfolderid="#result.uid#">
<cfexchangefolder action="findsubfolders" connection="conn1" name="result6" uid="#result.uid#">
<cfexchangefilter name="displayname" value="exchange">
</cfexchangefolder>
<cfdump var="#result6#">
<cfexchangefolder action="delete" connection="conn1" uid="#result6.uid#" deletetype="harddelete">

Get help faster and easier

New user?

cfexchangefolder

Description

History

Category

Syntax

See also