Most visited

Recently visited

Added in API level 1

MailTo

public class MailTo
extends Object

java.lang.Object
   ↳ android.net.MailTo


MailTo URL parser This class parses a mailto scheme URL and then can be queried for the parsed parameters. This implements RFC 2368.

Summary

Constants

String MAILTO_SCHEME

Public methods

String getBody()

Retrieve the body line from the parsed mailto URL.

String getCc()

Retrieve the CC address line from the parsed mailto URL.

Map<StringString> getHeaders()

Retrieve all the parsed email headers from the mailto URL

String getSubject()

Retrieve the subject line from the parsed mailto URL.

String getTo()

Retrieve the To address line from the parsed mailto URL.

static boolean isMailTo(String url)

Test to see if the given string is a mailto URL

static MailTo parse(String url)

Parse and decode a mailto scheme string.

String toString()

Returns a string representation of the object.

Inherited methods

From class java.lang.Object

Constants

MAILTO_SCHEME

Added in API level 1
String MAILTO_SCHEME

Constant Value: "mailto:"

Public methods

getBody

Added in API level 1
String getBody ()

Retrieve the body line from the parsed mailto URL. If no body line was specified, then null is return

Returns
String body or null

getCc

Added in API level 1
String getCc ()

Retrieve the CC address line from the parsed mailto URL. This could be several email address that are comma-space delimited. If no CC line was specified, then null is return

Returns
String comma delimited email addresses or null

getHeaders

Added in API level 1
Map<StringString> getHeaders ()

Retrieve all the parsed email headers from the mailto URL

Returns
Map<StringString> map containing all parsed values

getSubject

Added in API level 1
String getSubject ()

Retrieve the subject line from the parsed mailto URL. If no subject line was specified, then null is return

Returns
String subject or null

getTo

Added in API level 1
String getTo ()

Retrieve the To address line from the parsed mailto URL. This could be several email address that are comma-space delimited. If no To line was specified, then null is return

Returns
String comma delimited email addresses or null

isMailTo

Added in API level 1
boolean isMailTo (String url)

Test to see if the given string is a mailto URL

Parameters
url String: string to be tested
Returns
boolean true if the string is a mailto URL

parse

Added in API level 1
MailTo parse (String url)

Parse and decode a mailto scheme string. This parser implements RFC 2368. The returned object can be queried for the parsed parameters.

Parameters
url String: String containing a mailto URL
Returns
MailTo MailTo object
Throws
ParseException if the scheme is not a mailto URL

toString

Added in API level 1
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

Hooray!