Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter TwelveInternet Functions (continued)

POPGetMessageSizeList Function

Overview

The POPGetMessageSizeList function returns an array of message positions and sizes for the available messages.

Syntax/Parameters

Syntax

int[] = POPGetMessageSizeList ( handle hPOP );

Parameters

hPOP

A handle to a POP3 connection established with the POPConnect function.

Return Value

Returns an array of int values or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The positions in the array represent the message positions. Position 0 is invalid and not used by POP and therefore the message size will always be zero.

Each position will indicate the raw size of the encoded message. If the size is zero, the message has been deleted or is no longer available. Use the ArrayGetAxisDepth function to determine how many message positions are available (less 1 since the zeroth position is invalid).

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic