ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Communication / Managing emails
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
Returns the list of folders of an IMAP session.
Example
MaSession is emailIMAPSession
...
// Liste des dossiers
ListeDossier = MaSession.ListeDossier(LstFolderAll + LstFolderType)
// ListeDossier contient par exemple:
// "Dossiers personnels" + TAB + dossierPersonnel + RC + ...
// "Dossiers personnels\Boîte de réception" + ...
// TAB + dossierRéception + RC + ...
// "Dossiers personnels\Boîte de réception\Travail" + ...
// TAB + dossierGénérique + RC + ...
// "Dossiers personnels\Boîte de réception\Personnel" + ...
// TAB + dossierGénérique + RC + ...
Syntax
<Result> = <Session>.FolderList([<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:
LstFolderAll<Name of Folder1> + CR + <Name of Folder2> + CR +...
LstFolderNormal
(Default value)
<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:
<Nom DossierX> Full name of file. For example: "Personal folders\IncomingData\Work".
<Type DossierX> Type of file listed. This parameter can correspond to:
  • draft folder: Draft folder
  • dossierContact: Contacts and contact groups folder
  • trash folder: Deleted items folder
  • dossierEnvoie: Folder of emails waiting to be sent
  • dossierEnvoyé: Sent emails folder
  • generic folder: Generic folder (folder created by users)
  • dossierJournal: Newspaper dossier
  • dossierNote: Notes folder
  • PersonalFolder: Root of the "PersonalFolders" folder
  • folderReceipt: Inbox folder
  • dossierRendezVous: Appointments folder
  • task folder: Task folder
If an error occurs, the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo 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:
    LstFolderAllList of all folders.
    LstFolderNormalList of folders containing emails only ("In-box", "Elements sent", ...).
  • 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: wd300com.dll
Minimum version required
  • Version 24
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 09/26/2024

Send a report | Local help