PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • Creating a profile
  • Timeout
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
Allows you to access data handled by the Outlook messaging software (emails, contacts, groups of contacts, tasks, appointments and folders). This function is identical to OutlookStartSession.
Caution: This function cannot be used to access the data handled by the Outlook Express messaging software.
Note: When using EmailStartOutlookSession, the current directory is automatically modified by Outlook.
Example
// Start the session
IF EmailStartOutlookSession("MyProfile") <> 0 THEN
Info("Session started")
ELSE
ErrorInfo()
END
 
nOutlookSessionID is int
// Start the Outlook session with the default profile
nOutlookSessionID = EmailStartOutlookSession("")
// Session started?
IF nOutlookSessionID = 0 THEN
// Failure starting the session
Error("Failure starting the Outlook session", ErrorInfo())
ELSE
// Process
Info("List of email folders of Outlook:", ...
EmailListFolder(nOutlookSessionID))
// Close the session
EmailCloseSession(nOutlookSessionID)
END
 
Syntax

Starting the Outlook session Hide the details

<Result> = EmailStartOutlookSession(<Profile>)
<Result>: Integer
  • Session identifier.
  • 0 (or False) if an error occurred. The ErrorOccurred variable is set to True. To find out the error details, use ErrorInfo associated with the errMessage constant.
<Profile>: Character string
Identifies the connection profile (see Notes).
If this parameter corresponds to an empty string (""):
  • if several profiles are defined on the current computer, EmailStartOutlookSession displays a window containing all profiles among which the user can choose his own profile.
  • if a single profile is defined on the current computer, EmailStartOutlookSession automatically selects this profile.
Windows Mobile User account to use. If this parameter contains an empty string (""), the "ActiveSync" user account will be used.
Versions 18 and later

Starting the Outlook session while specifying the management mode of contacts/participants Hide the details

<Result> = EmailStartOutlookSession(<Profile> , <Asynchronous> [, <Start options>])
<Result>: Integer
  • Session identifier.
  • 0 (or False) if an error occurred. The ErrorOccurred variable is set to True. To find out the error details, use ErrorInfo associated with the errMessage constant.
<Profile>: Character string
Identifies the connection profile (see Notes).
If this parameter corresponds to an empty string (""):
  • if several profiles are defined on the current computer, EmailStartOutlookSession displays a window containing all profiles among which the user can choose his own profile.
  • if a single profile is defined on the current computer, EmailStartOutlookSession automatically selects this profile.
Windows Mobile User account to use. If this parameter contains an empty string (""), the "ActiveSync" user account will be used.
<Asynchronous>: Constant or boolean
Mode for sending the emails:
emailAsynchronous or TrueThe outgoing emails must be transmitted in asynchronous mode (see the Notes).
emailSynchronous or False
(Default value)
The outgoing emails must be transmitted in synchronous mode (see the Notes).
Windows Mobile This parameter must correspond to emailSynchronous or False.
<Start options>: Optional integer constant
Mode for starting the Outlook session:
outlookAPTWithContact
(Default value)
The AppointmentXXX functions will list the contacts associated with the appointments in the mAppointment.Participant variable (see Appointment structure).
outlookAPTWithParticipantThe AppointmentXXX functions will list the participants associated with the appointments in the following variables:
  • mAppointment.Participant
  • mAppointment.ParticipantCc
  • mAppointment.ParticipantBcc
See Appointment structure for more details.
New in version 18

Starting the Outlook session while specifying the management mode of contacts/participants Hide the details

<Result> = EmailStartOutlookSession(<Profile> , <Asynchronous> [, <Start options>])
<Result>: Integer
  • Session identifier.
  • 0 (or False) if an error occurred. The ErrorOccurred variable is set to True. To find out the error details, use ErrorInfo associated with the errMessage constant.
<Profile>: Character string
Identifies the connection profile (see Notes).
If this parameter corresponds to an empty string (""):
  • if several profiles are defined on the current computer, EmailStartOutlookSession displays a window containing all profiles among which the user can choose his own profile.
  • if a single profile is defined on the current computer, EmailStartOutlookSession automatically selects this profile.
Windows Mobile User account to use. If this parameter contains an empty string (""), the "ActiveSync" user account will be used.
<Asynchronous>: Constant or boolean
Mode for sending the emails:
emailAsynchronous or TrueThe outgoing emails must be transmitted in asynchronous mode (see the Notes).
emailSynchronous or False
(Default value)
The outgoing emails must be transmitted in synchronous mode (see the Notes).
Windows Mobile This parameter must correspond to emailSynchronous or False.
<Start options>: Optional integer constant
Mode for starting the Outlook session:
outlookAPTWithContact
(Default value)
The AppointmentXXX functions will list the contacts associated with the appointments in the mAppointment.Participant variable (see Appointment structure).
outlookAPTWithParticipantThe AppointmentXXX functions will list the participants associated with the appointments in the following variables:
  • mAppointment.Participant
  • mAppointment.ParticipantCc
  • mAppointment.ParticipantBcc
See Appointment structure for more details.

Starting the Outlook session while specifying the management mode of contacts/participants Hide the details

<Result> = EmailStartOutlookSession(<Profile> , <Asynchronous> [, <Start options>])
<Result>: Integer
  • Session identifier.
  • 0 (or False) if an error occurred. The ErrorOccurred variable is set to True. To find out the error details, use ErrorInfo associated with the errMessage constant.
<Profile>: Character string
Identifies the connection profile (see Notes).
If this parameter corresponds to an empty string (""):
  • if several profiles are defined on the current computer, EmailStartOutlookSession displays a window containing all profiles among which the user can choose his own profile.
  • if a single profile is defined on the current computer, EmailStartOutlookSession automatically selects this profile.
Windows Mobile User account to use. If this parameter contains an empty string (""), the "ActiveSync" user account will be used.
<Asynchronous>: Constant or boolean
Mode for sending the emails:
emailAsynchronous or TrueThe outgoing emails must be transmitted in asynchronous mode (see the Notes).
emailSynchronous or False
(Default value)
The outgoing emails must be transmitted in synchronous mode (see the Notes).
Windows Mobile This parameter must correspond to emailSynchronous or False.
<Start options>: Optional integer constant
Mode for starting the Outlook session:
outlookAPTWithContact
(Default value)
The AppointmentXXX functions will list the contacts associated with the appointments in the mAppointment.Participant variable (see Appointment structure).
outlookAPTWithParticipantThe AppointmentXXX functions will list the participants associated with the appointments in the following variables:
  • mAppointment.Participant
  • mAppointment.ParticipantCc
  • mAppointment.ParticipantBcc
See Appointment structure for more details.
Remarks

Creating a profile

To start a new session with Outlook, a "profile" must be defined. This "profile" is defined in the configuration of the Internet connection with Outlook.
To create a profile:
  1. Start Outlook.
  2. In the "Choosing a profile" window, click [New].
  3. Select the "Microsoft Exchange Server" service.
  4. Give a name to the profile.
  5. Enter the name of Microsoft Exchange server.

Timeout

The timeout can be configured by EmailSetTimeOut.
Component : wd250com.dll
Minimum version required
  • Version 11
This page is also available for…
Comments
Click [Add] to post a comment