PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
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
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
// Start a Lotus Notes session
SessionID is int
SessionID = EmailStartNotesSession("Password", "MarsServer", ...
"email/julia.nsf", "C:\Lotus Notes\julia.id")
...
// Find the emails containing "PC Soft"
// in the message subject or body
// Only the incoming emails are taken into account
IF EmailSeekFirst(SessionID, emailSubject + emailBody, ...
"PC Soft", notesReceived) = True THEN
// Enumerate the emails found
WHILE Email.Out = False
// Displays the sender and subject in a Table control
TableAdd(TABLE_EmailFound, Email.Sender + ...
TAB + Email.Subject)
// Next email found
EmailReadNext(SessionID)
END
ELSE
Info("No email was found")
END
// Start a Lotus Notes session
SessionID is int
SessionID = EmailStartNotesSession("Password", "MarsServer", ...
"email/julia.nsf", "C:\Lotus Notes\julia.id")
...
// Search performed via a selection formula of Lotus Notes
// Find the emails containing "pc soft"
// in the message subject or body
// and containing WINDEV in the category
// Only the incoming and unread emails are taken into account
IF EmailSeekFirst(SessionID, emailSubject + emailBody, ...
"PC Soft", "@contains(@lowercase(categories);'WinDev')", ...
notesReceived, emailUnread) = True THEN
// Enumerate the emails found
WHILE Email.Out = False
// Displays the sender and subject in a Table control
TableAdd(TABLE_EmailFound, Email.Sender + ...
TAB + Email.Subject)
// Next email found
EmailReadNext(SessionID)
END
ELSE
Info("No email was found")
END
Syntax
Versions 15 and later

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

<Result> = EmailSeekFirstNotes(<Session> , <Email> , <Email Section> , <Sought Value> [, <Type of Email> [, <Read Mode>]])
<Result>: Boolean
  • True if one or more emails have been found,
  • False otherwise.
The ErrorOccurred variable is set to True if an error occurred. To find out the error details, use ErrorInfo associated with the errMessage constant.
If no email was found, the ErrorOccurred variable remains set to False and the Email.Out variable is positioned to True.
<Session>: Integer or emailNotesSession variable
The session can be:
<Email>: Email variable
Name of 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:
emailBodyBody of emails.
emailRecipientRecipients of emails.
emailSenderSenders of emails.
emailSubjectSubjects of emails.

These constants can be combined.
<Sought 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.
notesReceivedIncoming emails.
notesSentOutgoing emails.
notesFollowUpEmails flagged as "Follow up".
notesDraftDraft emails.

These constants can be combined.
<Read Mode>: Optional constant or character string
Specifies 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.
New in version 15

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

<Result> = EmailSeekFirstNotes(<Session> , <Email> , <Email Section> , <Sought Value> [, <Type of Email> [, <Read Mode>]])
<Result>: Boolean
  • True if one or more emails have been found,
  • False otherwise.
The ErrorOccurred variable is set to True if an error occurred. To find out the error details, use ErrorInfo associated with the errMessage constant.
If no email was found, the ErrorOccurred variable remains set to False and the Email.Out variable is positioned to True.
<Session>: Integer or emailNotesSession variable
The session can be:
<Email>: Email variable
Name of 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:
emailBodyBody of emails.
emailRecipientRecipients of emails.
emailSenderSenders of emails.
emailSubjectSubjects of emails.

These constants can be combined.
<Sought 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.
notesReceivedIncoming emails.
notesSentOutgoing emails.
notesFollowUpEmails flagged as "Follow up".
notesDraftDraft emails.

These constants can be combined.
<Read Mode>: Optional constant or character string
Specifies 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 an Email variable Hide the details

<Result> = EmailSeekFirstNotes(<Session> , <Email> , <Email Section> , <Sought Value> [, <Type of Email> [, <Read Mode>]])
<Result>: Boolean
  • True if one or more emails have been found,
  • False otherwise.
The ErrorOccurred variable is set to True if an error occurred. To find out the error details, use ErrorInfo associated with the errMessage constant.
If no email was found, the ErrorOccurred variable remains set to False and the Email.Out variable is positioned to True.
<Session>: Integer or emailNotesSession variable
The session can be:
<Email>: Email variable
Name of 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:
emailBodyBody of emails.
emailRecipientRecipients of emails.
emailSenderSenders of emails.
emailSubjectSubjects of emails.

These constants can be combined.
<Sought 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.
notesReceivedIncoming emails.
notesSentOutgoing emails.
notesFollowUpEmails flagged as "Follow up".
notesDraftDraft emails.

These constants can be combined.
<Read Mode>: Optional constant or character string
Specifies 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.
Versions 15 and later

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

<Result> = EmailSeekFirstNotes(<Session> , <Email> , <Email Section> , <Sought Value> , <Lotus Notes Formula> [, <Type of Email> [, <Read Mode>]])
<Result>: Boolean
  • True if one or more emails have been found,
  • False otherwise.
