goog.format.EmailAddress

Provided By	`goog.format.EmailAddress`
All Known Direct Subclasses	`goog.format.InternationalizedEmailAddress`

Formats an email address string for display, and allows for extraction of the individual components of the address.

new EmailAddress( `opt_address`, `opt_name` )

Parameters

`opt_address`	`string=`
	The email address.
`opt_name`	`string=`
	The name associated with the email address.

VIEW SOURCE

Instance Methods

Get the email address.

Parameters

None.

Returns

string

The email address.

VIEW SOURCE

Get the name associated with the email address.

Parameters

None.

Returns

string

The name or personal portion of the address.

VIEW SOURCE

Determines if the current object is a valid email address.

Parameters

None.

Returns

boolean

Whether the email address is valid.

VIEW SOURCE

Set the email address.

Parameters

`address`	`string`
	The email address.

VIEW SOURCE

Set the name associated with the email address.

Parameters

`name`	`string`
	The name to associate.

VIEW SOURCE

Return the address in a standard format:

remove extra spaces.
Surround name with quotes if it contains special characters.

Parameters

None.

Returns

string

The cleaned address.

VIEW SOURCE

Return the address in a standard format:

remove extra spaces.
Surround name with quotes if it contains special characters.

Parameters

`specialChars`	`string`
	String that contains the characters that require the display name to be quoted.

Returns

string

The cleaned address.

VIEW SOURCE

Instance Properties

The email address.

VIEW SOURCE

Static Functions

Parameters

`ch`	`string`
	The character to test.

Returns

boolean

Whether the provided character is an address separator.

VIEW SOURCE

Checks if the provided string is a valid address spec (local@domain.com).

Parameters

`str`	`string`
	The email address to check.

Returns

boolean

Whether the provided string is a valid address spec.

VIEW SOURCE

Checks if the provided string is a valid email address. Supports both simple email addresses (address specs) and addresses that contain display names.

Parameters

`str`	`string`
	The email address to check.

Returns

boolean

Whether the provided string is a valid address.

VIEW SOURCE

Checks if the provided string is a valid domain part (part after the '@') of an email address.

Parameters

`str`	`string`
	The domain part to check.

Returns

boolean

Whether the provided string is a valid domain part.

VIEW SOURCE

Checks if the provided string is a valid local part (part before the '@') of an email address.

Parameters

`str`	`string`
	The local part to check.

Returns

boolean

Whether the provided string is a valid local part.

VIEW SOURCE

Parses an email address of the form "name" <address> into an email address.

Parameters

`addr`	`string`
	The address string.

Returns

goog.format.EmailAddress

The parsed address.

VIEW SOURCE

Parses an email address of the form "name" <address> ("name" is optional) into an email address.

Parameters

`addr`	`string`
	The address string.
`ctor`	`function(new: goog.format.EmailAddress, string=, string=)`
	EmailAddress constructor to instantiate the output address.

Returns

goog.format.EmailAddress

The parsed address.

VIEW SOURCE

Parses a string containing email addresses of the form "name" <address> into an array of email addresses.

Parameters

`str`	`string`
	The address list.

Returns

Array<goog.format.EmailAddress>

The parsed emails.

VIEW SOURCE

Parse a string containing email addresses of the form "name" <address> into an array of email addresses.

Parameters

`str`	`string`
	The address list.
`parser`	`function(string): ?`
	The parser to employ.
`separatorChecker`	`function(string): boolean`
	Accepts a character and returns whether it should be considered an address separator.

Returns

Array<goog.format.EmailAddress>

The parsed emails.

VIEW SOURCE

Static Properties

Match string for characters that require display names to be quoted and are not address separators.

VIEW SOURCE

goog.format.EmailAddress

new EmailAddress( `opt_address`, `opt_name` )

Instance Methods

`this.`getAddress() `→` `string`

`this.`getName() `→` `string`

`this.`isValid() `→` `boolean`

`this.`setAddress( `address` ) `→` `void`

`this.`setName( `name` ) `→` `void`

`this.`toString() `→` `string`

`this.`toStringInternal( `specialChars` ) `→` `string`

Instance Properties

`this.`address `→` `string`

Static Functions

EmailAddress.isAddressSeparator( `ch` ) `→` `boolean`

EmailAddress.isValidAddrSpec( `str` ) `→` `boolean`

EmailAddress.isValidAddress( `str` ) `→` `boolean`

EmailAddress.isValidDomainPartSpec( `str` ) `→` `boolean`

EmailAddress.isValidLocalPartSpec( `str` ) `→` `boolean`

EmailAddress.parse( `addr` ) `→` `goog.format.EmailAddress`

EmailAddress.parseInternal( `addr`, `ctor` ) `→` `goog.format.EmailAddress`

EmailAddress.parseList( `str` ) `→` `Array<goog.format.EmailAddress>`

EmailAddress.parseListInternal( `str`, `parser`, `separatorChecker` ) `→` `Array<goog.format.EmailAddress>`

Static Properties

EmailAddress.SPECIAL_CHARS `→` `string`

goog.format.EmailAddress

new EmailAddress( opt_address, opt_name )

Instance Methods

this.getAddress() → string

this.getName() → string

this.isValid() → boolean

this.setAddress( address ) → void

this.setName( name ) → void

this.toString() → string

this.toStringInternal( specialChars ) → string

Instance Properties

this.address → string

Static Functions

EmailAddress.isAddressSeparator( ch ) → boolean

EmailAddress.isValidAddrSpec( str ) → boolean

EmailAddress.isValidAddress( str ) → boolean

EmailAddress.isValidDomainPartSpec( str ) → boolean

EmailAddress.isValidLocalPartSpec( str ) → boolean

EmailAddress.parse( addr ) → goog.format.EmailAddress

EmailAddress.parseInternal( addr, ctor ) → goog.format.EmailAddress

EmailAddress.parseList( str ) → Array<goog.format.EmailAddress>

EmailAddress.parseListInternal( str, parser, separatorChecker ) → Array<goog.format.EmailAddress>

Static Properties

EmailAddress.SPECIAL_CHARS → string

new EmailAddress( `opt_address`, `opt_name` )

`this.`getAddress() `→` `string`

`this.`getName() `→` `string`

`this.`isValid() `→` `boolean`

`this.`setAddress( `address` ) `→` `void`

`this.`setName( `name` ) `→` `void`

`this.`toString() `→` `string`

`this.`toStringInternal( `specialChars` ) `→` `string`

`this.`address `→` `string`

EmailAddress.isAddressSeparator( `ch` ) `→` `boolean`

EmailAddress.isValidAddrSpec( `str` ) `→` `boolean`

EmailAddress.isValidAddress( `str` ) `→` `boolean`

EmailAddress.isValidDomainPartSpec( `str` ) `→` `boolean`

EmailAddress.isValidLocalPartSpec( `str` ) `→` `boolean`

EmailAddress.parse( `addr` ) `→` `goog.format.EmailAddress`

EmailAddress.parseInternal( `addr`, `ctor` ) `→` `goog.format.EmailAddress`

EmailAddress.parseList( `str` ) `→` `Array<goog.format.EmailAddress>`

EmailAddress.parseListInternal( `str`, `parser`, `separatorChecker` ) `→` `Array<goog.format.EmailAddress>`

EmailAddress.SPECIAL_CHARS `→` `string`