EmailListFolder (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Communication / Managing emails

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EmailListFolder (Function)

In french: EmailListeDossier

Returns the list of folders:

for an IMAP session.
found in the Outlook messaging software.
Reminder: This function does not list folders in Outlook Express.

Example

See additional examples

MaSession is emailIMAPSession
...
// Liste des dossiers
ListeDossier = EmailListFolder(MaSession, 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 + ...

// Ouverture de la session
IDSession = EmailStartOutlookSession("MonProfil")
...
// Liste des dossiers
ListeDossier = EmailListFolder(IDSession)
// ListeDossier contient par exemple:
// "Dossiers personnels" + RC + ...
// "Dossiers personnels\Boîte de réception" + RC + ... 
// "Dossiers personnels\Boîte de réception\Travail" + RC + ...
// "Dossiers personnels\Boîte de réception\Personnel" + RC + ...

Syntax

<Result> = EmailListFolder(<Session> [, <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>: Character string, integer, or emailOutlookSession or emailIMAPSession variable

Identifier of the current email session. This identifier can be:
an integer returned by EmailStartOutlookSession or OutlookStartSession.
a variable of type emailOutlookSession.
a variable of type emailIMAPSession.
the username passed to EmailStartIMAPSession.

<Option>: Optional Integer constant (or combination of constants)

Indicates:
the type of list to perform:
LstFolderAll List of all folders.
LstFolderNormal List of folders containing emails only ("In-box", "Elements sent", ...).
the sort mode of the list:
LstFolderSorted List sorted in alphabetical order.
the display of the folder type:
LstFolderType Returns 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.

Remarks

To handle:

the content of the "Contacts" folder, use Contact functions and Group functions.
the content of the "Appointments" folder, use Appointment functions.
the content of the "Tasks" folder, use Task functions.

Component: wd300com.dll