Folder Methods

Overview

Folders are objects in the API that contain other objects. As shown in the API object map, Folders are top-level containers of three types: List, Message, and File. Folders can only hold objects of their type, but provide a way of breaking down one type of object into smaller, more manageable categories. For example, you may have Message Folders named Email and SMS.

The API Folder methods enable you to perform tasks such as adding, editing, deleting, and searching for Folders. Each time a Folder method is called, it can act on one Folder type.

A Folder does not actually have an array of the Lists, Messages, or Files it contains; instead, these objects are flagged with the id or name of their Folder.

Folder Methods

• addFolder

  Creates a new Folder.

• countFolders

  Counts the number of Folders that match the search criteria.

• deleteFolder

  Deletes the specified Folder.

• editFolder

  Renames the specified Folder.

• getFolderById

  Returns the details of a specific Folder.

• searchFolders

  Returns the Folders that match the search criteria.