CNS Plug-ins

Porting Guide

Porting Older Database to use new POP3it Pro Functions

This document is for users who have developed databases using the Classic version of POP3it and wish to upgrade to the new POP3it Pro functions. By updating your databases to the new functions, you will be able to take full advantage of the new features.

Notes:

As of v5.1.0, Backward Compatibility has been removed from the plug-in.

Note
The backward compatibility option does not work under all versions of FileMaker.

Mac
Works: FileMaker 7–13
Does not Work: FileMaker 14 (32-bit and 64-bit), FileMaker Pro 11.0v1 (update to 11.0v4)

Windows
Works: FileMaker 7–13, FileMaker 14 32-bit
Does not Work: FileMaker 14 64-bit

Example

Assume you have a calculation like the following that uses the Old Style Register function.

External(“POP3-Register”, “John|Doe|123–4567–890”)

Find the “POP3-Register” function in the left column of the list at the end of this page. The New Style equivalent is the “POP3it_Register” function, so find that function in the Function Reference to see how it is used.

POP3it_Register ( FirstName ; LastName ; LicenseKey ; Option )

Next, we need to determine what parameters we are using in the Old Style function. To do so, find the Old Style function in the Classic Plug-in Function Browser. From the Classic Plug-in Function Browser, we see the function looks like:

External(“POP3-Register”, “First Name|Last name|Serial Number”)

This tells us that the “John” value of our Old Style Function is the “First Name” parameter, the “Doe” value is the “Last Name” parameter, and “123–4567–890” is the Serial Number/LicenseKey. Now we plug these values into the New Style function, which would look like:

POP3it_Register ( “John”; “Doe” ; “123–4567–890” )

Since we did not need the optional “Option” parameter, it was omitted from the New Style function. Be sure to check the Function Reference to see what each parameter does and which are optional.

Conversion Chart

Below you will find an alphabetical list of old-style functions with their new-style equivalents.

