io.micronaut.email.sendgrid

Class SendgridEmailSender

java.lang.Object

io.micronaut.email.sendgrid.SendgridEmailSender

All Implemented Interfaces:

io.micronaut.core.naming.Named, AsyncTransactionalEmailSender<com.sendgrid.Request,com.sendgrid.Response>, TransactionalEmailSender<com.sendgrid.Request,com.sendgrid.Response>

@Requires(beans={SendGridConfiguration.class,SendgridEmailComposer.class})
 @Named(value="sendgrid")
 @Singleton
public class SendgridEmailSender
extends java.lang.Object
implements TransactionalEmailSender<com.sendgrid.Request,com.sendgrid.Response>, AsyncTransactionalEmailSender<com.sendgrid.Request,com.sendgrid.Response>

SendGrid implementation of TransactionalEmailSender and AsyncTransactionalEmailSender .

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME SendgridEmailSender name.

Constructor Summary

Constructors

Constructor and Description
SendgridEmailSender(SendGridConfiguration sendGridConfiguration, SendgridEmailComposer sendgridEmailComposer)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
com.sendgrid.Response	send(@NotNull @Valid Email email, @NotNull java.util.function.Consumer<com.sendgrid.Request> emailRequest) Sends an email.
org.reactivestreams.Publisher<com.sendgrid.Response>	sendAsync(@NotNull @Valid Email email, @NotNull java.util.function.Consumer<com.sendgrid.Request> emailRequest) Sends an email.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.email.TransactionalEmailSender

send

Methods inherited from interface io.micronaut.email.AsyncTransactionalEmailSender

sendAsync

Field Detail

NAME

public static final java.lang.String NAME

SendgridEmailSender name.

See Also:

Constant Field Values

Constructor Detail

SendgridEmailSender

public SendgridEmailSender(SendGridConfiguration sendGridConfiguration,
                           SendgridEmailComposer sendgridEmailComposer)

Parameters:

sendGridConfiguration - SendGrid Configuration

sendgridEmailComposer - SendGrid Email composer

Method Detail

getName

@NonNull
public java.lang.String getName()

Specified by:

getName in interface io.micronaut.core.naming.Named

send

@NonNull
public com.sendgrid.Response send(@NonNull @NotNull @Valid
                                           @NotNull @Valid Email email,
                                           @NonNull @NotNull
                                           @NotNull java.util.function.Consumer<com.sendgrid.Request> emailRequest)
                                    throws EmailException

Description copied from interface: TransactionalEmailSender

Sends an email.

Specified by:

send in interface TransactionalEmailSender<com.sendgrid.Request,com.sendgrid.Response>

Parameters:

email - Email

emailRequest - Email Request Consumer

Returns:

Response Object or empty optional if an error occurred

Throws:

EmailException - Wrapper of any exception thrown while sending email

sendAsync

@NonNull
public org.reactivestreams.Publisher<com.sendgrid.Response> sendAsync(@NonNull @NotNull @Valid
                                                                               @NotNull @Valid Email email,
                                                                               @NonNull @NotNull
                                                                               @NotNull java.util.function.Consumer<com.sendgrid.Request> emailRequest)
                                                                        throws EmailException

Description copied from interface: AsyncTransactionalEmailSender

Sends an email.

Specified by:

sendAsync in interface AsyncTransactionalEmailSender<com.sendgrid.Request,com.sendgrid.Response>

Parameters:

email - Email

emailRequest - Email Request Consumer

Returns:

Response Object or empty optional if an error occurred

Throws:

EmailException - Wrapper of any exception thrown while sending email