# com.bea.wli.management.configuration
EmailEventGenChannelConfiguration Class

public class EmailEventGenChannelConfiguration
extends `Object`
implements `Serializable`

Represents a channel rule for an EMail Event Generator.

Rule Fields:

- hostname - mail server host address
- portNumber - mail server port number
- protocol - mail server protocol (pop3, imap etc.)
- username - mail server username
- password - Password to the above account
- password-alias - Alias to password store
- pollingInterval - how often to poll the server, in secs
- read-limit - Num of emails to read and process every poll interval
- postReadAction - What to do with the email after processing - delete | archive | move
- attachments - What to do with the attachemnts - archive | ignore
- archive-directory - Directory to archive messages and attachments in
- error-directory - Directory to archive messges with errors messages and attachments in
- imap-move-folder - Folder to move email messages to after they are processes (IMAP only)

Other fields:

- channel - channel to send to if rules match
- comment - comment for this channel rule
- packageType - package type to send (xml, RawData, String)
- attachmentArchiveDir - What to do with attachments - archive | post
- attachmentAction - What to do with attachments - archive | post
- archiveFolder - name of the folder to move the message to

Related Topics

``EmailEventGenConfigurationMBean``

Hierarchy
  `Object`
  `EmailEventGenChannelConfiguration`

All Implemented Interfaces
  `Serializable`

## Field Summary

`public static final `String`` | `_ATTACHMENT_ARCHIVE` String
`public static final `String`` | `_ATTACHMENT_IGNORE` String
`public static final int` | `_DEFAULT_POLLING_INTERVAL` int
`public static final `String`` | `_DEFAULT_PROTOCOL` String
`public static final int` | `_DEFAULT_READ_LIMIT` int
`public static final `String`` | `_POSTREAD_ARCHIVE` String
`public static final `String`` | `_POSTREAD_DELETE` String
`public static final `String`` | `_POSTREAD_MOVE` String

## Constructor Summary

EmailEventGenChannelConfiguration() Constructs a new EmailEventGenChannelConfiguration object.

## Method Summary

`public `String`` | `getArchiveDirectory`() Return the archive directory.
`public `String`` | `getAttachmentAction`() Return the attachment action.
`public `String`` | `getChannel`() Return the channel name.
`public `String`` | `getComment`() Return the description.
`public `String`` | `getErrorDirectory`() Return the name of the error directory.
`public `String`` | `getHostname`() Return the host name.
`public `String`` | `getImapMoveFolder`() Return the archive folder.
`public `String`` | `getPassword`() Return the password.
`public `String`` | `getPasswordAlias`() Return the password alias.
`public int` | `getPollingInterval`() Return the polling interval.
`public int` | `getPortNumber`() Return the port number.
`public `String`` | `getPostReadAction`() Return the post read action.
`public `String`` | `getProtocol`() Return the protocol.
`public `String`` | `getPublishAsUser`() Get the publishAsUser attribute
`public int` | `getReadLimit`() Return the read limit.
`public `String`` | `getSubjectFilter`()
`public `String`` | `getUsername`() Return the username.
`public void` | `setArchiveDirectory`(`String` archiveDir) Set the archive directory.
`public void` | `setAttachmentAction`(`String` attachmentAction) Sets the attachment action.
`public void` | `setChannel`(`String` channel) Set the name of the channel.
`public void` | `setComment`(`String` comment) Set a description for the channel rule.
`public void` | `setErrorDirectory`(`String` errorDir) Set the error directory.
`public void` | `setHostname`(`String` hostName) Set the hostname.
`public void` | `setImapMoveFolder`(`String` imapMoveFolder) Set the IMAP move folder name.
`public void` | `setPassword`(`String` password) Set the password to the email account being polled.
`public void` | `setPasswordAlias`(`String` pwdAlias) Set the password alias.
`public void` | `setPollingInterval`(int pollingInterval) Set the polling interval.
`public void` | `setPortNumber`(int portNumber) Set the port number on which the email server is accessible.
`public void` | `setPostReadAction`(`String` postReadAction) Set the post-read action.
`public void` | `setProtocol`(`String` protocol) Set the protocol to use to access the specified mailbox.
`public void` | `setPublishAsUser`(`String` publishAsUser) Set the publishAsUser attribute
`public void` | `setReadLimit`(int readLimit) Set the read limit.
`public void` | `setSubjectFilter`(`String` subjectFilter)
`public void` | `setUsername`(`String` username) Set the username of the email account that needs to be polled for incoming messages.
`public `String`` | `toString`() Returns a string representation of this channel.

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