Old-Style to New-Style
Old-StyleNew-Style
POP3-AcquireFirstUse POP3it_Adv_GoToMessage with the “Which” parameter set to First.
POP3-AcquireNextUse POP3it_Adv_GoToMessage with the “Which” parameter set to Next.
POP3-APOPThis value is set for each account using the Account Configuration Dialog (POP3it_ConfigureAccount) or with the POP3it_Adv_SetAccountOption function using “AuthType” as the “OptionName” parameter.
POP3-AttachPathThis value is set for each account using the Account Configuration Dialog (POP3it_ConfigureAccount) or with the POP3it_Adv_SetAccountOption function using “AttachPath” as the “OptionName” parameter.
POP3-AutoCheckEmailThis value is set for each account using the Account Configuration Dialog (POP3it_ConfigureAccount) or with the POP3it_Adv_SetAccountOption function using “AutoCheckScript” as the “OptionName” parameter. Note, you will also need to set the AutoCheck and AutoCheckInterval options for each account in order to use the AutoCheckScript option.
POP3-AutoDeleteThis value is set for each account using the Account Configuration Dialog (POP3it_ConfigureAccount) or with the POP3it_Adv_SetAccountOption function using “AutoDelete” as the “OptionName” parameter. Note, you will also need to set the AutoDeleteInterval option for each account in order to use the AutoDelete option.
POP3-CloseConnectionPOP3it_Adv_Disconnect. Note, the POP3-CloseConnection function was removed in the Classic POP3it v3.0 plug-in and renamed POP3-Disconnect. The POP3-CloseConnection function does not work with POP3it Pro’s backward compatibility option.
POP3-ConnectPOP3it_Adv_Connect
POP3-CurrAllPOP3it_Adv_GetFullSource. Note, POP3it_Adv_GetFullSource does not download attachments like the POP3-CurrAll function did. Use the POP3it_Adv_SaveAttachment function to download attachments.
POP3-CurrAttachPOP3it_Adv_SaveAttachment
POP3-CurrBodyPOP3it_Adv_GetBody
POP3-CurrBodyTypePOP3it_Adv_HasBodyType
POP3-CurrDatePOP3it_Adv_GetDate
POP3-CurrDeletePOP3it_Adv_Delete
POP3-CurrFromUse POP3it_Adv_GetHeader with the parameter “From”.
POP3-CurrHeadPOP3it_Adv_GetHeader. Note, the POP3-CurrHead function was removed in the Classic POP3it v3.0 plug-in. The POP3-CurrHead function was combined with the POP3-CurrHeader function. The POP3-CurrHead function does not work with POP3it Pro’s backward compatibility option.
POP3-CurrHeaderPOP3it_Adv_GetHeader
POP3-CurrHTMLExportNo Equivalent. When POP3it_Adv_GetBody is used to download the HTML Body, the associated inline images are extracted to the main attachment path, and then the HTML can be exported using FileMaker’s Export Field Contents script step. Alternatively, the HTML can be rendered in a Web Viewer object without needing to export it to a file.
POP3-CurrSizePOP3it_Adv_GetSize
POP3-CurrSubjectUse POP3it_Adv_GetHeader with the parameter “Subject”.
POP3-CurrToUse POP3it_Adv_GetHeader with the parameter “To”.
POP3-CurrUniqueIDPOP3it_Adv_GetUniqueID
POP3-DeleteAllPOP3it_Adv_DeleteAll
POP3-DisconnectPOP3it_ConfigureAccount
POP3-DlgAttachPathThis value is set for each account using the Account Configuration Dialog (POP3it_ConfigureAccount) or with the POP3it_Adv_SetAccountOption function using “AttachPath” as the “OptionName” parameter. The POP3it_Adv_SetAccountOption function could be used in conjunction with POP3it_File_SelectFolderWithDialog to replicate the behavior of the POP3-DlgAttachPath function.
POP3-DlgHTMLExportPathNo Equivalent. The Pro plug-in does not export the HTML Body like the Classic plug-in. See the POP3-CurrHTMLExport function for more information.
POP3-HideStatusUse POP3it_StatusWindow with the parameter “Hide”.
POP3-HostThis value is set for each account using the Account Configuration Dialog (POP3it_ConfigureAccount) or with the POP3it_Adv_SetAccountOption function using “Host” as the “OptionName” parameter.
POP3-HTMLExportPathNo Equivalent. The Pro plug-in does not export the HTML Body like the Classic plug-in. See the POP3-CurrHTMLExport function for more information.
POP3-MoveStatusUse POP3it_StatusWindow with the parameter “Move” as the “Action” parameter, and the desired position coordinates as the “Left” and “Top” parameters.
POP3-OpenConnectionPOP3it_Adv_Connect. Note, the POP3-OpenConnection function was removed in the Classic POP3it v3.0 plug-in and renamed POP3-Connect. The POP3-OpenConnection function does not work with POP3it Pro’s backward compatibility option.
POP3-PasswordThis value is set for each account using the Account Configuration Dialog (POP3it_ConfigureAccount) or with the POP3it_Adv_SetAccountOption function using “Password” as the “OptionName” parameter.
POP3-PathToDBUse POP3it_File_GetPath with the parameter “Database”.
POP3-PortThis value is set for each account using the Account Configuration Dialog (POP3it_ConfigureAccount) or with the POP3it_Adv_SetAccountOption function using “Port” as the “OptionName” parameter.
POP3-RegisterPOP3it_Register
POP3-ShowStatusUse POP3it_StatusWindow with the parameter “Show”.
POP3-UnDeleteAllPOP3it_Adv_UndeleteAll
POP3-UsernameThis value is set for each account using the Account Configuration Dialog (POP3it_ConfigureAccount) or with the POP3it_Adv_SetAccountOption function using “Username” as the “OptionName” parameter.
POP3-VersionPOP3it_Version or POP3it_VersionAutoUpdate