IMailSyncHandler::FOLDEROPTIONS (Compact 7)

3/12/2014

The FOLDEROPTIONS enumeration is used in the IMailSyncHandler::SetFolderOptions method to request that the transport set various folder options.

Syntax

enum FOLDEROPTIONS {
  koptNA = 0,
  koptDownload,
  koptQueryDownload,
  koptNotifications,
  koptQueryNotifications,
  koptGetRemotePath,
  koptCreate,
  koptQueryCreate,
  koptSetAge,
  koptSetBodyFetchSize,
  koptSetAttachFetchSize,
  koptGetAge,
  koptGetBodyFetchSize,
  koptGetAttachFetchSize
};

Elements

• koptNA
  The "no-op" value; the state of no operation.

• koptDownload
  A Boolean property that, when TRUE, indicates the specified folder is marked for download. It is used to set the property.

• koptQueryDownload
  A Boolean property that, when TRUE, starts a query of the download status of a folder.

• koptNotifications
  A Boolean property that, when TRUE, turns on notification support for a folder.

• koptQueryNotifications
  A Boolean property that, when TRUE, starts a query of the notification support of a folder.

• koptGetRemotePath
  Sets the folder option to obtain a string property that can be used to determine the remote path of the folder on the server. It is not necessary to return this to the application.

• koptCreate
  A Boolean property that can be set against a folder. If set to TRUE, at the next synchronization of the mail transport, the folder is created on the server.

• koptQueryCreate
  A Boolean property that, when TRUE, starts a determination whether a folder is marked for creation at the next synchronization.

• koptSetAge
  A number property that is used to indicate the number of days of mail that should be synchronized for the folder.

• koptSetBodyFetchSize
  A number property that is used to indicate the number of bytes of the body of messages that should be fetched for the folder. If set to zero, only the header should be fetched. If set to -1, the entire message body should be fetched.

• koptSetAttachFetchSize
  A number property that is used to indicate the maximum size of attachment to fetch. If set to -1, all attachments are fetched.

• koptGetAge
  See koptSetAge.

• koptGetBodyFetchSize
  See koptSetBodyFetchSize.

• koptGetAttachFetchSize
  See koptSetAttachFetchSize.

Remarks

Enumerators that start with koptQuery or koptGet retrieve the value for the corresponding option instead of setting it.

Requirements

See Also

Reference

IMailSyncHandler