org.apache.juneau.http

Class From

java.lang.Object

org.apache.juneau.http.HeaderString

org.apache.juneau.http.From

public final class From
extends HeaderString

Represents a parsed From HTTP request header.

The email address of the user making the request.

Example

From: user@example.com

RFC2616 Specification

The From request-header field, if given, SHOULD contain an Internet e-mail address for the human user who controls the requesting user agent. The address SHOULD be machine-usable, as defined by "mailbox" in RFC 822 [9] as updated by RFC 1123 [8]:

From = "From" ":" mailbox

An example is:

From: webmaster@w3.org

This header field MAY be used for logging purposes and as a means for identifying the source of invalid or unwanted requests. It SHOULD NOT be used as an insecure form of access protection. The interpretation of this field is that the request is being performed on behalf of the person given, who accepts responsibility for the method performed. In particular, robot agents SHOULD include this header so that the person responsible for running the robot can be contacted if problems occur on the receiving end.

The Internet e-mail address in this field MAY be separate from the Internet host which issued the request. For example, when a request is passed through a proxy the original issuer's address SHOULD be used.

The client SHOULD NOT send the From header field without the user's approval, as it might conflict with the user's privacy interests or their site's security policy. It is strongly recommended that the user be able to disable, enable, and modify the value of this field at any time prior to a request.

See Also:

• Hypertext Transfer Protocol -- HTTP/1.1

Method Summary

Modifier and Type	Method and Description
static From	forString(String value) Returns a parsed From header.

Methods inherited from class org.apache.juneau.http.HeaderString

asString, eq, eqIC, toString

Methods inherited from class java.lang.Object

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

Method Detail

forString

public static From forString(String value)

Returns a parsed From header.

Parameters:

value - The From header string.

Returns:

The parsed From header, or null if the string was null.