## Field Detail

### _ATTACHMENT_ARCHIVE

    public static final String _ATTACHMENT_ARCHIVE

### _ATTACHMENT_IGNORE

    public static final String _ATTACHMENT_IGNORE

### _DEFAULT_POLLING_INTERVAL

    public static final int _DEFAULT_POLLING_INTERVAL

### _DEFAULT_PROTOCOL

    public static final String _DEFAULT_PROTOCOL

### _DEFAULT_READ_LIMIT

    public static final int _DEFAULT_READ_LIMIT

### _POSTREAD_ARCHIVE

    public static final String _POSTREAD_ARCHIVE

### _POSTREAD_DELETE

    public static final String _POSTREAD_DELETE

### _POSTREAD_MOVE

    public static final String _POSTREAD_MOVE

## Constructor Detail

### EmailEventGenChannelConfiguration

    public EmailEventGenChannelConfiguration()

  Constructs a new EmailEventGenChannelConfiguration object.

## Method Detail

### getArchiveDirectory() Method

    public String getArchiveDirectory()

Return the archive directory.

#### Returns

the archive directory.

### getAttachmentAction() Method

    public String getAttachmentAction()

Return the attachment action.

#### Returns

the value currently set for attachment action- ARCHIVE or IGNORE.

### getChannel() Method

    public String getChannel()

Return the channel name.

#### Returns

the name of the channel.

### getComment() Method

    public String getComment()

Return the description.

### getErrorDirectory() Method

    public String getErrorDirectory()

Return the name of the error directory.

#### Returns

the error directory.

### getHostname() Method

    public String getHostname()

Return the host name.

#### Returns

the host name.

### getImapMoveFolder() Method

    public String getImapMoveFolder()

Return the archive folder.

#### Returns

the name of the archive folder.

### getPassword() Method

    public String getPassword()

Return the password.

#### Returns

the password.

### getPasswordAlias() Method

    public String getPasswordAlias()

Return the password alias.

#### Returns

the password alias.

### getPollingInterval() Method

    public int getPollingInterval()

Return the polling interval.

#### Returns

the polling interval.

### getPortNumber() Method

    public int getPortNumber()

Return the port number.

#### Returns

the port number of the email server.

### getPostReadAction() Method

    public String getPostReadAction()

Return the post read action.

#### Returns

the value of the post read action.

### getProtocol() Method

    public String getProtocol()

Return the protocol.

#### Returns

the name of the protocol currently configured.

### getPublishAsUser() Method

    public String getPublishAsUser()

Get the publishAsUser attribute

#### Returns

publishAsUser attribute

### getReadLimit() Method

    public int getReadLimit()

Return the read limit.

#### Returns

the read limit configured.

### getSubjectFilter() Method

DEPRECATED Return the subject filter

    public String getSubjectFilter()

#### Returns

the subject filter.

### getUsername() Method

    public String getUsername()

Return the username.

#### Returns

the username.

### setArchiveDirectory(String) Method

    public void setArchiveDirectory(String archiveDir)

Set the archive directory. Email messages and attachments are saved to this directory after the email is read and processed. The filenames of the archived files are prefixed with the timestamp of the time they were processed.

