Functions
There are two ways to view the POP3it Pro function reference, the Function Reference below, and the Function Reference Browser in a new window.
Function ReferenceThe Function Reference is a complete reference for POP3it Pro functions. Click on a function title to view more information which includes the function description, parameter information, example usage and more. | Function Reference Browser![]() The Function Reference Browser offers better navigation for the POP3it Pro functions, you can Launch Function Browser in a new window. |
Function Reference
- POP3it_Adv_AddAccount
This function adds a new account with the specified name. You can create accounts within the plug-in that contain different email account information. After creating accounts, you can use the... read more
- POP3it_Adv_Connect
This function opens a connection to the POP3 mail server set in the account you specify. After using this function, use POP3it_Adv_GoToMessage to set the current email, and then you can use the... read more
- POP3it_Adv_ConnectFile
This function opens a "connection" 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... read more
- POP3it_Adv_Delete
This function Deletes the current email from the server. Note: This function does not Delete the emails immediately, but instead just "marks" them for Deletion. The mail server does not actually... read more
- POP3it_Adv_DeleteAll
This function Deletes All the email from the mail server you are connected to. Note: This function does not Delete the emails immediately, but instead just "marks" them for Deletion. The mail server... read more
- POP3it_Adv_Disconnect
This function closes the current connection to a mail server or to a file.... read more
- POP3it_Adv_GetAccountOption
This function retrieves specific options out of the account you specify. The following is a list of the valid option names you can retrieve: AttachPath - A Path to a folder on your hard drive... read more
- POP3it_Adv_GetAttachment
This function returns an Attachment from the current email as a "Stored" Container object. If you specify True for the optional ByRef parameter, POP3it Pro will save the Attachment to the hard drive... read more
- POP3it_Adv_GetAttachmentCount
This function returns the number of Attachments in the current email. If the GetRefInline parameter is set to True, this function will return the number of Inline Images Referenced by the HTML in the... read more
- POP3it_Adv_GetAttachmentFileName
This function returns the File Name of an Attachment in the current email. If the GetRefInline parameter is set to True, it will return the File Name of Inline Images Referenced in the... read more
- POP3it_Adv_GetBody
This function returns the Body or the Content of the current email. If you do not specify a Body Type, POP3it Pro will return the most fitting type to you. Otherwise, if you specify "Text" it will... read more
- POP3it_Adv_GetDate
This function returns the Date the current email was sent as a Timestamp, adjusted for your local Time Zone. If you specify True for the DontLocalize parameter, the plug-in will not adjust the Date... read more
- POP3it_Adv_GetFullSource
This function returns the entire, unmodified source of the current email exactly as it was downloaded from the mail server. It's possible to store this and only this for any email you download and... read more
- POP3it_Adv_GetHeader
This function returns either the entire Header portion of the current email, or a specific Header from the current email. You can specify any Header Name from the email such as "To", "From", or... read more
- POP3it_Adv_GetMessageCount
This function returns the number of emails in the Account or File you are connected... read more
- POP3it_Adv_GetSize
This function returns the Size in bytes of the current... read more
- POP3it_Adv_GetUniqueID
This function returns the Unique Identifier of the current email as provided by the mail server. Depending on the mail server, this Identifier could be unique on a global scale, a server scale, or... read more
- POP3it_Adv_GoToMessage
This function tells POP3it Pro to set the current email to one of the emails on the mail server or in the mail file. Valid values for the Which parameter are as follows: "First" - Sets the... read more
- POP3it_Adv_HasBodyType
This function will tell you whether or not the current email has a specific Body Type. Valid values for the BodyType parameter are "Text", "HTML", and... read more
- POP3it_Adv_IsConnected
This function will tell you whether or not you are currently connected to a mail server or a... read more
- POP3it_Adv_RemoveAccount
This function removes an Account with the specified name. You can also remove Accounts from the Account Configuration Dialog available from the POP3it_ConfigureAccount... read more
- POP3it_Adv_SaveAttachment
This function extracts one or all Attachments out of the current email and saves it/them to the hard drive in the Account's Attachment Path. If you do not specify the Number or if you specify 0, all... read more
- POP3it_Adv_SetAccountOption
This function sets specific options in the Account you specify. The following is a list of the valid option names you can specify: AttachPath - A Path to a folder on your hard drive where POP3it... read more
- POP3it_Adv_UndeleteAll
This function resets all the emails on the server that were marked for Deletion. If you call this function, POP3it Pro will not Delete any of the emails on disconnect unless you mark some of them... read more
- POP3it_CheckAccount
This function is the equivalent of the "Check Email" or "Get New Messages" button in a normal email client. It handles the entire connection and downloading process, inserting records into the... read more
- POP3it_CheckFile
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... read more
- POP3it_Configure
Calling this function with no parameters will open the POP3it Pro Configuration Dialog. You can optionally open to a specific tab by specifying the name of the tab as the "Option" parameter. This... read more
- POP3it_ConfigureAccount
This function opens the Account Configuration Dialog for setting up an Account. If you do not specify an Account Name, the dialog will allow you to edit any of the currently defined Accounts as well... read more
- POP3it_DisplayMessage
This function will take the Full Source of an Email and present a Message Window to the user displaying that Email in much the same way a normal Email Client displays an Email to a user. This... read more
- POP3it_File_Copy
You can use this function to copy a file to a new... read more
- POP3it_File_CreateFolder
This function creates a Folder or Directory on your hard drive.... read more
- POP3it_File_Delete
You can use this function to delete a... read more
- POP3it_File_DeleteFolder
This function Deletes an empty Folder from your hard drive. (The Folder must be empty for this to... read more
- POP3it_File_Exists
This function will check to see if a file... read more
- POP3it_File_Export
This function will export a file from a container to a specified path. POP3it Pro will use the name of the file in the container unless you specify a name with the "SaveAs"... read more
- POP3it_File_FolderExists
This function tests for the Existence of a Folder on your hard drive.... read more
- POP3it_File_GetPath
You can use the POP3it_File_GetPath function to retrieve a variety of paths including: Database - The Path to the Folder containing the Current Database. FileMaker - The Path to the Folder... read more
- POP3it_File_Import
This function returns a "Stored" Container object of the File you... read more
- POP3it_File_Move
You can use this function to move a file to a new... read more
- POP3it_File_Rename
You can use this function to rename a... read more
- POP3it_File_SelectFileWithDialog
This function will display a file chooser dialog. You can set the location to open the dialog to, as well as display a custom prompt... read more
- POP3it_File_SelectFolderWithDialog
This function will display a folder chooser dialog. You can set the location to open the dialog to, as well as display a custom prompt... read more
- POP3it_File_Size
This function returns the size of a... read more
- POP3it_GetAccountNames
This function returns the Names of all currently defined... read more
- POP3it_QuoteMessage
This function will take a block of Text and "Quote" it like an Email Client "Quotes" Text when you reply to an email. In other words, it will add "> " at the beginning of each line to indicate... read more
- POP3it_Register
You can use this function to Register the plug-in from a script instead of through the Configuration Dialog. This is useful when the plug-in is being distributed to many computers, allowing you to... read more
- POP3it_StatusWindow
This function Shows, Hides, or Moves the Status Window. The first parameter tells POP3it Pro what to do with the StatusWindow. Specify "Show" to Show the StatusWindow, "Hide" to Hide the Status... read more
- POP3it_Version
This function returns the current version of POP3it Pro. This function is useful for testing whether or not the plug-in is installed and enabled. If you call this function and a question mark ("?")... read more
- POP3it_VersionAutoUpdate
This function returns an Auto Update friendly Version number of POP3it Pro. The format of this version number is always exactly 8 digits long. The first two digits represent the major version of the... read more
- Reference: Table and Field Names
Below is a list of all the available fields that can be added to the POP3it_Messages and POP3it_Attachments tables for use with the POP3it_CheckAccount function. The POP3it_Messages and... read more
