EmailNbMessage (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Communication / Managing emails

Deleted messages (POP3 protocol)
Deleted messages (Outlook messaging)
Deleted messages (IMAP protocol)
New messages (POP3 protocol)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EmailNbMessage (Function)

In french: EmailNbMessage

Returns the number of incoming messages currently found:

on the email server (POP3 and IMAP protocol).
- POP3 protocol: This number of messages remains constant during the entire email session, even if new emails are received or if emails are deleted by EmailDeleteMessage.
- IMAP protocol: This number of messages evolves according to the incoming emails or to the emails actually deleted from the email server (via an "expunge" commande, clear the bin from a WebMail for example). You also have the ability to force the destruction of all deleted emails via EmailExpunge.
in the Outlook messaging software. This number of messages evolves according to the emails received or deleted by EmailDeleteMessage.
in the Notes messaging software. This number of messages evolves according to the emails received or deleted by EmailDeleteMessage.

Example

See additional examples

// Loop for reading all the incoming messages found
// in the mailbox of POP3 protocol
I is int
nbMSG is int = EmailNbMessage(UserName)
FOR I = 1 TO nbMSG
EmailReadMessage(UserName)
IF Email.Out <> True THEN
CU.NAME = Email.Sender
CU.MESSAGE_TXT = Email.Message
...
ELSE
Info("This message was deleted")
END
END

Syntax

Finding out the number of emails found on the email server (POP3 protocol) Hide the details

<Result> = EmailNbMessage(<POP3 session>)

<Result>: Integer

Number of messages received on the server at the beginning of current email session,
-1 if an error occurred. To get more details on the error, use ErrorInfo.

<POP3 session>: Character string

Identifies the user session (POP3). This parameter can correspond to:
the username that was used to start the email session (EmailStartSession).
a variable of type emailPOP3Session.

Finding out the number of emails found in the Outlook messaging software Hide the details

<Result> = EmailNbMessage(<Outlook messaging session>)

<Result>: Integer

Number of incoming messages found in the Outlook messaging software during the call to EmailNbMessage,
-1 if an error occurred. To get more details on the error, use ErrorInfo.

<Outlook messaging session>: Integer or emailOutlookSession variable

Identifier of the current email Outlook session . This parameter can correspond to:
an integer returned by EmailStartOutlookSession or OutlookStartSession.
a variable of type emailOutlookSession.

Finding out the number of emails found on the Notes messaging software Hide the details

<Result> = EmailNbMessage(<Notes messaging session>)

<Result>: Integer

Number of incoming messages found in the Notes messaging software during the call to EmailNbMessage,
-1 if an error occurred. To get more details on the error, use ErrorInfo.

<Notes messaging session>: emailNotesSession variable

Identifier of the current email Notes session .

Finding out the number of emails found on the email server (IMAP protocol) Hide the details

<Result> = EmailNbMessage(<IMAP messaging session>)

<Result>: Integer

Number of messages received on the server in the current email session,
-1 if an error occurred. To get more details on the error, use ErrorInfo.

<IMAP messaging session>: emailIMAPSession variable

Identifier of the current email session (IMAP). This identifier is returned by EmailStartSession.

Remarks

Deleted messages (POP3 protocol)

If a message was deleted by EmailDeleteMessage:

EmailNbMessage returns the number of messages on the email server before they are deleted.
the message numbers are not re-assigned.

Therefore, if four messages are found on the server at the beginning of session, these messages are numbered from 1 to 4. If message #1 is deleted:

EmailNbMessage used in the same session always returns 4.
Message 1 cannot be read by EmailReadMessage because the message does not exist anymore (only messages 2, 3 and 4 exist).

The message numbers are re-assigned during the next connection.

Deleted messages (Outlook messaging)

If a message was deleted by EmailDeleteMessage in the same email session, EmailNbMessage returns the actual number of messages in the inbox folder.

Deleted messages (IMAP protocol)

If a message was deleted by EmailDeleteMessage, this message is actually deleted from the session:

during the next "expunge" command (clear the bin from a WebMail for example).
when using EmailExpunge to force all the deleted emails to be destroyed.

New messages (POP3 protocol)

The POP3 protocol cannot be used to find out and manage the new messages received during the connection. To get the new messages, you must disconnect (EmailCloseSession) and reconnect (EmailStartSession).

Component: wd300com.dll