ReadmailConfig (OpenNMS 18.0.3 API)

java.lang.Object
- org.opennms.netmgt.config.javamail.ReadmailConfig

All Implemented Interfaces:

Serializable
```
public class ReadmailConfig
extends Object
implements Serializable
```
The Class ReadmailConfig.

Author:

Alejandro Galue

See Also:

Serialized Form

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`Enumeration<JavamailProperty>`	`enumerateJavamail` Method enumerateJavamailProperty.
`Iterator<JavamailProperty>`	`iterateJavamail` Method iterateJavamailProperty.

Constructor Summary

Constructors
Constructor and Description

ReadmailConfig()
Instantiates a new readmail config.

Constructors
Constructor and Description
`ReadmailConfig()` Instantiates a new readmail config.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addJavamailProperty(int index, JavamailProperty vJavamailProperty)` Adds the javamail property.
`void`	`addJavamailProperty(JavamailProperty vJavamailProperty)` Adds the javamail property.
`Enumeration<JavamailProperty>`	`enumerateJavamailProperty()` Method enumerateJavamailProperty.
`boolean`	`equals(Object obj)`
`Long`	`getAttemptInterval()` Returns the value of field 'attemptInterval'.
`JavamailProperty[]`	`getJavamailProperty()` Method getJavamailProperty.Returns the contents of the collection in an Array.
`JavamailProperty`	`getJavamailProperty(int index)` Method getJavamailProperty.
`List<JavamailProperty>`	`getJavamailPropertyCollection()` Method getJavamailPropertyCollection.Returns a reference to '_javamailPropertyList'.
`int`	`getJavamailPropertyCount()` Method getJavamailPropertyCount.
`String`	`getMailFolder()` Returns the value of field 'mailFolder'.
`String`	`getName()` Returns the value of field 'name'.
`ReadmailHost`	`getReadmailHost()` Returns the value of field 'readmailHost'.
`UserAuth`	`getUserAuth()` Returns the value of field 'userAuth'.
`int`	`hashCode()`
`Boolean`	`isDebug()` Returns the value of field 'debug'.
`Boolean`	`isDeleteAllMail()` Returns the value of field 'deleteAllMail'.
`Iterator<JavamailProperty>`	`iterateJavamailProperty()` Method iterateJavamailProperty.
`void`	`removeAllJavamailProperty()` Removes the all javamail property.
`boolean`	`removeJavamailProperty(JavamailProperty vJavamailProperty)` Method removeJavamailProperty.
`JavamailProperty`	`removeJavamailPropertyAt(int index)` Method removeJavamailPropertyAt.
`void`	`setAttemptInterval(Long attemptInterval)` Sets the value of field 'attemptInterval'.
`void`	`setDebug(Boolean debug)` Sets the value of field 'debug'.
`void`	`setDeleteAllMail(Boolean deleteAllMail)` Sets the value of field 'deleteAllMail'.
`void`	`setJavamailProperty(int index, JavamailProperty vJavamailProperty)` Sets the javamail property.
`void`	`setJavamailProperty(JavamailProperty[] vJavamailPropertyArray)` Sets the javamail property.
`void`	`setJavamailProperty(List<JavamailProperty> vJavamailPropertyList)` Sets the value of '_javamailPropertyList' by copying the given Vector.
`void`	`setJavamailPropertyCollection(List<JavamailProperty> javamailPropertyList)` Deprecated.
`void`	`setMailFolder(String mailFolder)` Sets the value of field 'mailFolder'.
`void`	`setName(String name)` Sets the value of field 'name'.
`void`	`setReadmailHost(ReadmailHost readmailHost)` Sets the value of field 'readmailHost'.
`void`	`setUserAuth(UserAuth userAuth)` Sets the value of field 'userAuth'.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - enumerateJavamail
```
public Enumeration<JavamailProperty> enumerateJavamailProperty
```
    Method enumerateJavamailProperty.
  - iterateJavamail
```
public Iterator<JavamailProperty> iterateJavamailProperty
```
    Method iterateJavamailProperty.
- Constructor Detail
  - ReadmailConfig
```
public ReadmailConfig()
```
    Instantiates a new readmail config.
- Method Detail
  - addJavamailProperty
```
public void addJavamailProperty(JavamailProperty vJavamailProperty)
                         throws IndexOutOfBoundsException
```
    Adds the javamail property.
    
    Parameters:
    
    vJavamailProperty - the javamail property
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addJavamailProperty
```
public void addJavamailProperty(int index,
                                JavamailProperty vJavamailProperty)
                         throws IndexOutOfBoundsException
```
    Adds the javamail property.
    
    Parameters:
    
    index - the index
    
    vJavamailProperty - the javamail property
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - enumerateJavamailProperty
```
public Enumeration<JavamailProperty> enumerateJavamailProperty()
```
    Method enumerateJavamailProperty.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getAttemptInterval
```
public Long getAttemptInterval()
```
    Returns the value of field 'attemptInterval'.
    
    Returns:
    
    the value of field 'AttemptInterval'.
  - isDebug
```
public Boolean isDebug()
```
    Returns the value of field 'debug'.
    
    Returns:
    
    the value of field 'Debug'.
  - isDeleteAllMail
```
public Boolean isDeleteAllMail()
```
    Returns the value of field 'deleteAllMail'.
    
    Returns:
    
    the value of field 'DeleteAllMail'.
  - getJavamailProperty
```
public JavamailProperty getJavamailProperty(int index)
                                     throws IndexOutOfBoundsException
