io.micronaut.email.sendgrid

Class SendGridConfigurationProperties

java.lang.Object

io.micronaut.email.sendgrid.SendGridConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, SendGridConfiguration

@Requires(property="sendgrid.api-key")
 @ConfigurationProperties(value="sendgrid")
public class SendGridConfigurationProperties
extends java.lang.Object
implements SendGridConfiguration

ConfigurationProperties implementation of SendGridConfiguration.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enable value.
static java.lang.String	PREFIX sendgrid prefix.

Constructor Summary

Constructors

Constructor and Description
SendGridConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiKey()
boolean	isEnabled()
void	setApiKey(java.lang.String apiKey)
void	setEnabled(boolean enabled) If SendGrid integration is enabled.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

sendgrid prefix.

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

Constructor Detail

SendGridConfigurationProperties

public SendGridConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

setEnabled

public void setEnabled(boolean enabled)

If SendGrid integration is enabled. Default value true

Parameters:

enabled - True if security is enabled

getApiKey

@NonNull
public java.lang.String getApiKey()

Specified by:

getApiKey in interface SendGridConfiguration

Returns:

The API (Application Programming Interface) keys to authenticate access to SendGrid service.

setApiKey

public void setApiKey(@NonNull
                      java.lang.String apiKey)

Parameters:

apiKey - The API (Application Programming Interface) keys to authenticate access to SendGrid service.