Email.Builder (email-parent 1.3.1 API)

java.lang.Object
- io.micronaut.email.Email.Builder

Enclosing class:: Email

public static class Email.Builder
extends java.lang.Object

Email builder.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Email.Builder`	`attachment(Attachment attachment)`
`Email.Builder`	`attachment(java.util.function.Consumer<Attachment.Builder> attachment)`
`Email.Builder`	`bcc(Contact bcc)`
`Email.Builder`	`bcc(java.lang.String bcc)`
`Email.Builder`	`body(Body body)`
`Email.Builder`	`body(java.lang.String text)`
`Email.Builder`	`body(java.lang.String body, BodyType bodyType)`
`Email.Builder`	`body(java.lang.String html, java.lang.String text)`
`Email`	`build()`
`Email.Builder`	`cc(Contact cc)`
`Email.Builder`	`cc(java.lang.String cc)`
`Email.Builder`	`from(Contact from)`
`Email.Builder`	`from(java.lang.String from)`
`java.util.Optional<java.util.List<Attachment>>`	`getAttachments()`
`java.util.Optional<java.util.List<Contact>>`	`getBcc()`
`java.util.Optional<Body>`	`getBody()`
`java.util.Optional<java.util.List<Contact>>`	`getCc()`
`java.util.Optional<Contact>`	`getFrom()`
`java.util.Optional<Contact>`	`getReplyTo()`
`java.util.Optional<java.lang.String>`	`getSubject()`
`java.util.Optional<java.util.List<Contact>>`	`getTo()`
`Email.Builder`	`replyTo(Contact replyTo)`
`Email.Builder`	`replyTo(java.lang.String replyTo)`
`Email.Builder`	`subject(java.lang.String subject)`
`Email.Builder`	`to(Contact to)`
`Email.Builder`	`to(java.lang.String to)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Builder
```
public Builder()
```

Method Detail

from

@NonNull
public Email.Builder from(@NonNull
                                   java.lang.String from)

Parameters:: from - contact sending the email
Returns:: Email Builder

from

@NonNull
public Email.Builder from(@NonNull
                                   Contact from)

Parameters:: from - contact sending the email
Returns:: Email Builder

replyTo

@NonNull
public Email.Builder replyTo(@NonNull
                                      java.lang.String replyTo)

Parameters:: replyTo - Reply to contact
Returns:: Email Builder

replyTo

@NonNull
public Email.Builder replyTo(@NonNull
                                      Contact replyTo)

Parameters:: replyTo - Reply to contact
Returns:: Email Builder

to

@NonNull
public Email.Builder to(@NonNull
                                 java.lang.String to)

Parameters:: to - Recipients to
Returns:: Email Builder

to

@NonNull
public Email.Builder to(@NonNull
                                 Contact to)

Parameters:: to - Recipients to
Returns:: Email Builder

cc

@NonNull
public Email.Builder cc(@NonNull
                                 Contact cc)

Parameters:: cc - carbon copy recipient.
Returns:: Email Builder

cc

@NonNull
public Email.Builder cc(@NonNull
                                 java.lang.String cc)

Parameters:: cc - carbon copy recipient.
Returns:: Email Builder

bcc

@NonNull
public Email.Builder bcc(@NonNull
                                  Contact bcc)

Parameters:: bcc - blind carbon copy recipient.
Returns:: Email Builder

bcc

@NonNull
public Email.Builder bcc(@NonNull
                                  java.lang.String bcc)

Parameters:: bcc - blind carbon copy recipient.
Returns:: Email Builder

subject

@NonNull
public Email.Builder subject(@NonNull
                                      java.lang.String subject)

Parameters:: subject - Email subject
Returns:: Email Builder

attachment

@NonNull
public Email.Builder attachment(@NonNull
                                         Attachment attachment)

Parameters:: attachment - Email attachment
Returns:: Email Builder

attachment

@NonNull
public Email.Builder attachment(@NonNull
                                         java.util.function.Consumer<Attachment.Builder> attachment)

Parameters:: attachment - attachment builder consumer
Returns:: Email Builder

body

@NonNull
public Email.Builder body(@NonNull
                                   Body body)

Parameters:: body - Email's body
Returns:: The Email Builder

body

@NonNull
public Email.Builder body(@NonNull
                                   java.lang.String body,
                                   BodyType bodyType)

Parameters:: body - Email body; bodyType - Email body type
Returns:: The Email Builder

body

@NonNull
public Email.Builder body(@NonNull
                                   java.lang.String text)

Parameters:: text - Email body text
Returns:: The Email Builder

body

@NonNull
public Email.Builder body(@NonNull
                                   java.lang.String html,
                                   @NonNull
                                   java.lang.String text)

Parameters:: html - Email body HTML; text - Email body Text
Returns:: The Email Builder

build
```
@NonNull
public Email build()
```
Returns:

An email

getFrom

@NonNull
public java.util.Optional<Contact> getFrom()

Returns:: Email sender

getBody

@NonNull
public java.util.Optional<Body> getBody()

Returns:: Email Body

getTo

@NonNull
public java.util.Optional<java.util.List<Contact>> getTo()

Returns:: Email recipients.

getSubject

@NonNull
public java.util.Optional<java.lang.String> getSubject()

Returns:: Email's subject

getReplyTo

@NonNull
public java.util.Optional<Contact> getReplyTo()

Returns:: Email Reply-to

getCc

@NonNull
public java.util.Optional<java.util.List<Contact>> getCc()

Returns:: Email carbon copy recipients.

getBcc

@NonNull
public java.util.Optional<java.util.List<Contact>> getBcc()

Returns:: Email blind carbon copy recipients.

getAttachments

@NonNull
public java.util.Optional<java.util.List<Attachment>> getAttachments()

Returns:: Email attachments

Class Email.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

from

from

replyTo

replyTo

to

to

cc

cc

bcc

bcc

subject

attachment

attachment

body

body

body

body

build

getFrom

getBody

getTo

getSubject

getReplyTo

getCc

getBcc

getAttachments