SK.gnome.dwarf.mail.mime
Class Address

java.lang.Object
  SK.gnome.dwarf.mail.mime.Address

All Implemented Interfaces:

java.lang.Cloneable

public class Address

extends java.lang.Object

implements java.lang.Cloneable

Provides a representation of RFC 822 address.

Constructor Summary

Address(java.lang.String address)
Creates a new Address.

Address(java.lang.String address, java.lang.String charset)
Creates a new Address.

Address(java.lang.String address, java.lang.String personal, java.lang.String charset)
Creates a new Address.

Method Summary

protected java.lang.Object	clone()
java.lang.String	getAddress() Returns the address.
java.lang.String	getDisplayName() Returns the display-name part of the address.
java.lang.String	getDomain() Returns the domain part of the address.
Address[]	getGroupMembers() Returns the members of the address group.
java.lang.String	getLocalPart() Returns the local part of the address.
boolean	isGroup() Whether the address specifies a group.
static Address[]	parse(java.lang.String addresses) Parses the given list of addresses into an array.
static Address[]	parse(java.lang.String addresses, java.lang.String charset) Parses the given list of addresses into an array.
java.lang.String	toEncodedString() Returns the address string encoded as per RFC 2047.
java.lang.String	toString() Returns the address Unicode string.
static java.lang.String	toString(java.lang.String addresses) Parses the given list of addresses into a Unicode string.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Address

public Address(java.lang.String address)
        throws AddressException

Creates a new Address.

Parameters:

address - valid RFC 822 address

Throws:

AddressException - if an address syntax error occured

Address

public Address(java.lang.String address,
               java.lang.String charset)
        throws AddressException

Creates a new Address.

Parameters:

address - valid RFC 822 address

charset - MIME charset for encoding the personal name

Throws:

AddressException - if an address syntax error occured

Address

public Address(java.lang.String address,
               java.lang.String personal,
               java.lang.String charset)
        throws AddressException

Creates a new Address.

Parameters:

address - valid RFC 822 address

personal - personal name

charset - MIME charset for encoding the personal name

Throws:

AddressException - if an address syntax error occured

Method Detail

getAddress

public java.lang.String getAddress()

Returns the address.

Returns:

address without the personal name

getDisplayName

public java.lang.String getDisplayName()

Returns the display-name part of the address.

Returns:

display name as Unicode string

getLocalPart

public java.lang.String getLocalPart()

Returns the local part of the address.

The local-part typically forms a mailbox name.

Returns:

the local part

getDomain

public java.lang.String getDomain()

Returns the domain part of the address.

If the domain part is a numerical IP address, it is returned without the surrounding brackets.

Returns:

the domain part or null if not present

isGroup

public boolean isGroup()

Whether the address specifies a group.

Returns:

true if this is a group address, false otherwise

getGroupMembers

public Address[] getGroupMembers()
                          throws AddressException

Returns the members of the address group.

Returns:

array of group members or null if the address does not specify a group

Throws:

AddressException - if an address syntax error occured

toEncodedString

public java.lang.String toEncodedString()

Returns the address string encoded as per RFC 2047.

Returns:

address string including the personal name

toString

public java.lang.String toString()

Returns the address Unicode string.

Returns:

address string including the personal name

parse

public static Address[] parse(java.lang.String addresses)
                       throws AddressException

Parses the given list of addresses into an array.

The argument must be a comma-separated list of valid RFC 822 addresses.

Parameters:

addresses - address list

Returns:

array of addresses

Throws:

AddressException - if an address syntax error occured

parse

public static Address[] parse(java.lang.String addresses,
                              java.lang.String charset)
                       throws AddressException

Parses the given list of addresses into an array.

The argument must be a comma-separated list of valid RFC 822 addresses.

Parameters:

addresses - address list

Returns:

array of addresses

Throws:

AddressException - if an address syntax error occured

toString

public static java.lang.String toString(java.lang.String addresses)
                                 throws AddressException

Parses the given list of addresses into a Unicode string.

The argument must be a comma-separated list of valid RFC 822 addresses.

Parameters:

addresses - address list

Returns:

comma-separated list of addresses

Throws:

AddressException - if an address syntax error occured

clone

protected java.lang.Object clone()