CopyTo Method (Folder Object)

The CopyTo method makes a copy of the Folder object at another folder hierarchy location.

Syntax

Set objCopiedFolder = objFolder.CopyTo(folderID [, storeID] [, name] [, copySubfolders ] )

objCopiedFolder

On successful return, contains the copied Folder object.

objFolder

Required. This Folder object.

folderID

Required. String. The unique identifier of the new parent Folder object, that is, the Folder object under which the copy of this folder is to appear as a subfolder.

storeID

Optional. String. The unique identifier of the InfoStore object in which the folder copy is to appear, if different from this folder's InfoStore.

name

Optional. String. The name to be assigned to the folder copy, if different from this folder's name.

copySubfolders

Optional. Boolean. If True, all subfolders contained within this folder are to be copied along with the folder. The default value is True.

Remarks

All Message objects contained within this folder are copied along with the folder itself. This also applies to messages contained in the subfolders if the copySubfolders parameter is True.

The copy operation takes effect immediately. This Folder object, together with all its contents, remains unchanged by the CopyTo method.