public class MailDistributionQueue extends Object
MailDistributionQueue
class allows administrators to create Mail
distribution queues.
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 |
---|
MailDistributionQueue() |
Modifier and Type | Method and Description |
---|---|
static Queue |
create()
Administration method creating and deploying a Mail distribution queue on the local server.
|
static Queue |
create(int serverId)
Administration method creating and deploying a Mail distribution queue on a given server.
|
static Queue |
create(int serverId,
String name)
Administration method creating and deploying a Mail distribution queue on a given server.
|
static Queue |
create(int serverId,
String name,
Properties props)
Administration method creating and deploying a Mail distribution queue 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 Queue 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 Queue 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 Queue 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 Queue 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 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 © 2023 ScalAgent D.T.. All rights reserved.