BasicHeader (net.bluemind.parent 3.1.42685 API)

java.lang.Object
- org.columba.ristretto.message.BasicHeader

```
public class BasicHeader
extends java.lang.Object
```
Wrapper around the Header to provide a convienient way to access all important headerfields defined in RFC822.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`HIGH` Priority value
`static int`	`HIGHEST` Priority value
`static int`	`LOW` Priority value
`static int`	`LOWEST` Priority value
`static int`	`NORMAL` Priority value

Constructor Summary

Constructors
Constructor and Description

BasicHeader(Header header)
Constructs a BasicHeader from a Header

Constructors
Constructor and Description
`BasicHeader(Header header)` Constructs a BasicHeader from a `Header`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`count()`
`java.lang.String`	`get(java.lang.String key)` Get the header with the specified key.
`Address[]`	`getBcc()` Gets the field "Bcc" from the header and uses the `AddressParser` to return a parsed `Address` list
`Address`	`getBeenThere()` Gets the field "X-BeenThere" from the header and uses the `AddressParser` to return a parsed `Address` list
`Address[]`	`getCc()` Gets the field "Cc" from the header and uses the `AddressParser` to return a parsed `Address` list
`java.util.Date`	`getDate()` Gets the field "Date" from the header and uses the `DateParser` to parse it into a `Date` object.
`Address`	`getFrom()` Gets the field "From" from the header and uses the `AddressParser` to return a parsed `Address` list
`java.lang.String[]`	`getInReplyTo()` Gets the field "In-Reply-To" from the header and splits the list in an Array of message-ids
`java.util.Enumeration<java.lang.String>`	`getKeys()` Get all keys from the header.
`java.lang.String`	`getMessageID()` Gets the field "Message-ID" from the header
`int`	`getPriority()` Gets the field "X-Priority" from the header and converts the value to an int.
`java.lang.String[]`	`getReferences()` Gets the field "References" from the header and splits the list in an Array of message-ids
`Address[]`	`getReplyTo()` Gets the field "Reply-To" from the header and uses the `AddressParser` to return a parsed `Address` list
`Address`	`getSender()` Gets the field "Sender" from the header and uses the `AddressParser` to return a parsed `Address` list
`java.lang.String`	`getSubject()` Gets the field "Subject" from the header and uses the `EncodedWord` to decode an encoded subject.
`Address[]`	`getTo()` Gets the field "To" from the header and uses the `AddressParser` to return a parsed `Address` list
`static java.lang.String`	`removeComments(java.lang.String value)` Remove any comments as defined in RFC2822 from the String.
`void`	`set(java.lang.String key, java.lang.Object value)` Set the header with the specified key.
`void`	`setBcc(Address[] addresses)` Sets the field "Bcc" of the header and uses `EncodedWord` to encode names if needed in UTF-8 using QuotedPrintable encoding.
`void`	`setCc(Address[] addresses)` Sets the field "Cc" of the header and uses `EncodedWord` to encode names if needed in UTF-8 using QuotedPrintable encoding.
`void`	`setDate(java.util.Date date)` Sets the field "Date" of the header by using `MessageDate` to convert the `Date` object into a RFC2822 compatible date string
`void`	`setFrom(Address address)` Sets the field "From" of the header and uses `EncodedWord` to encode names if needed in UTF-8 using QuotedPrintable encoding.
`void`	`setInReplyTo(java.lang.String[] messageids)` Sets the field "In-Reply-To" of the header.
`void`	`setMessageID(java.lang.String messageid)` Sets the field "Message-ID" of the header.
`void`	`setPriority(int priority)` Sets the field "X-Priority" of the header.
`void`	`setReferences(java.lang.String[] messageids)` Sets the field "References" of the header.
`void`	`setReplyTo(Address[] addresses)` Sets the field "Reply-To" of the header and uses `EncodedWord` to encode names if needed in UTF-8 using QuotedPrintable encoding.
`void`	`setSubject(java.lang.String subject, java.nio.charset.Charset charset)` Sets the field "Subject" of the header using `EncodedWord` to encode the subject with the given charset (e.g.
`void`	`setTo(Address[] addresses)` Sets the field "To" of the header and uses `EncodedWord` to encode names if needed in UTF-8 using QuotedPrintable encoding.

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

- Field Detail
  - HIGHEST
```
public static final int HIGHEST
```
    Priority value
    
    See Also:
    
    Constant Field Values
  - HIGH
```
public static final int HIGH
```
    Priority value
    
    See Also:
    
    Constant Field Values
  - NORMAL
```
public static final int NORMAL
```
    Priority value
    
    See Also:
    
    Constant Field Values
  - LOW
```
public static final int LOW
```
    Priority value
    
    See Also:
    
    Constant Field Values
  - LOWEST
```
public static final int LOWEST
```
    Priority value
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BasicHeader
```
public BasicHeader(Header header)
```
    Constructs a BasicHeader from a Header
    
    Parameters:
    
    header - parsed
- Method Detail
  - getFrom
```
public Address getFrom()
```
    Gets the field "From" from the header and uses the AddressParser to return a parsed Address list
    
    Returns:
    
    {[@link Adress} list
  - getSender
```
public Address getSender()
```
    Gets the field "Sender" from the header and uses the AddressParser to return a parsed Address list
    
    Returns:
    
    {[@link Adress} list
  - getBeenThere
```
public Address getBeenThere()
```
    Gets the field "X-BeenThere" from the header and uses the AddressParser to return a parsed Address list
    
    Returns:
    
    {[@link Adress} list
  - getTo
```
public Address[] getTo()
```
    Gets the field "To" from the header and uses the AddressParser to return a parsed Address list
    
    Returns:
    
    {[@link Adress} list
  - getCc
```
public Address[] getCc()
```
    Gets the field "Cc" from the header and uses the AddressParser to return a parsed Address list
    
    Returns:
    
    {[@link Adress} list
  - getBcc
```
public Address[] getBcc()
```
    Gets the field "Bcc" from the header and uses the AddressParser to return a parsed Address list
    
    Returns:
    
    {[@link Adress} list
  - getReplyTo
```
public Address[] getReplyTo()
```
    Gets the field "Reply-To" from the header and uses the AddressParser to return a parsed Address list
    
    Returns:
    
    {[@link Adress} list
  - getSubject
```
public java.lang.String getSubject()
```
    Gets the field "Subject" from the header and uses the EncodedWord to decode an encoded subject.
    
    Returns:
    
    human-readable subject
  - getMessageID
```
public java.lang.String getMessageID()
```
    Gets the field "Message-ID" from the header
    
    Returns:
    
    the message-id
  - getReferences
```
public java.lang.String[] getReferences()
```
    Gets the field "References" from the header and splits the list in an Array of message-ids
    
    Returns:
    
    list of message-ids
  - getInReplyTo
```
public java.lang.String[] getInReplyTo()
```
    Gets the field "In-Reply-To" from the header and splits the list in an Array of message-ids
    
    Returns:
    
    list of message-ids
  - getPriority
```
public int getPriority()
```
    Gets the field "X-Priority" from the header and converts the value to an int. Constants for the priorities are also defined in this class. If an error occurs while converting or no "X-Priority" field is defined, NORMAL priority is returned.
    
    Returns:
    
    priority of the message
  - getDate
```
public java.util.Date getDate()
```
    Gets the field "Date" from the header and uses the DateParser to parse it into a Date object. If an error occurs the current date is returned.
    
    Returns:
    
    sent date of the message
  - setFrom
```
public void setFrom(Address address)
```
    Sets the field "From" of the header and uses EncodedWord to encode names if needed in UTF-8 using QuotedPrintable encoding. We chose UTF-8 to cover any possible characters.
    
    Parameters:
    
    address - mailaddresses with or without names
  - setTo
```
public void setTo(Address[] addresses)
```
    Sets the field "To" of the header and uses EncodedWord to encode names if needed in UTF-8 using QuotedPrintable encoding. We chose UTF-8 to cover any possible characters.
    
    Parameters:
    
    addresses - mailaddresses with or without names
  - setCc
```
public void setCc(Address[] addresses)
```
    Sets the field "Cc" of the header and uses EncodedWord to encode names if needed in UTF-8 using QuotedPrintable encoding. We chose UTF-8 to cover any possible characters.
    
    Parameters:
    
    addresses - mailaddresses with or without names
  - setBcc
```
public void setBcc(Address[] addresses)
```
    Sets the field "Bcc" of the header and uses EncodedWord to encode names if needed in UTF-8 using QuotedPrintable encoding. We chose UTF-8 to cover any possible characters.
    
    Parameters:
    
    addresses - mailaddresses with or without names
  - setReplyTo
```
public void setReplyTo(Address[] addresses)
```
    Sets the field "Reply-To" of the header and uses EncodedWord to encode names if needed in UTF-8 using QuotedPrintable encoding. We chose UTF-8 to cover any possible characters.
    
    Parameters:
    
    addresses - mailaddresses with or without names
  - setDate
```
public void setDate(java.util.Date date)
```
    Sets the field "Date" of the header by using MessageDate to convert the Date object into a RFC2822 compatible date string
    
    Parameters:
    
    date - of the message creation
  - setMessageID
```
public void setMessageID(java.lang.String messageid)
```
    Sets the field "Message-ID" of the header. This should be a unique ID that only this message has. RFC2822 says the following about this field: "The "Message-ID:" field provides a unique message identifier that refers to a particular version of a particular message. The uniqueness of the message identifier is guaranteed by the host that generates it (see below). This message identifier is intended to be machine readable and not necessarily meaningful to humans. A message identifier pertains to exactly one instantiation of a particular message; subsequent revisions to the message each receive new message identifiers." (RFC2822, p.23)
    
    Parameters:
    
    messageid - unique id of this message
  - setReferences
```
public void setReferences(java.lang.String[] messageids)
```
    Sets the field "References" of the header. The messageids are the references this message refers to. The information of this and the "In-Repy-To" field can be used by mailclients e.g. to create a threaded view of a discussion
    
    Parameters:
    
    messageids - the messageids of the messages this message refers to
    
    See Also:
    
    setInReplyTo(java.lang.String[])
  - setInReplyTo
```
public void setInReplyTo(java.lang.String[] messageids)
```
    Sets the field "In-Reply-To" of the header. The messageids are the references this message refers to. The information of this and the "In-Repy-To" field can be used by mailclients e.g. to create a threaded view of a discussion
    
    Parameters:
    
    messageids - the messageids of the messages this message refers to
    
    See Also:
    
    setReferences(java.lang.String[])
  - setPriority
```
public void setPriority(int priority)
```
    Sets the field "X-Priority" of the header. Use the provided constants to specify the priority.
    
    Parameters:
    
    priority - of the message
  - setSubject
```
public void setSubject(java.lang.String subject,
                       java.nio.charset.Charset charset)
```
    Sets the field "Subject" of the header using EncodedWord to encode the subject with the given charset (e.g. ISO-8859-1) and Quoted- Printable encoding.
    
    Parameters:
    
    subject - of the message
    
    charset - the subject is encoded in
  - count
```
public int count()
```
    Returns:
    
    the number of headers
  - get
```
public java.lang.String get(java.lang.String key)
```
    Get the header with the specified key.
    
    Parameters:
    
    key -
    
    Returns:
    
    the header
  - set
```
public void set(java.lang.String key,
                java.lang.Object value)
```
    Set the header with the specified key.
    
    Parameters:
    
    key -
    
    value -
  - removeComments
```
public static final java.lang.String removeComments(java.lang.String value)
```
    Remove any comments as defined in RFC2822 from the String.
    
    Parameters:
    
    value -
    
    Returns:
    
    the comment-free String
  - getKeys
```
public java.util.Enumeration<java.lang.String> getKeys()
```
    Get all keys from the header.
    
    Returns:
    
    Enumeration of keys

Class BasicHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HIGHEST

HIGH

NORMAL

LOW

LOWEST

Constructor Detail

BasicHeader

Method Detail

getFrom

getSender

getBeenThere

getTo

getCc

getBcc

getReplyTo

getSubject

getMessageID

getReferences

getInReplyTo

getPriority

getDate

setFrom

setTo

setCc

setBcc

setReplyTo

setDate

setMessageID

setReferences

setInReplyTo

setPriority

setSubject

count

get

set

removeComments

getKeys