Installation

The installation takes place via 'hot deployment'. See the documentation of the Deploy Swiftlet for further information.

Configuration

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.

Attributes of Element "swiftlet"

Definition

Attribute	Type	Mandatory	Description
collect-interval	java.lang.Long	No	Collect Interval (ms) for the Usage Section

Values

Attribute	Values
collect-interval	Default: 10000

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
smtp-authentication-enabled	java.lang.Boolean	No	Enables/Disables SMTP Authentication
smtp-username	java.lang.String	No	SMTP Username
smtp-password	java.lang.String	No	SMTP Password
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
smtp-authentication-enabled	Default: false
smtp-username
smtp-password
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 "mail-filter-definition", Parent Element: "inbound-bridge"

Definitions of inbound Mail Filters.

Definition

Attribute	Type	Mandatory	Description
mail-filter-reject-from-address	java.lang.String	Yes	The Mail Address used as 'from' in rejected Messages
mail-filter-reject-queue	java.lang.String	Yes	Name of the Queue to forward rejected Messages

Values

Attribute	Values
mail-filter-reject-from-address	Default: noreply@domain.com
mail-filter-reject-queue	Default: mail-filter-reject-queue

Element List "mail-filters", Parent Element: "mail-filter-definition"

Mail Filter. This element list contains zero or more "mail-filter" elements with this template definition:

Definition

Attribute	Type	Mandatory	Description
name	java.lang.String	Yes	Name of this Mail Filter
filter-type	java.lang.String	Yes	Type of this Mail Filter
reject-on-match	java.lang.Boolean	No	Rejects Message if this Filter matches
rejection-message	java.lang.String	No	Message returned to Sender upon Rejection
return-to-sender	java.lang.Boolean	No	Returns Mail to Sender if rejected by this Filter

Values

Attribute	Values
filter-type	Choice: header body attachment size
reject-on-match	Default: true
rejection-message
return-to-sender	Default: false

Element List "filter-properties", Parent Element: "mail-filter"

Filter Properties. This element list contains zero or more "filter-property" elements with this template definition:

Definition

Attribute	Type	Mandatory	Description
name	java.lang.String	Yes	Name of this Filter Property
value	java.lang.String	Yes	Value

Values

Attribute	Values
value

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

High Quality JMS Messaging.

Search

Installation

Configuration