Product Logo

POP3it Pro

Email downloading made easy.

Functions
FunctionPOP3it_Adv_AddAccount
FunctionPOP3it_Adv_Connect
FunctionPOP3it_Adv_ConnectFile
FunctionPOP3it_Adv_Delete
FunctionPOP3it_Adv_DeleteAll
FunctionPOP3it_Adv_Disconnect
FunctionPOP3it_Adv_GetAccountOption
FunctionPOP3it_Adv_GetAttachment
FunctionPOP3it_Adv_GetAttachmentCount
FunctionPOP3it_Adv_GetAttachmentFileName
FunctionPOP3it_Adv_GetBody
FunctionPOP3it_Adv_GetDate
FunctionPOP3it_Adv_GetFullSource
FunctionPOP3it_Adv_GetHeader
FunctionPOP3it_Adv_GetMessageCount
FunctionPOP3it_Adv_GetSize
FunctionPOP3it_Adv_GetUniqueID
FunctionPOP3it_Adv_GoToMessage
FunctionPOP3it_Adv_HasBodyType
FunctionPOP3it_Adv_IsConnected
FunctionPOP3it_Adv_RemoveAccount
FunctionPOP3it_Adv_SaveAttachment
FunctionPOP3it_Adv_SetAccountOption
FunctionPOP3it_Adv_UndeleteAll
FunctionPOP3it_CheckAccount
FunctionPOP3it_CheckFile
FunctionPOP3it_Configure
FunctionPOP3it_ConfigureAccount
FunctionPOP3it_DisplayMessage
FunctionPOP3it_File_Copy
FunctionPOP3it_File_Delete
FunctionPOP3it_File_Exists
FunctionPOP3it_File_Export
FunctionPOP3it_File_Import
FunctionPOP3it_File_Move
FunctionPOP3it_File_Read
FunctionPOP3it_File_Rename
FunctionPOP3it_File_SelectWithDialog
FunctionPOP3it_File_Size
FunctionPOP3it_File_Timestamp
FunctionPOP3it_File_Write
FunctionPOP3it_Folder_Create
FunctionPOP3it_Folder_Delete
FunctionPOP3it_Folder_Exists
FunctionPOP3it_Folder_GetPath
FunctionPOP3it_Folder_List
FunctionPOP3it_Folder_Rename
FunctionPOP3it_Folder_SelectWithDialog
FunctionPOP3it_GetAccountNames
FunctionPOP3it_QuoteMessage
FunctionPOP3it_Register
FunctionPOP3it_StatusWindow
FunctionPOP3it_Version
FunctionPOP3it_VersionNumber

POP3it_CheckFile

NamePOP3it_CheckFile
Description

This function is just like the POP3it_CheckAccount function, except instead of connecting to a mail server, it connects to either a file on your hard drive that contains one or more emails in the mbox format, an Apple Mail 2.x mailbox folder, or the Full Source of an email from a field in your database. The first parameter is a Path to the email file to import or the Full Source of an email. The optional AttachPath parameter allows you to specify where to Save Attachments on your hard drive. If you do not specify this parameter, POP3it Pro will not Save out any Attachments. The Show Status parameter will specify whether or not to Show the Status Window as it imports email. By default POP3it Pro will Show the Status Window when downloading email, but if you do not want it to do that, you can specify False for this parameter. If the Status Window is already shown before this function is called, the ShowStatus parameter is ignored. It’s always a good idea to have the Status Window open while importing email because there is a Cancel button on the Status Window which will allow you to cancel out of a lengthy email import process. The AltMessageTable and AltAttachTable parameters allow you to specify Alternate names for the POP3it_Messages and POP3it_Attachments tables, while the AltFieldNames parameter allows you to specify a return- or paragraph mark-separated list of <Original Field Name>=<New Field Name> pairs describing Alternate Field Names for POP3it Pro to use when inserting records into the Messages and Attachments tables. (An example of the Alternate Field Names would be “POP3it_Body=EmailBody” where “POP3it_Body” is the original field name that POP3it would use to store the Body of an Email and “EmailBody” is the name of the actual field in the database that should be used.) Note: You should make sure the other Email Client is closed before Connecting to one of its mailbox files.

Return TypeText
FormatPOP3it_CheckFile ( PathOrFullSource ; AttachPath ; ShowStatus ; AltMessageTable ; AltAttachTable ; AltFieldNames )
Required Parameters
PathOrFullSource

The Path to a Message File or the Full Source of a Message.

Optional Parameters
AttachPath

The Path to a folder on the hard drive to store all Attachments. If this parameter is empty, POP3it Pro will not Save out the Attachments.

ShowStatus

If True, POP3it Pro will Show the Status Window while downloading email if it’s not already open. The default is True.

AltMessageTable

An Alternate name for the POP3it_Messages table.

AltAttachTable

An Alternate name for the POP3it_Attachments table.

AltFieldNames

A return- or paragraph mark-separated list of <Original Field Name>=<New Field Name> pairs describing Alternate Field Names for POP3it Pro to use when inserting records into the Messages and Attachments tables.

Examples
Example 1

Imports all the email in an Apple Mail 2.x Inbox folder.

POP3it_CheckFile( "~/Library/Mail/POP-me@pop.mydomain.com/INBOX.mbox" )
Example 2

Imports an email specified in the "FullSource" field of the "Email" table, without Saving out Attachments, into a Messages table named "MyEmail" where the From Header should be put in a field named "FromEmail" and the Body should be put in a field named "Body".

POP3it_CheckFile( Email::FullSource ; "" ; True ; "MyEmail" ; "" ; "POP3it_Header_From=FromEmail¶POP3it_Body=Body" )