EmailStartNotesSession (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

EmailStartNotesSession

Presentation

Example

Version of Lotus Notes

Timeout

See also

EmailStartNotesSession (Function)

In french: EmailOuvreSessionNotes

Used to access the data handled by the Lotus Notes messaging (emails, contacts, groups of contacts, tasks, appointments).

This function can be:

called directly to establish the connection to the Domino server and to specify the Lotus Notes database to use.
called after NotesOpenConnection. In this case, this function is only used to specify the Lotus Notes database to use.

Example

// Open the connection
// and specify the Lotus Notes database to use
IF EmailStartNotesSession("Password", "MarsServer", ...
"email/julia.nsf", "C:\Lotus Notes\julia.id") <> 0 THEN
Info("Session started and database specified")
ELSE
Error()
END

// Open the connection
SessionID is int
SessionID = NotesOpenConnection("Password", "MarsServer", ...
"C:\Lotus Notes\julia.id")
// Specify the Lotus Notes database to use
IF EmailStartNotesSession(SessionID, "email/julia.nsf") <> 0 THEN
Info("Connection established and database specified")
ELSE
Error()
END

Syntax

Establishing a connection to a Domino server and specifying the Lotus Notes database to use Hide the details

<Result> = EmailStartNotesSession(<Password> , <Domino server> [, <Lotus Notes Database> [, <Certificate path>]])

<Result>: Integer

Session identifier.
0 (or False) if an error occurred. The ErrorOccurred variable is set to True. To get the details of the error, use ErrorInfo with the errMessage constant.

<Password>: Character string (with quotes)

User password. This password is given by the service provider or by the network administrator.

<Domino server>: Character string (with quotes)

Name of Domino server,
Empty string ("") if the database is a local database.

<Lotus Notes Database>: Optional character string (with quotes)

Name of Lotus Notes database containing the user data. This name corresponds to the path of ".NSF" file.
A relative path must be used if the Lotus Notes database is found on a Domino server.
If this parameter is not specified, the name of the Lotus Notes database will be read in the configuration file of the Lotus Notes client ("Notes.INI" file). The database used will correspond to the database of the user of Lotus Notes client for the current computer.

<Certificate path>: Optional character string (with quotes)

Path of certificate used to authenticate the user ("ID" file). This file is given by the administrator of the Domino server. This file is required to establish the connection to the server.
If this parameter is not specified, the path of the certificate will be read in the configuration file of the Lotus Notes client ("Notes.INI" file). The certificate used will correspond to the certificate of the user of the Lotus Notes client for the current computer.

Specifying the Lotus Notes database to use Hide the details

<Result> = EmailStartNotesSession(<Session identifier> [, <Lotus Notes Database>])

<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.

<Session identifier>: Character string

Identifier of the session to start. This identifier is returned by NotesOpenConnection.

<Lotus Notes Database>: Optional character string (with quotes)

Name of Lotus Notes database containing the user data. This name corresponds to the path of ".NSF" file.
A relative path must be used if the Lotus Notes database is found on a Domino server.
If this parameter is not specified, the name of the Lotus Notes database will be read in the configuration file of the Lotus Notes client ("Notes.INI" file). The database used will correspond to the database of the user of Lotus Notes client for the current computer.

Remarks

Version of Lotus Notes

The access to Lotus Notes is available for Lotus Notes version 6.5 or later.

Timeout

The timeout can be configured by EmailSetTimeOut.

Component: wd260com.dll