public class MailAcquisitionTopic extends Object
MailAcquisitionTopic
class allows administrators to create Mail
acquisition topics.
Using an e-mail account, mail acquisition destinations allow you to import emails from this external account using POP and turn them into Joram's JMS messages.
Modifier and Type | Field and Description |
---|---|
static String |
MailAcquisition
Class name of handler allowing to acquire messages from a POP mail provider.
|
Constructor and Description |
---|
MailAcquisitionTopic() |
Modifier and Type | Method and Description |
---|---|
static Topic |
create()
Administration method creating and deploying a mail acquisition topic on the local server.
|
static Topic |
create(int serverId)
Administration method creating and deploying a mail acquisition topic on a given server.
|
static Topic |
create(int serverId,
String name)
Administration method creating and deploying a mail acquisition topic on a given server.
|
static Topic |
create(int serverId,
String name,
Properties props)
Administration method creating and deploying a mail acquisition topic on a given server.
|
public static final String MailAcquisition
This handler is used by default to create MailAcquisitionTopic
,
the acquisition.className property allows to declare an alternate handler using
different protocol (IMAP for example).
public static Topic create() throws ConnectException, AdminException
The request fails if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String, Properties)
public static Topic create(int serverId) throws ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
serverId
- The identifier of the server where deploying the queue.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String, Properties)
public static Topic create(int serverId, String name) throws ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
serverId
- The identifier of the server where deploying the queue.name
- The name of the created queue.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String, Properties)
public static Topic create(int serverId, String name, Properties props) throws ConnectException, AdminException
A set of properties is used to configure the acquisition destination:
Be careful this method use the static AdminModule connection.
serverId
- The identifier of the server where deploying the queue.name
- The name of the created queue.props
- A Properties object containing all needed parameters.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.Copyright © 2019 ScalAgent D.T.. All rights reserved.