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_VersionAutoUpdate

POP3it_CheckAccount

NamePOP3it_CheckAccount
Description

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 POP3it_Messages and POP3it_Attachments tables (which are created by the plug-in if they do not exist). It also handles deleting email off the server either when it finds it is no longer in the database or after a specified number of days (depending on if you have those options turned on for the Account). The first parameter is the Name of the Account to Check. If you do not specify an Account Name or if you specify “All”, POP3it Pro will download email for All defined Accounts. You can also specify a return- or paragraph mark-separated list of account names to Check. If you specify “Dialog”, POP3it Pro will present the user with a Dialog to choose one or more Accounts to Check. The second parameter will specify whether or not to Show the Status Window as it downloads 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 downloading email because there is a Cancel button on the Status Window which will allow you to cancel out of a lengthy email download process.

Return TypeText
FormatPOP3it_CheckAccount ( AccountName ; ShowStatus )
Optional Parameters
AccountName

The Name of the Account to download email from. If this parameter is empty or if you specify “All”, POP3it Pro will download email for All defined Accounts. This can also be a return- or paragraph mark-separated list of Account Names. If this parameter is “Dialog”, POP3it Pro will present the user with a Dialog to choose which Account to check.

ShowStatus

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

Examples
Example 1

Connects to and downloads email for All defined Accounts.

POP3it_CheckAccount
Example 2

Presents the user with a Dialog to choose which Account to Check and tells POP3it Pro to not show the Status Window.

POP3it_CheckAccount( "Dialog" ; False )
Example 3

Connects to and downloads email for the Account specified in the "Account" field of the "Email" table.

POP3it_CheckAccount( Email::Account )