GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Twelve — Internet Functions (continued)

POPGetMessageIDList Function

Overview

The POPGetMessageIDList function returns an array of message positions and IDs for the available messages.

Syntax/Parameters

Syntax

string[] = POPGetMessageIDList ( handle hPOP );

Parameters

hPOP

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

Return Value

Returns an array of string 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 and ID. Position 0 is invalid and not used by POP and therefore its message size will always be zero.

Each position will indicate the server’s ID for the mail message. If the entry is empty, 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).

Message ID format is set by the server but is supposed to be a hash or unique combination of hash and time stamp to be used by clients to identify a specific message.

The last entry in the list is the latest message.

Related Functions

POPConnect — Connects to a specified mail server using the provided credentials and optional port number.

POPDeleteMessage — Deletes the email message at the specified position.

POPGetMessage — Returns the MIME encoded email message at the specified position.

POPGetMessageCount — Returns the count of available email messages.

POPGetMessageID — Returns the server’s message ID associated with a specified email message.

POPGetMessageSizeList — Returns an array of email message positions and sizes.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.