Email listeners provide the
Pega Platform
with the information it needs to route email incoming messages to an email service rule.
When an email listener routes a message that has files attached to it, the listener creates a page named
pyAttachmentPage
(of class
Data-ServiceMessage
) and puts the files on that page, by using the properties pyAttachNames and pyAttachValues. When you use the Email Wizard to configure inbound email, the generated service activity is configured to extract files from the pyAttachmentPage and attach them to the work object as work object attachments.
- In the Email Account Name field, enter the name of the email account
that the listener references for incoming and outgoing email. Complete one of the
following actions:
- Enter
Default if you want to configure the default account. For
case types, the Default email account sends all notifications and processes all cases
unless you configure an email account with the name of your work pool.
- Enter the name of your work pool if you want to configure an email account for
your application. For case types, this email account sends all notifications and
processes cases instead of the Default account.
Note: You can have only one email account in your application with your work pool name and
one account named Default. You should create one email account per work pool and use
Default for validation.
-
In the
Email Listener Name
field, enter the name of the email listener. Begin the name with a letter, and use only letters, numbers, the ampersand character, and hyphens.
-
In the
Folder Name
field, enter the name of the email folder that the listener monitors. Typically, this folder is INBOX.
-
In the
Service Package
field, enter the name of the service package to be deployed. Begin the name with a letter, and use only letters, numbers, and hyphens to form an identifier.
-
In the
Service Class
field, enter the service class name.
-
In the
Requestor User ID
field, enter the operator ID that the email service uses when it runs.
-
In the
Password
field, enter the password for the operator ID.
-
Select the
Disable Startup
check box if you want to disable the listener. The listener does not start when the
Pega Platform
starts, and you cannot start it from the System Management application.
When you select this check box, the
Blocked
field is selected on the
Properties
tab of the generated listener.