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

EmailMessageLength (Function)

In french: EmailTailleMessage

Calculates the size of specified message (without loading the message). The size corresponds to the space taken by the email in the mailbox (size of message and attached files).

This function can be used with the POP3 and IMAP protocols.

Reminder Before manipulating an Email (e.g. reading it), you need to open a session using the EmailStartSession function.

Example

// Read the emails whose size does not exceed nMaxSize 
I is int
FOR I = 1 TO EmailNbMessage(UserName)
	IF EmailMessageLength(UserName, I) < nMaxSize THEN
		// Read and process the message
		ReadMessage()
	ELSE
		Info("The size of the email exceeds the maximum size and it cannot be read")
	END
END

Syntax

<Result> = EmailMessageLength(<Session> [, <Message number>])

<Result>: Integer

Total size (in bytes) of email (message and attached files).

<Session>: Character string, or emailPOP3Session or emailIMAPSession variable

Identifies the user session. Corresponds to:
a character string used as username to start the email session (EmailStartSession).
a variable of type emailPOP3Session.
a variable of type emailIMAPSession.
emailPOP3Session and emailIMAPSession variables are not available.

<Message number>: Optional integer

Identifies the message whose size must be calculated. If this parameter is not specified, <Result> returns the size of the current email.

Component: wd300com.dll