Skip to end of metadata
Go to start of metadata

Introduction

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.

Input Global Variables

These global variables can be set and used as input for the plugin. Variables marked as required must be provided.

NameTypeRequiredDescription

host

String

Required

Host name or IP address of the mail server to check. If not using an external mail server, use a value of localhost.

username

String

Required

User ID on the server.

password

String

Required

Password for the username on the server.

port

String

Optional

TCP port for connecting to the server. Normally this is 110 for non-encrypted, or 995 for SSL. Specify a custom value as needed. Default value is 110.

trust

String

Optional

If 1, all hosts will be trusted and certificates will not be checked. This option also forces the use of com.sun.mail.util.MailSSLSocketFactory as the SSLSocketFactory. Available only in versions 1.0.5 and later.

basedir

String

Optional

Location in which to save attachment files. Defaults to the temp directory as reported to Java by the OS at runtime (java.io.tmpdir).

attachment_prefix

String

Optional

Prefix this string to the attachment file name. This is needed if you expect collisions in file names.

ssl

String

Optional

If 1, then an encrypted connection will be attempted. Make sure to set the port property appropriately. Default value is 0.

delete_message

Boolean

Optional

If set to true, the fetched email will be marked as deleted. Default value is false. Available only in versions 1.0.5 and later.

Output Global Variables

These global variables are output from the plugin:

NameTypeDescription
number_of_attachmentsIntegerThe number of attachments that were extracted.
subjectStringThe subject of the email that had the attachment.
bodyStringThe body of the email.
fileXString

The file attachment name, where X is a number from 1 to number_of_attachments.

fromString

The email address in the From field of the message.

number_of_ccsIntegerThe number of CC recipients.
ccXString

The email address of CC recipient X, where X is a number from 1 to number_of_ccs.

Versions

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_message and added the variable trust.
  • 1.0.3: Prior version.