The ErrorOccurred variable is set to True if an error occurs. To find out the error details, use ErrorInfo associated with the errMessage constant.
If no email was found, the ErrorOccurred variable remains set to False and the Email.Out variable is positioned to True.
<Session>: Integer or emailNotesSession variable
The session can be:
<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:
emailNoneSearch performed via a selection formula of Lotus Notes. In this case, <Sought Value> corresponds to an empty string ("").
This constant cannot be combined.
emailBodyBody of emails.
emailRecipientRecipients of emails.
emailSenderSenders of emails.
emailSubjectSubjects of emails.

These constants can be combined.
<Sought 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. See the documentation about Lotus Notes for more details.
<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.
notesReceivedIncoming emails.
notesSentOutgoing emails.
notesFollowUpEmails flagged as "Follow up".
notesDraftDraft 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.
New in version 15

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

<Result> = EmailSeekFirstNotes(<Session> , <Email> , <Email Section> , <Sought Value> , <Lotus Notes Formula> [, <Type of Email> [, <Read Mode>]])
<Result>: Boolean
  • True if one or more emails have been found,
  • False otherwise.
The ErrorOccurred variable is set to True if an error occurs. To find out the error details, use ErrorInfo associated with the errMessage constant.
If no email was found, the ErrorOccurred variable remains set to False and the Email.Out variable is positioned to True.
<Session>: Integer or emailNotesSession variable
The session can be:
<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:
emailNoneSearch performed via a selection formula of Lotus Notes. In this case, <Sought Value> corresponds to an empty string ("").
This constant cannot be combined.
emailBodyBody of emails.
emailRecipientRecipients of emails.
emailSenderSenders of emails.
emailSubjectSubjects of emails.

These constants can be combined.
<Sought 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. See the documentation about Lotus Notes for more details.
<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.
notesReceivedIncoming emails.
notesSentOutgoing emails.
notesFollowUpEmails flagged as "Follow up".
notesDraftDraft 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> , <Sought Value> , <Lotus Notes Formula> [, <Type of Email> [, <Read Mode>]])
<Result>: Boolean
  • True if one or more emails have been found,
  • False otherwise.
The ErrorOccurred variable is set to True if an error occurs. To find out the error details, use ErrorInfo associated with the errMessage constant.
If no email was found, the ErrorOccurred variable remains set to False and the Email.Out variable is positioned to True.
<Session>: Integer or emailNotesSession variable
The session can be:
<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:
emailNoneSearch performed via a selection formula of Lotus Notes. In this case, <Sought Value> corresponds to an empty string ("").
This constant cannot be combined.
emailBodyBody of emails.
emailRecipientRecipients of emails.
emailSenderSenders of emails.
emailSubjectSubjects of emails.

These constants can be combined.
<Sought 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. See the documentation about Lotus Notes for more details.
<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.
notesReceivedIncoming emails.
notesSentOutgoing emails.
notesFollowUpEmails flagged as "Follow up".
notesDraftDraft 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> , <Sought Value> [, <Type of Email> [, <Read Mode>]])
<Result>: Boolean
  • True if one or more emails have been found,
  • False otherwise.
The ErrorOccurred variable is set to True if an error occurs. To find out the error details, use ErrorInfo associated with the errMessage constant.
If no email was found, the ErrorOccurred variable remains set to False and the Email.Out variable is positioned to True.
<Session>: Integer or emailNotesSession variable
The session can be:
<Email Section>: Integer constant (or combination of constants)
Email section where the <Sought Value> will be sought:
emailBodyBody of emails.
emailRecipientRecipients of emails.
emailSenderSenders of emails.
emailSubjectSubjects of emails.

These constants can be combined.
<Sought 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.
notesReceivedIncoming emails.
notesSentOutgoing emails.
notesFollowUpEmails flagged as "Follow up".
notesDraftDraft 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> , <Sought Value> , <Lotus Notes Formula> [, <Type of Email> [, <Read Mode>]])
<Result>: Boolean
  • True if one or more emails have been found,
  • False otherwise.
The ErrorOccurred variable is set to True if an error occurs. To find out the error details, use ErrorInfo associated with the errMessage constant.
If no email was found, ErrorOccurred remains to False and the Email.Out variable is positioned to True.
<Session>: Integer or emailNotesSession variable
The session can be:
<Email Section>: Integer constant (or combination of constants)
Email section where the <Sought Value> will be sought:
emailNoneSearch performed via a selection formula of Lotus Notes. In this case, <Sought Value> corresponds to an empty string ("").
This constant cannot be combined.
emailBodyBody of emails.
emailRecipientRecipients of emails.
emailSenderSenders of emails.
emailSubjectSubjects of emails.

These constants can be combined.
<Sought 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. See the documentation about Lotus Notes for more details.
<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.
notesReceivedIncoming emails.
notesSentOutgoing emails.
notesFollowUpEmails flagged as "Follow up".
notesDraftDraft 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.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230com.dll
Minimum required version
  • Version 11
This page is also available for…
Comments
Click [Add] to post a comment