POP3 File Reader¶
The POP3 File Reader plugin checks for messages on a specified POP3 account, pulls the next unread message, extracts any attached files, and passes them on to the next Jitterbit processing step.
This plugin can be associated only with Private Agent Groups and is not available on the Jitterbit Cloud Agent Groups.
Plugins provided by Jitterbit are deprecated. See Deprecation and Support in Plugins.
The current version of the plugin is 1.0.7. Prior versions of the plugin may also be in use:
- 1.0.7: Special characters in an attachment name no longer cause errors.
- 1.0.5: Fixed the variable
delete_messageand added the variable
- 1.0.3: Prior version.
Download and Add the Plugin¶
The POP3 File Reader plugin is a standard Jitterbit plugin that is already available in the Management Console Plugins page and does not need to be downloaded or added to the organization.
If directed by Jitterbit Support, this plugin can be downloaded at the link provided below and added to the organization (see Add New Plugins in Customizations > Plug-ins).
Associate the Plugin with an Agent Group¶
The POP3 File Reader plugin must be associated with a Private Agent Group to make the plugin available on all agents in the group (see Associate Agent Groups in Customizations > Plug-ins).
The plugin is listed in the Management Console Plugins page with a display name of POP3 File Reader.
Set Variables and Use the Plugin in a Project¶
Refer to these topics for information about using plugins in a project:
Input Global Variables¶
These global variables can be set and used as input for the plugin. Variables marked as required must be provided.
| ||String||Required||Host name or IP address of the mail server to check. If not using an external mail server, use a value of |
| ||String||Required||User ID on the server.|
| ||String||Required||Password for the username on the server.|
| ||String||Optional||TCP port for connecting to the server. Normally this is |
| ||String||Optional||If |
| ||String||Optional||Location in which to save attachment files. Defaults to the temp directory as reported to Java by the OS at runtime ( |
| ||String||Optional||Prefix this string to the attachment file name. This is needed if you expect collisions in file names.|
| ||String||Optional||If |
| ||Boolean||Optional||If set to |
Output Global Variables¶
These global variables are output from the plugin:
| ||Integer||The number of attachments that were extracted.|
| ||String||The subject of the email that had the attachment.|
| ||String||The body of the email.|
| ||String||The file attachment name, where |
| ||String||The email address in the |
| ||Integer||The number of CC recipients.|
| ||String||The email address of CC recipient |