EmailSeekFirstNotes (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

EmailSeekFirstNotes (Function)

In french: EmailCherchePremierNotes

Seeks one or more emails according to specified criteria, in a local or remote Lotus Notes or Domino database.

This search can be performed:

in one or more sections of the email.
via a selection formula of Lotus Notes.

Example

// Ouverture d'une session Lotus Notes
IDSession is int
IDSession = EmailStartNotesSession("MotDePasse", "ServeurMars", ...
		"mail/julie.nsf", "C:\Lotus Notes\julie.id")
...
// Recherche des emails contenant la chaîne "PC Soft" 
// dans le sujet ou dans le corps du message
// Seuls les emails reçus sont pris en compte
IF EmailSeekFirstNotes(IDSession, emailSubject + emailBody, ...
			"PC Soft", notesReceived) = True THEN
	// Enumération des emails trouvés
	WHILE Email.Out = False
		// Affiche l'expéditeur et le sujet dans un champ Table
		TableAdd(TABLE_EmailTrouve, Email.Sender + ...
				TAB + Email.Subject)
		// Email trouvé suivant
		EmailReadNext(IDSession)
	END
ELSE
	Info("Aucun email n'a été trouvé")
END

// Ouverture d'une session Lotus Notes
IDSession is int
IDSession = EmailStartNotesSession("MotDePasse", "ServeurMars", ...
			"mail/julie.nsf", "C:\Lotus Notes\julie.id")
...
// Recherche grâce à une formule de sélection de Lotus Notes
// Recherche des emails contenant la chaîne "pc soft" 
// dans le sujet ou dans le corps du message
// et contenant WinDev dans la catégorie
// Seuls les emails reçus et non lus sont pris en compte
IF EmailSeekFirstNotes(IDSession, emailSubject + emailBody, ...
	"PC Soft", "@contains(@lowercase(categories);'WinDev')", ...
	notesReceived, emailUnread) = True THEN
	// Enumération des emails trouvés
	WHILE Email.Out = False
		// Affiche l'expéditeur et le sujet dans un champ Table
		TableAdd(TABLE_EmailTrouve, Email.Sender + ...
			TAB + Email.Subject)
		// Email trouvé suivant
		EmailReadNext(IDSession)
	END
ELSE
	Info("Aucun email n'a été trouvé")
END

Syntax

Seeking in one or more sections of an Email variable Hide the details

<Result> = EmailSeekFirstNotes(<Session> , <Email> , <Email section> , <Search value> [, <Type of email> [, <Read mode>]])

<Result>: Boolean

True if one or more emails have been found,
False otherwise.
If an error occurs, the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo with the errMessage constant.
If no email was found, the ErrorOccurred variable remains at False and the Email.Out variable is set to True.

<Session>: Integer or emailNotesSession variable

The session can be:
an integer returned by one of the following functions: EmailStartSession, EmailStartNotesSession or NotesOpenConnection.
a variable of type emailNotesSession.

<Email>: Email variable

Name of the Email variable corresponding to the email where the search will be performed.

<Email section>: Integer constant (or combination of constants)

Email section where the <Sought Value> will be sought:
emailBody Body of emails.
emailRecipient Recipients of emails.
emailSender Senders of emails.
emailSubject Subjects of emails.

These constants can be combined.

<Search value>: Character string

Value sought in the emails.

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

Type of email where the search will be performed:
notesAll
(Default value) All the emails.
notesDraft Draft emails.
notesFollowUp Emails flagged as "Follow up".
notesReceived Incoming emails.
notesSent Outgoing emails.

These constants can be combined.

<Read mode>: Optional constant or character string

Indicates the messages that will be read:
emailAll or "ALL"
(Default value) The search is performed in the read emails and in the unread emails.
emailUnread or "UNREAD" The search is performed in the unread emails only.

Seeking via a selection formula of Lotus Notes in an Email variable Hide the details

<Result> = EmailSeekFirstNotes(<Session> , <Email> , <Email section> , <Search value> , <Lotus Notes formula> [, <Type of email> [, <Read mode>]])

<Result>: Boolean

True if one or more emails have been found,
False otherwise.
If an error occurs, the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo with the errMessage constant.
If no email was found, the ErrorOccurred variable remains at False and the Email.Out variable is set to True.

<Session>: Integer or emailNotesSession variable

The session can be:
an integer returned by EmailStartSession, EmailStartNotesSession or NotesOpenConnection.
a variable of type emailNotesSession.

<Email>: Email variable

Email where the search will be performed.

<Email section>: Integer constant (or combination of constants)

Email section where the <Sought Value> will be sought:
emailBody Body of emails.
emailNone Search performed via a selection formula of Lotus Notes. In this case, <Sought Value> corresponds to an empty string ("").
This constant cannot be combined.
emailRecipient Recipients of emails.
emailSender Senders of emails.
emailSubject Subjects of emails.

These constants can be combined.

<Search value>: Character string

Value sought in the emails,
Empty string ("") if <Email Section> corresponds to the emailNone constant.

<Lotus Notes formula>: Character string

Formula for selecting the emails in Lotus Notes. For more details, see the documentation about Lotus Notes.

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

Type of email where the search will be performed:
notesAll
(by default) All the emails.
notesDraft Draft emails.
notesFollowUp Emails flagged as "Follow up".
notesReceived Incoming emails.
notesSent Outgoing emails.

These constants can be combined.

<Read mode>: Optional constant or character string

Indicates the messages that will be read:
emailAll or "ALL"
(Default value) The search is performed in the read emails and in the unread emails.
emailUnread or "UNREAD" The search is performed in the unread emails only.

Seeking in one or more sections of the email structure Hide the details

<Result> = EmailSeekFirstNotes(<Session> , <Email section> , <Search value> [, <Type of email> [, <Read mode>]])

<Result>: Boolean

True if one or more emails have been found,
False otherwise.
If an error occurs, the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo with the errMessage constant.
If no email was found, the ErrorOccurred variable remains at False and the Email.Out variable is set to True.

<Session>: Integer or emailNotesSession variable

The session can be:
an integer returned by one of the following functions: EmailStartSession, EmailStartNotesSession or NotesOpenConnection.
a variable of type emailNotesSession.

<Email section>: Integer constant (or combination of constants)

Email section where the <Sought Value> will be sought:
emailBody Body of emails.
emailRecipient Recipients of emails.
emailSender Senders of emails.
emailSubject Subjects of emails.

These constants can be combined.

<Search value>: Character string

Value sought in the emails.

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

Type of email where the search will be performed:
notesAll
(Default value) All the emails.
notesDraft Draft emails.
notesFollowUp Emails flagged as "Follow up".
notesReceived Incoming emails.
notesSent Outgoing emails.

These constants can be combined.

<Read mode>: Optional constant or character string

Indicates the messages that will be read:
emailAll or "ALL"
(Default value) The search is performed in the read emails and in the unread emails.
emailUnread or "UNREAD" The search is performed in the unread emails only.

Searching via a selection formula of Lotus Notes in the Email structure Hide the details

<Result> = EmailSeekFirstNotes(<Session> , <Email section> , <Search value> , <Lotus Notes formula> [, <Type of email> [, <Read mode>]])

<Result>: Boolean

True if one or more emails have been found,
False otherwise.
If an error occurs, the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo with the errMessage constant.
If no email was found, ErrorOccurred remains set to False and the Email.Out variable is set to True.

<Session>: Integer or emailNotesSession variable

The session can be:
an integer returned by one of the following functions: EmailStartSession, EmailStartNotesSession or NotesOpenConnection.
a variable of type emailNotesSession.

<Email section>: Integer constant (or combination of constants)

Email section where the <Sought Value> will be sought:
emailBody Body of emails.
emailNone Search performed via a selection formula of Lotus Notes. In this case, <Sought Value> corresponds to an empty string ("").
This constant cannot be combined.
emailRecipient Recipients of emails.
emailSender Senders of emails.
emailSubject Subjects of emails.

These constants can be combined.

<Search value>: Character string

Value sought in the emails,
Empty string ("") if <Email Section> corresponds to the emailNone constant.

<Lotus Notes formula>: Character string

Formula for selecting the emails in Lotus Notes. For more details, see the documentation about Lotus Notes.

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

Type of email where the search will be performed:
notesAll
(Default value) All the emails.
notesDraft Draft emails.
notesFollowUp Emails flagged as "Follow up".
notesReceived Incoming emails.
notesSent Outgoing emails.

These constants can be combined.

<Read mode>: Optional constant or character string

Indicates the messages that will be read:
emailAll or "ALL"
(Default value) The search is performed in the read emails and in the unread emails.
emailUnread or "UNREAD" The search is performed in the unread emails only.

Component: wd300com.dll