public class MailDistributionTopic extends Object
MailDistributionTopic
class allows administrators to create Mail
distribution topics.
Using an e-mail account, mail destinations allow you to forward Joram's messages to an external email account using SMTP.
Modifier and Type | Field and Description |
---|---|
static String |
MailDistribution
Class name of handler allowing to distribute messages to a SMTP mail server.
|
Constructor and Description |
---|
MailDistributionTopic() |
Modifier and Type | Method and Description |
---|---|
static Topic |
create()
Administration method creating and deploying a Mail distribution topic on the local server.
|
static Topic |
create(int serverId)
Administration method creating and deploying a Mail distribution topic on a given server.
|
static Topic |
create(int serverId,
String name)
Administration method creating and deploying a Mail distribution topic on a given server.
|
static Topic |
create(int serverId,
String name,
Properties props)
Administration method creating and deploying a Mail distribution topic on a given server.
|
public static final String MailDistribution
This handler is used by default to create MailDistributionQueue
,
the distribution.className property allows to declare an alternate handler using
different protocol or implementation.
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 topic.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 topic.name
- The name of the created topic.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 distribution destination:
Be careful this method use the static AdminModule connection.
serverId
- The identifier of the server where deploying the topic.name
- The name of the created topic.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.