The installation takes place via 'hot deployment'. See the documentation of the Deploy Swiftlet for further information.
The configuration of the JavaMail Bridge Extension Swiftlet is defined within the element
<swiftlet name="xt$javamail" .../>
of the router's configuration file. One can use the SwiftMQ Exlorer or CLI for configuration as well. They both save into that file.
Element List "outbound-bridges", Parent Element: "swiftlet"
Outbound Bridges. This element list contains zero or more "outbound-bridge" elements with this template definition:
Definition
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| name | java.lang.String | Yes | Name of this Outbound Bridge |
| enabled | java.lang.Boolean | No | Enables/Disables this Bridge |
| smtp-host | java.lang.String | Yes | DNS Name of the SMTP Host |
| error-policy | java.lang.String | Yes | How to handle errorneous Input Messages |
| error-queue | java.lang.String | Yes | Name of the Error Queue for this Bridge |
| retryinterval | java.lang.Long | No | Retry Interval (ms) for Re-Connect |
| source-name | java.lang.String | Yes | Name of the Source |
| source-type | java.lang.String | No | Type of the Source |
| transformer-class | java.lang.String | No | Name of the Transformer Class |
Values
| Attribute | Values |
|---|---|
| enabled | Default: false |
| smtp-host | |
| error-policy | Choice: delete error_queue retry Default: error_queue |
| error-queue | Default: javamail-outbound-error |
| retryinterval | Default: 60000 |
| source-name | |
| source-type | Choice: queue topic Default: queue |
| transformer-class | Default: com.swiftmq.extension.javamail.outbound.TextMessageTransformer |
Element List "header-translations", Parent Element: "outbound-bridge"
Header Translations. This element list contains zero or more "header-translation" elements with this template definition:
Definition
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| name | java.lang.String | Yes | Name of this Header Translation |
| message-property | java.lang.String | Yes | Message Property Name |
| mail-header | java.lang.String | Yes | Mail Header Name |
Values
| Attribute | Values |
|---|---|
| message-property | |
| mail-header | Default: from |
Element List "default-headers", Parent Element: "outbound-bridge"
Default Headers. This element list contains zero or more "default-header" elements with this template definition:
Definition
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| name | java.lang.String | Yes | Name of this Default Header |
| value | java.lang.String | Yes | Value |
Values
| Attribute | Values |
|---|---|
| value |
Element List "inbound-bridges", Parent Element: "swiftlet"
Inbound Bridges. This element list contains zero or more "inbound-bridge" elements with this template definition:
Definition
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| name | java.lang.String | Yes | Name of this Inbound Bridge |
| enabled | java.lang.Boolean | No | Enables/Disables this Bridge |
| error-policy | java.lang.String | Yes | How to handle errorneous Input Mails |
| mail-host | java.lang.String | Yes | DNS Name of the Mail Host |
| mail-host-port | java.lang.Integer | Yes | Port Number (Protocol Dependent) |
| mail-host-account-name | java.lang.String | No | Mail Host Account Name |
| mail-host-account-password | java.lang.String | No | Mail Host Account Password |
| mail-host-account-folder | java.lang.String | No | Mail Host Account Folder |
| protocol | java.lang.String | No | Protocol |
| retrieveinterval | java.lang.Long | Yes | Retrieve Interval (ms) |
| retrieve-max-messages | java.lang.Integer | Yes | Max. Messages to process per Interval |
| target-name | java.lang.String | Yes | Name of the Target |
| target-type | java.lang.String | No | Type of the Target |
| target-message-deliverymode | java.lang.String | No | Target Message Delivery Mode |
| target-message-ttl | java.lang.Long | No | Target Message Time To Live |
| target-message-priority | java.lang.Integer | No | Target Message Priority |
| target-respect-flowcontrol | java.lang.Boolean | No | Respect Flow Control of the Target |
| transformer-class | java.lang.String | No | Name of the Transformer Class |
| transformer-max-message-size | java.lang.Integer | No | Max Message Size (KB) |
Values
| Attribute | Values |
|---|---|
| enabled | Default: false |
| error-policy | Choice: delete flag Default: flag |
| mail-host | |
| mail-host-port | Default: 110 |
| mail-host-account-name | |
| mail-host-account-password | |
| mail-host-account-folder | Default: INBOX |
| protocol | Choice: pop3 imap Default: pop3 |
| retrieveinterval | Default: 600000 |
| retrieve-max-messages | Default: 10 |
| target-name | |
| target-type | Choice: queue topic Default: queue |
| target-message-deliverymode | Choice: persistent non-persistent Default: persistent |
| target-message-ttl | Min: 0 Default: 0 |
| target-message-priority | Min: 0 Max: 9 Default: 4 |
| target-respect-flowcontrol | Default: true |
| transformer-class | Default: com.swiftmq.extension.javamail.inbound.TextMessageTransformer |
| transformer-max-message-size | Min: -1 Default: 1024 |
Element List "property-translations", Parent Element: "inbound-bridge"
Property Translations. This element list contains zero or more "property-translation" elements with this template definition:
Definition
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| name | java.lang.String | Yes | Name of this Property Translation |
| message-property | java.lang.String | Yes | Message Property Name |
| mail-header | java.lang.String | Yes | Mail Header Name |
Values
| Attribute | Values |
|---|---|
| message-property | |
| mail-header | Default: from |
Element List "default-properties", Parent Element: "inbound-bridge"
Default Properties. This element list contains zero or more "default-property" elements with this template definition:
Definition
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| name | java.lang.String | Yes | Name of this Default Property |
| value | java.lang.String | Yes | Value |
Values
| Attribute | Values |
|---|---|
| value |
CLI Commands During Deployment
This Swiftlet performs the following CLI commands during deployment:
cc /sys$threadpool/pools
new javamail.outbound
new javamail.inbound
cc /sys$threadpool/pools/javamail.outbound/threads
new extension.xt$javamail.outbound.%
cc /sys$threadpool/pools/javamail.inbound/threads
new extension.xt$javamail.inbound.%
CLI Commands During Undeployment
This Swiftlet performs the following CLI commands during undeployment:
cc /sys$threadpool/pools
delete javamail.outbound
delete javamail.inbound