Folder Server-Side JavaScript Functions

Initialize

To interact with a folder via server-side JavaScript, you must first initialize the object. The code below initializes a folder with the external key of myFolder.

var myFolder = Folder.Init("myFolder");

Note that not all Folder objects will have an external key. You can initialize a Folder by assigning it an ID number, as shown in the sample code below:

var myIDFolder = Folder.Init();
myIDFolder.SetID(12345);

Once you initialize the folder, use the ID number to identify the folder in place of the external key for all functions listed on this page.

Add(folder)

This function adds a new folder to your account as a child to a previously existing folder and returns the status.

var newFolder = {
    "Name" : "Test Add Folder",
    "CustomerKey" : "test_folder_key",
    "Description" : "Test added",
    "ContentType" : "email",
    "IsActive" : "true",
    "IsEditable" : "true",
    "AllowChildren" : "false",
    "ParentFolderID" : 123456
};
var status = Folder.Add(newFolder);

Remove()

This function removes a  previously initialized folder.

The sample code below deletes the folder with the external key myFolder:

var myFolder = Folder.Init("myFolder");
myFolder.Remove();

Retrieve(filter)

This function retrieves an array of folders based on the specified criteria. You will also retrieve details regarding the parent folder of a given folder if one exists.

var results = Folder.Retrieve({Property:"Name",SimpleOperator:"equals",Value:"my emails"});

Update(attributes)

This function updates the folder and returns a status.

var myFolder = Folder.Init("myFolder");
var status = myFolder.Update({ "Name" : "Updated Folder Name" });