Package io.micronaut.email.configuration

Class FromConfigurationProperties

java.lang.Object

io.micronaut.email.configuration.FromConfigurationProperties

All Implemented Interfaces:

FromConfiguration

@Requires(property="micronaut.email.from.email")
@ConfigurationProperties("micronaut.email.from")
public class FromConfigurationProperties
extends Object
implements FromConfiguration

ConfigurationProperties implementation of FromConfiguration.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	From configuration prefix.

Constructor Summary

Constructors

Constructor	Description
FromConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
@NonNull String	getEmail()
@NonNull Contact	getFrom()
@Nullable String	getName()	The name of the contact sending the email.
void	setEmail(@NonNull String email)	Default from email address.
void	setName(@Nullable String name)

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

From configuration prefix.

See Also:

• Constant Field Values

Constructor Details

FromConfigurationProperties

public FromConfigurationProperties()

Method Details

getEmail

@NonNull
public @NonNull String getEmail()

Returns:

email address of the contact sending the email.

setEmail

public void setEmail(@NonNull
 @NonNull String email)

Default from email address.

Parameters:

email - From email address.

getName

@Nullable
public @Nullable String getName()

The name of the contact sending the email.

Returns:

name of the contact sending the email.

setName

public void setName(@Nullable
 @Nullable String name)

Parameters:

name - From name

getFrom

@NonNull
public @NonNull Contact getFrom()

Specified by:

getFrom in interface FromConfiguration

Returns:

Contact of the person sending the email.