io.micronaut.email

Class Contact

java.lang.Object

io.micronaut.email.Contact

@Introspected
public class Contact
extends java.lang.Object

Class representing the person who receives an email.

Since:

1.0.0

Author:

Sergio del Amo

Constructor Summary

Constructors

Constructor and Description
Contact(java.lang.String email)
Contact(java.lang.String email, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getEmail()
java.lang.String	getName()
java.lang.String	getNameAddress() returns name-addr for a Contact.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Contact

public Contact(@NonNull
               java.lang.String email)

Parameters:

email - Contact's email.

Contact

public Contact(@NonNull
               java.lang.String email,
               @Nullable
               java.lang.String name)

Parameters:

email - Recipient's email.

name - Recipient's name.

Method Detail

getEmail

public java.lang.String getEmail()

Returns:

Recipient's email.

getName

@Nullable
public java.lang.String getName()

Returns:

Recipient's name

getNameAddress

@NonNull
public java.lang.String getNameAddress()

returns name-addr for a Contact. Given: Contact(email: 'johnsnow@example.com, name: John Snow) When: Contact::getNameAddress() Then: John Snow Given: Contact(email: 'johnsnow@example.com, name: null) When: Contact::getNameAddress() Then:

Returns:

An optional name that indicates the name of the recipient that could be displayed to the user of a mail application, and the email address enclosed in angle brackets

See Also:

Address Specification

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object