GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Twelve — Internet Functions (continued)

POPGetMessage Function

Overview

The POPGetMessage function retrieves a message from the POP server in the form of a string.

Syntax/Parameters

Syntax

string = POPGetMessage ( handle hPOP, int position );

Parameters

hPOP

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

position

An int specifying the message position.

Return Value

Returns a string containing the MIME email message or an empty string on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

POPGetMessage retrieves the entire message from the server in the form of a MIME encoded string. The message will consist of a header and a series of boundary layers as the main body message in multiple formats and attachments. Depending on the mail server, the message can be very large (in excess of 20mb). The MIME Object can be used to extract information from the message using the MIMEOpen function. Because the strings can be very large, it is not advisable to store messages in a string array due to entry size limitations.

POPGetMessageHeader can be used to gather basic information about the message such as the sender and subject.

There are no provisions for virus or junk detection built into Legato. Most virus checking software should catch malicious code when the data is stored which may also interrupt the storage and mail process. However, it is up to the script to be the final stage of insuring that malicious code is not downloaded.

The message position is used to download the message. The highest position will be the latest message.

[no progress]?

Related Functions

MIMEOpen — Opens a specified MIME encoded string or file such as an MHT or EML file.

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

POPDeleteMessage — Deletes the email message at the specified position.

POPGetMessageCount — Returns the count of available email messages.

POPGetMessageHeader — Returns the header portion of a specified email message.

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

POPGetMessageIDList — Returns an array of email message positions and server IDs.

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 12/16/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.