```
    Method getJavamailProperty.
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the value of the JavamailProperty at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getJavamailProperty
```
public JavamailProperty[] getJavamailProperty()
```
    Method getJavamailProperty.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    
    this collection as an Array
  - getJavamailPropertyCollection
```
public List<JavamailProperty> getJavamailPropertyCollection()
```
    Method getJavamailPropertyCollection.Returns a reference to '_javamailPropertyList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getJavamailPropertyCount
```
public int getJavamailPropertyCount()
```
    Method getJavamailPropertyCount.
    
    Returns:
    
    the size of this collection
  - getMailFolder
```
public String getMailFolder()
```
    Returns the value of field 'mailFolder'.
    
    Returns:
    
    the value of field 'MailFolder'.
  - getName
```
public String getName()
```
    Returns the value of field 'name'.
    
    Returns:
    
    the value of field 'Name'.
  - getReadmailHost
```
public ReadmailHost getReadmailHost()
```
    Returns the value of field 'readmailHost'. The field 'readmailHost' has the following description: Define the host and port of a service for reading email.
    
    Returns:
    
    the value of field 'ReadmailHost'.
  - getUserAuth
```
public UserAuth getUserAuth()
```
    Returns the value of field 'userAuth'. The field 'userAuth' has the following description: Configure user based authentication.
    
    Returns:
    
    the value of field 'UserAuth'.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - iterateJavamailProperty
```
public Iterator<JavamailProperty> iterateJavamailProperty()
```
    Method iterateJavamailProperty.
  - removeAllJavamailProperty
```
public void removeAllJavamailProperty()
```
    Removes the all javamail property.
  - removeJavamailProperty
```
public boolean removeJavamailProperty(JavamailProperty vJavamailProperty)
```
    Method removeJavamailProperty.
    
    Parameters:
    
    vJavamailProperty - the v javamail property
    
    Returns:
    
    true if the object was removed from the collection.
  - removeJavamailPropertyAt
```
public JavamailProperty removeJavamailPropertyAt(int index)
```
    Method removeJavamailPropertyAt.
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the element removed from the collection
  - setAttemptInterval
```
public void setAttemptInterval(Long attemptInterval)
```
    Sets the value of field 'attemptInterval'.
    
    Parameters:
    
    attemptInterval - the value of field 'attemptInterval'.
  - setDebug
```
public void setDebug(Boolean debug)
```
    Sets the value of field 'debug'.
    
    Parameters:
    
    debug - the value of field 'debug'.
  - setDeleteAllMail
```
public void setDeleteAllMail(Boolean deleteAllMail)
```
    Sets the value of field 'deleteAllMail'.
    
    Parameters:
    
    deleteAllMail - the value of field 'deleteAllMail'.
  - setJavamailProperty
```
public void setJavamailProperty(int index,
                                JavamailProperty vJavamailProperty)
                         throws IndexOutOfBoundsException
```
    Sets the javamail property.
    
    Parameters:
    
    index - the index
    
    vJavamailProperty - the javamail property
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setJavamailProperty
```
public void setJavamailProperty(JavamailProperty[] vJavamailPropertyArray)
```
    Sets the javamail property.
    
    Parameters:
    
    vJavamailPropertyArray - the new javamail property
  - setJavamailProperty
```
public void setJavamailProperty(List<JavamailProperty> vJavamailPropertyList)
```
    Sets the value of '_javamailPropertyList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vJavamailPropertyList - the Vector to copy.
  - setJavamailPropertyCollection
```
public void setJavamailPropertyCollection(List<JavamailProperty> javamailPropertyList)
```
    Deprecated.
    
    Sets the value of '_javamailPropertyList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    javamailPropertyList - the Vector to set.
  - setMailFolder
```
public void setMailFolder(String mailFolder)
```
    Sets the value of field 'mailFolder'.
    
    Parameters:
    
    mailFolder - the value of field 'mailFolder'.
  - setName
```
public void setName(String name)
```
    Sets the value of field 'name'.
    
    Parameters:
    
    name - the value of field 'name'.
  - setReadmailHost
```
public void setReadmailHost(ReadmailHost readmailHost)
```
    Sets the value of field 'readmailHost'. The field 'readmailHost' has the following description: Define the host and port of a service for reading email.
    
    Parameters:
    
    readmailHost - the value of field 'readmailHost'.
  - setUserAuth
```
public void setUserAuth(UserAuth userAuth)
```
    Sets the value of field 'userAuth'. The field 'userAuth' has the following description: Configure user based authentication.
    
    Parameters:
    
    userAuth - the value of field 'userAuth'.

Class ReadmailConfig

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

enumerateJavamail

iterateJavamail

Constructor Detail

ReadmailConfig

Method Detail

addJavamailProperty

addJavamailProperty

enumerateJavamailProperty

equals

getAttemptInterval

isDebug

isDeleteAllMail

getJavamailProperty

getJavamailProperty

getJavamailPropertyCollection

getJavamailPropertyCount

getMailFolder

getName

getReadmailHost

getUserAuth

hashCode

iterateJavamailProperty

removeAllJavamailProperty

removeJavamailProperty

removeJavamailPropertyAt

setAttemptInterval

setDebug

setDeleteAllMail

setJavamailProperty

setJavamailProperty

setJavamailProperty

setJavamailPropertyCollection

setMailFolder

setName

setReadmailHost

setUserAuth