#### Parameters

archiveDir
  - the archive directory to set.

### setAttachmentAction(String) Method

    public void setAttachmentAction(String attachmentAction)

Sets the attachment action. Attachments that are sent in the email messages can be either 'IGNORE'ed or 'ARCHIVE'ed. The default value is ARCHIVE.

#### Parameters

attachmentAction
  - the value to set.

### setChannel(String) Method

    public void setChannel(String channel)

Set the name of the channel. Email messages are published to the channel specified by the channel name.

#### Parameters

channel
  - the name to channel to set.

### setComment(String) Method

    public void setComment(String comment)

Set a description for the channel rule.

#### Parameters

comment
  - the description of this channel.

### setErrorDirectory(String) Method

    public void setErrorDirectory(String errorDir)

Set the error directory. The body of the email message along with any attachments are copied to this directory if any errors are encountered when publishing the email message. The filenames of the archived files are prefixed with the timestamp of the time that the error occurred.

#### Parameters

errorDir
  - the error directory to set.

### setHostname(String) Method

    public void setHostname(String hostName)

Set the hostname. This is the address of the email server to poll for messages.

#### Parameters

hostName
  - the hostname to set.

### setImapMoveFolder(String) Method

    public void setImapMoveFolder(String imapMoveFolder)

Set the IMAP move folder name. Specify the name of the folder to move messages to after they are processed. This option is valid only if the protocol is set to IMAP.

#### Parameters

imapMoveFolder
  - the folder to move messages to.

### setPassword(String) Method

    public void setPassword(String password)

Set the password to the email account being polled.

#### Parameters

password
  - the password to set.

### setPasswordAlias(String) Method

    public void setPasswordAlias(String pwdAlias)

Set the password alias. Specify the alias to the password store in order to look up the password to the email account.

#### Parameters

pwdAlias
  - the alias to set.

### setPollingInterval(int) Method

    public void setPollingInterval(int pollingInterval)

Set the polling interval. The polling interval specifies how often the email server is polled to check for new messages.

#### Parameters

pollingInterval
  - the polling interval in seconds.

### setPortNumber(int) Method

    public void setPortNumber(int portNumber)

Set the port number on which the email server is accessible. The default value is -1 which allows the correct port number to be selected, depending on the protocol specified.

#### Parameters

portNumber
  - the port number to set.

### setPostReadAction(String) Method

    public void setPostReadAction(String postReadAction)

Set the post-read action. Specify what to do with the email after it is read and published. The allowed values for a POP3 server are 'DELETE' and 'ARCHIVE'. An IMAP server allows 'DELETE', 'ARCHIVE' and 'MOVE'. The default value is 'DELETE'.

#### Parameters

postReadAction
  - the post read action to set.

### setProtocol(String) Method

    public void setProtocol(String protocol)

Set the protocol to use to access the specified mailbox. The valid values are IMAP or POP3. Defaults to POP3.

#### Parameters

protocol
  - the protocol to set.

### setPublishAsUser(String) Method

    public void setPublishAsUser(String publishAsUser)

Set the publishAsUser attribute

#### Parameters

publishAsUser
  property to set

### setReadLimit(int) Method

    public void setReadLimit(int readLimit)

Set the read limit. Specify the number of email messages to read in each polling of the email account. The default value is '0', which means no limit. All the messages in the Inbox are read in each polling interval.

#### Parameters

readLimit
  - the read limit to set.

### setSubjectFilter(String) Method

DEPRECATED Set the subject filter to filter email messages.

    public void setSubjectFilter(String subjectFilter)

#### Parameters

subjectFilter
  the subject filter to set.

### setUsername(String) Method

    public void setUsername(String username)

Set the username of the email account that needs to be polled for incoming messages.

#### Parameters

username
  - the username of the account to poll.

### toString() Method

    public String toString()

Returns a string representation of this channel.

Overrides
  `Object.toString()`