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

Table of Contents	< < Previous	Next >>

 

Chapter Twelve — Internet Functions (continued)

POPDeleteMessage Function

Overview

The POPDeleteMessage function marks a message at a specified position as deleted.

Syntax/Parameters

Syntax

int = POPDeleteMessage ( 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 an int as ERROR_NONE (0) or a formatted error code on failure.

Remarks

Actual deletion of the message will not be completed until the proper closing of the connection using the CloseHandle function (or default close). Deleting messages will remove the message from the mailbox. It is up to the server to permanently delete the message.

Message positions can be determined using the POPGetMessageIDList and POPGetMessageSizeList functions. Once deleted, the specified message position for the connection session becomes invalid. If the POPGetMessageIDList or POPGetMessageSizeList functions are called again, the entry will be empty or zero respectively.

If the script is the sole manager of the mailbox, it is advisable to remove messages after they have been downloaded and processed.

Related Functions

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

POPGetMessageCount — Returns the count of available email messages.

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.