PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
New WINDEV, WEBDEV, WINDEV Mobile 24 feature!
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Returns the list of folders of an IMAP session.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for iPhone/iPad applications.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Versions 22 and later
Android Widget This function is now available in Android Widget mode.
Android This function is now available for Android applications.
New in version 22
Android Widget This function is now available in Android Widget mode.
Android This function is now available for Android applications.
Android Widget This function is now available in Android Widget mode.
Android This function is now available for Android applications.
Example
MySession is emailIMAPSession
...
// List of folders
FolderList = MySession.ListFolder(LstFolderAll + LstFolderType)
// FolderList contains for example:
// "Personal folders" + TAB + folderPersonal + CR + ...
// "Personal folders\Inbox" + ...
// TAB + folderInbox + CR + ...
// "Personal folders\Inbox\Work" + ...
// TAB + folderGeneric + CR + ...
// "Personal folders\Inbox\Personal" + ...
// TAB + folderGeneric + CR +...
Syntax
<Result> = <Session>.ListFolder([<Option>])
<Result>: Character string
List of folders. The different folders are separated by CR characters (Carriage Return). The format of the result depends on the constant used:
LstFolderNormal
(Default value)
<Name of Folder1> + CR + <Name of Folder2> + CR +...
LstFolderAll<Name of Folder1> + CR + <Name of Folder2> + CR +...
LstFolderSorted<Name of Folder1> + CR + <Name of Folder2> + CR +...
LstFolderType<Name of Folder1> + TAB + "Type of Folder1> + CR + <Name of Folder2> + TAB + "Type of Folder2> + CR +...
Where:
<Name of FolderX>: Full name of folder. For example: "Personal folders\Inbox\Work".
<Type of FolderX>: Type of listed folder. This parameter can correspond to:
  • folderDraft: Folder for the drafts
  • folderContact: Folder for the contacts and for the groups of contacts
  • folderRecycleBin: Folder for the deleted elements
  • folderOutbox: Folders for the emails that will be sent
  • folderSentEmail: Folder for the outgoing emails
  • folderGeneric: Generic folder (folder created by the users)
  • folderLog: Folder for the logs
  • folderNote: Folder for the notes
  • folderPersonal: Root of the "Personal folders" folder
  • folderInbox: Folder for the incoming emails
  • folderAppointment: Folder for the appointments
  • folderTask: Folder for the tasks
The ErrorOccurred variable is set to True if an error occurs. To find out the error details, use ErrorInfo associated with the errMessage constant.
<Session>: emailIMAPSession variable
Name of the emailIMAPSession variable corresponding to the email session to use.
<Option>: Optional Integer constant (or combination of constants)
Indicates:
  • the type of list to perform:
    LstFolderNormalList of folders containing emails only ("In-box", "Elements sent", ...).
    LstFolderAllList of all folders.
  • the sort mode of the list:
    LstFolderSortedList sorted in alphabetical order.
  • the display of the folder type:
    LstFolderTypeReturns the type and name of folders (option not supported by the IMAP protocol)
By default, all folders containing emails are listed. This list is not sorted in alphabetical order and it contains the name of each folder only.
Component : wd240com.dll
Minimum version required
  • Version 24
This page is also available for…
Comments
Click [Add] to post a comment