|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.mail.Address
javax.mail.internet.InternetAddress
public class InternetAddress
This class represents an Internet email address using the syntax of RFC822. Typical address syntax is of the form "user@host.domain" or "Personal Name <user@host.domain>".
| Field Summary | |
|---|---|
protected java.lang.String |
address
|
protected java.lang.String |
encodedPersonal
The RFC 2047 encoded version of the personal name. |
protected java.lang.String |
personal
The personal name. |
| Constructor Summary | |
|---|---|
InternetAddress()
Default constructor. |
|
InternetAddress(java.lang.String address)
Constructor. |
|
InternetAddress(java.lang.String address,
boolean strict)
Parse the given string and create an InternetAddress. |
|
InternetAddress(java.lang.String address,
java.lang.String personal)
Construct an InternetAddress given the address and personal name. |
|
InternetAddress(java.lang.String address,
java.lang.String personal,
java.lang.String charset)
Construct an InternetAddress given the address and personal name. |
|
| Method Summary | |
|---|---|
java.lang.Object |
clone()
Return a copy of this InternetAddress object. |
boolean |
equals(java.lang.Object a)
The equality operator. |
java.lang.String |
getAddress()
Get the email address. |
InternetAddress[] |
getGroup(boolean strict)
Return the members of a group address. |
static InternetAddress |
getLocalAddress(Session session)
Return an InternetAddress object representing the current user. |
java.lang.String |
getPersonal()
Get the personal name. |
java.lang.String |
getType()
Return the type of this address. |
int |
hashCode()
Compute a hash code for the address. |
boolean |
isGroup()
Indicates whether this address is an RFC 822 group address. |
static InternetAddress[] |
parse(java.lang.String addresslist)
Parse the given comma separated sequence of addresses into InternetAddress objects. |
static InternetAddress[] |
parse(java.lang.String addresslist,
boolean strict)
Parse the given sequence of addresses into InternetAddress objects. |
static InternetAddress[] |
parseHeader(java.lang.String addresslist,
boolean strict)
Parse the given sequence of addresses into InternetAddress objects. |
void |
setAddress(java.lang.String address)
Set the email address. |
void |
setPersonal(java.lang.String name)
Set the personal name. |
void |
setPersonal(java.lang.String name,
java.lang.String charset)
Set the personal name. |
java.lang.String |
toString()
Convert this address into a RFC 822 / RFC 2047 encoded address. |
static java.lang.String |
toString(Address[] addresses)
Convert the given array of InternetAddress objects into a comma separated sequence of address strings. |
static java.lang.String |
toString(Address[] addresses,
int used)
Convert the given array of InternetAddress objects into a comma separated sequence of address strings. |
java.lang.String |
toUnicodeString()
Returns a properly formatted address (RFC 822 syntax) of Unicode characters. |
void |
validate()
Validate that this address conforms to the syntax rules of RFC 822. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected java.lang.String address
protected java.lang.String personal
protected java.lang.String encodedPersonal
This field and the personal field track each
other, so if a subclass sets one of these fields directly, it
should set the other to null, so that it is
suitably recomputed.
| Constructor Detail |
|---|
public InternetAddress()
public InternetAddress(java.lang.String address)
throws AddressException
Parse the given string and create an InternetAddress.
See the parse method for details of the parsing.
The address is parsed using "strict" parsing.
This constructor does not perform the additional
syntax checks that the
InternetAddress(String address, boolean strict)
constructor does when strict is true.
This constructor is equivalent to
InternetAddress(address, false).
address - the address in RFC822 format
AddressException - if the parse failed
public InternetAddress(java.lang.String address,
boolean strict)
throws AddressException
strict is false, the detailed syntax of the
address isn't checked.
address - the address in RFC822 formatstrict - enforce RFC822 syntax
AddressException - if the parse failed
public InternetAddress(java.lang.String address,
java.lang.String personal)
throws java.io.UnsupportedEncodingException
address - the address in RFC822 formatpersonal - the personal name
java.io.UnsupportedEncodingException
public InternetAddress(java.lang.String address,
java.lang.String personal,
java.lang.String charset)
throws java.io.UnsupportedEncodingException
address - the address in RFC822 formatpersonal - the personal namecharset - the MIME charset for the name
java.io.UnsupportedEncodingException| Method Detail |
|---|
public java.lang.Object clone()
clone in class java.lang.Objectpublic java.lang.String getType()
getType in class AddressInternetAddresspublic void setAddress(java.lang.String address)
address - email address
public void setPersonal(java.lang.String name,
java.lang.String charset)
throws java.io.UnsupportedEncodingException
name - personal namecharset - MIME charset to be used to encode the name as
per RFC 2047
java.io.UnsupportedEncodingException - if the charset encoding
fails.setPersonal(String)
public void setPersonal(java.lang.String name)
throws java.io.UnsupportedEncodingException
name - personal name
java.io.UnsupportedEncodingException - if the charset encoding
fails.setPersonal(String name, String charset)public java.lang.String getAddress()
public java.lang.String getPersonal()
public java.lang.String toString()
toString in class Addresspublic java.lang.String toUnicodeString()
public boolean equals(java.lang.Object a)
equals in class Addressa - Address objectpublic int hashCode()
hashCode in class java.lang.Objectpublic static java.lang.String toString(Address[] addresses)
addresses - array of InternetAddress objects
ClassCastException, - if any address object in the
given array is not an InternetAddress object. Note
that this is a RuntimeException.
public static java.lang.String toString(Address[] addresses,
int used)
The 'used' parameter specifies the number of character positions already taken up in the field into which the resulting address sequence string is to be inserted. It is used to determine the line-break positions in the resulting address sequence string.
addresses - array of InternetAddress objectsused - number of character positions already used, in
the field into which the address string is to
be inserted.
ClassCastException, - if any address object in the
given array is not an InternetAddress object. Note
that this is a RuntimeException.public static InternetAddress getLocalAddress(Session session)
InetAddress.getLocalHost method are tried.
Security exceptions that may occur while accessing this information
are ignored. If it is not possible to determine an email address,
null is returned.
session - Session object used for property lookup
public static InternetAddress[] parse(java.lang.String addresslist)
throws AddressException
addresslist - comma separated address strings
AddressException - if the parse failed
public static InternetAddress[] parse(java.lang.String addresslist,
boolean strict)
throws AddressException
strict is false, simple email addresses
separated by spaces are also allowed. If strict is
true, many (but not all) of the RFC822 syntax rules are enforced.
In particular, even if strict is true, addresses
composed of simple names (with no "@domain" part) are allowed.
Such "illegal" addresses are not uncommon in real messages. Non-strict parsing is typically used when parsing a list of mail addresses entered by a human. Strict parsing is typically used when parsing address headers in mail messages.
addresslist - comma separated address stringsstrict - enforce RFC822 syntax
AddressException - if the parse failed
public static InternetAddress[] parseHeader(java.lang.String addresslist,
boolean strict)
throws AddressException
strict is false, the full syntax rules for
individual addresses are not enforced. If strict is
true, many (but not all) of the RFC822 syntax rules are enforced.
To better support the range of "invalid" addresses seen in real
messages, this method enforces fewer syntax rules than the
parse method when the strict flag is false
and enforces more rules when the strict flag is true. If the
strict flag is false and the parse is successful in separating out an
email address or addresses, the syntax of the addresses themselves
is not checked.
addresslist - comma separated address stringsstrict - enforce RFC822 syntax
AddressException - if the parse failed
public void validate()
throws AddressException
AddressException - if the address isn't valid.public boolean isGroup()
public InternetAddress[] getGroup(boolean strict)
throws AddressException
strict parameter controls whether
the group list is parsed using strict RFC 822 rules or not.
The parsing is done using the parseHeader method.
AddressException - if the group list can't be parsed
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24