|
|||||||||||
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
A representation of an Internet email address as specified by RFC822 in conjunction with a human-readable personal name that can be encoded as specified by RFC2047. A typical address is "user@host.domain" and personal name "Joe User"
Field Summary | |
protected java.lang.String |
address
The address in RFC822 format. |
private static byte[] |
CHARMAP
|
protected java.lang.String |
encodedPersonal
The personal name in RFC2047 format. |
private static byte |
FLG_CONTROL
|
private static byte |
FLG_SPACE
|
private static byte |
FLG_SPECIAL
|
protected java.lang.String |
personal
The personal name as a Java String. |
Constructor Summary | |
InternetAddress()
|
|
InternetAddress(java.lang.String address)
|
|
InternetAddress(java.lang.String address,
boolean strict)
|
|
InternetAddress(java.lang.String address,
java.lang.String personal)
|
|
InternetAddress(java.lang.String address,
java.lang.String personal,
java.lang.String charset)
|
Method Summary | |
java.lang.Object |
clone()
Clone this object. |
boolean |
equals(java.lang.Object o)
Compares two addresses for equality. |
private int |
expectPhrase(java.lang.String s,
int index)
|
private int |
expectWord(java.lang.String s,
int index)
|
java.lang.String |
getAddress()
Return the address. |
private java.lang.String |
getEncodedPersonal()
Return the encoded form of the personal name. |
InternetAddress[] |
getGroup(boolean strict)
Return the members of a group address. |
static InternetAddress |
getLocalAddress(Session session)
Return an InternetAddress representing the current user. |
java.lang.String |
getPersonal()
Return the personal name. |
java.lang.String |
getType()
Return the type of this address. |
int |
hashCode()
Return the hashCode for this address. |
private static void |
init(InternetAddress addr,
java.lang.String text)
|
private static boolean |
isAtom(char c)
|
boolean |
isGroup()
Return true is this address is an RFC822 group address in the format phrase ":" [#mailbox] ";" . |
private static boolean |
isSpace(char c)
|
static InternetAddress[] |
parse(java.lang.String addresses)
Parse addresses out of the string with basic checking. |
static InternetAddress[] |
parse(java.lang.String addresses,
boolean strict)
Parse addresses out of the string. |
private static InternetAddress[] |
parse(java.lang.String addresses,
boolean strict,
boolean veryStrict)
Parse addresses with increasing degrees of RFC822 compliance checking. |
(package private) static void |
parseHeader(java.util.List target,
java.lang.String addresses,
boolean strict,
boolean veryStrict)
|
static InternetAddress[] |
parseHeader(java.lang.String addresses,
boolean strict)
Parse addresses out of the string. |
private java.lang.StringBuffer |
quote(java.lang.StringBuffer buf,
java.lang.String text)
Add RFC822 quotes to a String if needed. |
void |
setAddress(java.lang.String address)
Set the 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. |
private int |
skipComment(java.lang.String s,
int index)
|
private int |
skipSpace(java.lang.String s,
int index)
|
java.lang.String |
toString()
Return a string representation of this address using only US-ASCII characters. |
static java.lang.String |
toString(Address[] addresses)
Convert the supplied addresses into a single String of comma-separated text as produced by toString() . |
static java.lang.String |
toString(Address[] addresses,
int used)
Convert the supplies addresses into a String of comma-separated text, inserting line-breaks between addresses as needed to restrict the line length to 72 characters. |
java.lang.String |
toUnicodeString()
Return a string representation of this address using Unicode characters. |
void |
validate()
|
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 encodedPersonal
protected java.lang.String personal
private static final byte[] CHARMAP
private static final byte FLG_SPECIAL
private static final byte FLG_CONTROL
private static final byte FLG_SPACE
Constructor Detail |
public InternetAddress()
public InternetAddress(java.lang.String address) throws AddressException
public InternetAddress(java.lang.String address, boolean strict) throws AddressException
public InternetAddress(java.lang.String address, java.lang.String personal) throws java.io.UnsupportedEncodingException
public InternetAddress(java.lang.String address, java.lang.String personal, java.lang.String charset) throws java.io.UnsupportedEncodingException
Method Detail |
public java.lang.Object clone()
public java.lang.String getType()
getType
in class Address
public void setAddress(java.lang.String address)
address
- the address to setpublic void setPersonal(java.lang.String name, java.lang.String charset) throws java.io.UnsupportedEncodingException
name
- the new personal namecharset
- the charset to use; see MimeUtilityencodeWord
java.io.UnsupportedEncodingException
- if the name cannot be encodedpublic void setPersonal(java.lang.String name) throws java.io.UnsupportedEncodingException
MimeUtility.encodeWord(String)
; if this fails then an
UnsupportedEncodingException is thrown and no fields are modified.
name
- the new personal name
java.io.UnsupportedEncodingException
- if the name cannot be encodedpublic java.lang.String getAddress()
public java.lang.String getPersonal()
MimeUtility.decodeWord(String)
; if this is sucessful, then
the personal field is updated with that value and returned; if there is a problem
decoding the text then the raw value from encodedPersonal is returned.
private java.lang.String getEncodedPersonal()
MimeUtility.encodeWord(String)
; if this is
successful then the encodedPersonal field is updated with that value and returned;
if there is a problem encoding the text then null is returned.
private java.lang.StringBuffer quote(java.lang.StringBuffer buf, java.lang.String text)
buf
- a buffer to write intotext
- the text to quote
public java.lang.String toString()
toString
in class Address
public java.lang.String toUnicodeString()
public boolean equals(java.lang.Object o)
equals
in class Address
o
- the other object
public int hashCode()
public boolean isGroup()
phrase ":" [#mailbox] ";"
.
We check this by seeing stripping the leading phrase (which, for tolerance,
we consider optional) and then checking if the first and last characters are
':' and ';' respectively.
public InternetAddress[] getGroup(boolean strict) throws AddressException
strict
- whether strict RFC822 checking should be performed
AddressException
- if there was a problem parsing the headerpublic static InternetAddress getLocalAddress(Session session)
session
- used to obtain mail properties
public static java.lang.String toString(Address[] addresses)
toString()
.
No line-break detection is performed.
addresses
- the array of addresses to convert
public static java.lang.String toString(Address[] addresses, int used)
addresses
- the array of addresses to convertused
- the starting column
public static InternetAddress[] parse(java.lang.String addresses) throws AddressException
addresses
- the addresses to parse
AddressException
- if addresses checking failspublic static InternetAddress[] parse(java.lang.String addresses, boolean strict) throws AddressException
addresses
- the addresses to parsestrict
- if true perform detailed checking, if false just perform basic checking
AddressException
- if address checking failspublic static InternetAddress[] parseHeader(java.lang.String addresses, boolean strict) throws AddressException
addresses
- the addresses to parsestrict
- if true perform detailed checking, if false perform little checking
AddressException
- if address checking failsprivate static InternetAddress[] parse(java.lang.String addresses, boolean strict, boolean veryStrict) throws AddressException
addresses
- the string to parsestrict
- if true, performs basic address checkingveryStrict
- if true performs detailed address checking
AddressException
- if address checking failsstatic void parseHeader(java.util.List target, java.lang.String addresses, boolean strict, boolean veryStrict) throws AddressException
AddressException
private static void init(InternetAddress addr, java.lang.String text)
public void validate() throws AddressException
AddressException
private int expectPhrase(java.lang.String s, int index)
private int expectWord(java.lang.String s, int index)
private int skipSpace(java.lang.String s, int index)
private int skipComment(java.lang.String s, int index)
private static boolean isSpace(char c)
private static boolean isAtom(char c)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |