to top
Android APIs
public class

MailTo

extends Object
java.lang.Object
   ↳ android.net.MailTo

Class Overview

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<String, String> 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 containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String MAILTO_SCHEME

Added in API level 1

Constant Value: "mailto:"

Public Methods

public String getBody ()

Added in API level 1

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

Returns
  • body or null

public String getCc ()

Added in API level 1

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
  • comma delimited email addresses or null

public Map<String, String> getHeaders ()

Added in API level 1

Retrieve all the parsed email headers from the mailto URL

Returns
  • map containing all parsed values

public String getSubject ()

Added in API level 1

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

Returns
  • subject or null

public String getTo ()

Added in API level 1

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
  • comma delimited email addresses or null

public static boolean isMailTo (String url)

Added in API level 1

Test to see if the given string is a mailto URL

Parameters
url string to be tested
Returns
  • true if the string is a mailto URL

public static MailTo parse (String url)

Added in API level 1

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 containing a mailto URL
Returns
  • MailTo object
Throws
ParseException if the scheme is not a mailto URL

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

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

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.