EmailMessageLength (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

EmailReadMessageHeader

EmailReadNext

EmailReadNextHeader

EmailReadPrevious

EmailReadPreviousHeader

EmailStartIMAPSession

EmailStartNotesSession

EmailStartOutlookSession

EmailStartPOP3Session

EmailStartSMTPSession

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 handling an email (reading an email for example), a session must be started by EmailStartSession.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 22 and later

This function is now available in Android Widget mode.

This function is now available for Android applications.

New in version 22

This function is now available in Android Widget mode.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available for Android applications.

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 user name to start the email session (EmailStartSession).
Versions 15 and later
a emailPOP3Session variable.
New in version 15
a emailPOP3Session variable.
a emailPOP3Session variable.
Versions 15 and later
an emailIMAPSession variable.
New in version 15
an emailIMAPSession variable.
an emailIMAPSession variable.
Versions 15 and later
The emailPOP3Session and emailIMAPSession variables are not available.
New in version 15
The emailPOP3Session and emailIMAPSession variables are not available.
The 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 : wd260com.dll