MailMessageBuilder (mail 4.0.0 API)

grails.plugins.mail.MailMessageBuilder

```
@groovy.util.logging.Slf4j
@groovy.transform.CompileStatic
class MailMessageBuilder
extends java.lang.Object
```
Provides a DSL style interface to mail message sending/generation. If the builder is constructed without a MailMessageContentRenderer, it is incapable of rendering GSP views into message content.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`private static class`	`MailMessageBuilder.Inline`

Field Summary

Fields
Modifiers	Name	Description
`private boolean`	`async`
`private java.lang.String`	`defaultFrom`
`private java.lang.String`	`defaultTo`
`private java.lang.String`	`envelopeFrom`
`private MimeMessageHelper`	`helper`
`private java.lang.String`	`htmlContent`
`private java.util.List<Inline>`	`inlines`
`private java.util.Locale`	`locale`
`private MailMessageContentRenderer`	`mailMessageContentRenderer`
`private MailSender`	`mailSender`
`private MailMessage`	`message`
`private int`	`multipart`
`private java.lang.String`	`overrideAddress`
`private java.lang.String`	`textContent`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`defaultFrom`
`java.lang.String`	`defaultTo`
`MailMessageContentRenderer`	`mailMessageContentRenderer`
`MailSender`	`mailSender`
`java.lang.String`	`overrideAddress`

Constructor Summary

Constructors
Constructor and description
`MailMessageBuilder (MailSender mailSender, MailConfigurationProperties properties, MailMessageContentRenderer mailMessageContentRenderer)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`async(boolean async)`
	`void`	`attach(java.lang.String fileName, java.lang.String contentType, byte[] bytes)`
	`void`	`attach(java.io.File file)`
	`void`	`attach(java.lang.String fileName, java.io.File file)`
	`void`	`attach(java.lang.String fileName, java.lang.String contentType, java.io.File file)`
	`void`	`attach(java.lang.String fileName, java.lang.String contentType, InputStreamSource source)`
	`void`	`attachBytes(java.lang.String fileName, java.lang.String contentType, byte[] bytes)` deprecated: use attach(String, String, byte[])
	`void`	`bcc(java.lang.Object[] args)`
	`void`	`bcc(java.util.List args)`
	`void`	`body(java.lang.CharSequence body)`
	`void`	`body(java.util.Map params)`
	`void`	`cc(java.lang.Object[] args)`
	`void`	`cc(java.util.List args)`
	`protected java.lang.Object`	`doAdd(java.lang.String id, java.lang.String contentType, InputStreamSource toAdd, boolean isAttachment)`
	`protected MailMessageContentRender`	`doRender(java.util.Map params)`
	`void`	`envelopeFrom(java.lang.CharSequence envFrom)`
	`MailMessage`	`finishMessage()`
	`void`	`from(java.lang.CharSequence from)`
	`protected static java.lang.Object`	`getDescription(SimpleMailMessage message)`
	`protected static java.lang.Object`	`getDescription(Message message)`
	`protected static java.lang.Object`	`getDescription(MimeMailMessage message)`
	`private MailMessage`	`getMessage()`
	`void`	`headers(java.util.Map headers)`
	`void`	`html(java.util.Map params)`
	`void`	`html(java.lang.CharSequence text)`
	`void`	`inline(java.lang.String contentId, java.lang.String contentType, byte[] bytes)`
	`void`	`inline(java.io.File file)`
	`void`	`inline(java.lang.String fileName, java.io.File file)`
	`void`	`inline(java.lang.String contentId, java.lang.String contentType, java.io.File file)`
	`void`	`inline(java.lang.String contentId, java.lang.String contentType, InputStreamSource source)`
	`boolean`	`isMimeCapable()`
	`void`	`locale(java.lang.String localeStr)`
	`void`	`locale(java.util.Locale locale)`
	`void`	`multipart(boolean multipart)`
	`void`	`multipart(int multipartMode)`
	`void`	`replyTo(java.lang.CharSequence replyTo)`
	`private void`	`send(java.lang.Object message)` Method to send messages of any type.
	`MailMessage`	`sendMessage(java.util.concurrent.ExecutorService executorService)`
	`void`	`subject(java.lang.CharSequence title)`
	`void`	`text(java.util.Map params)`
	`void`	`text(java.lang.CharSequence text)`
	`void`	`title(java.lang.CharSequence title)`
	`void`	`to(java.lang.Object[] args)`
	`void`	`to(java.util.List args)`
	`protected java.lang.String[]`	`toDestinationAddresses(java.lang.Object addresses)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - private boolean async
  - private final java.lang.String defaultFrom
  - private final java.lang.String defaultTo
  - private java.lang.String envelopeFrom
  - private MimeMessageHelper helper
  - private java.lang.String htmlContent
  - private java.util.List<Inline> inlines
  - private java.util.Locale locale
  - private final MailMessageContentRenderer mailMessageContentRenderer
  - private final MailSender mailSender
  - private MailMessage message
  - private int multipart
  - private final java.lang.String overrideAddress
  - private java.lang.String textContent
- Property Detail
  - final java.lang.String defaultFrom
  - final java.lang.String defaultTo
  - final MailMessageContentRenderer mailMessageContentRenderer
  - final MailSender mailSender
  - final java.lang.String overrideAddress
- Constructor Detail
  - MailMessageBuilder(MailSender mailSender, MailConfigurationProperties properties, MailMessageContentRenderer mailMessageContentRenderer)
- Method Detail
  - void async(boolean async)
  - void attach(java.lang.String fileName, java.lang.String contentType, byte[] bytes)
  - void attach(java.io.File file)
  - void attach(java.lang.String fileName, java.io.File file)
  - void attach(java.lang.String fileName, java.lang.String contentType, java.io.File file)
  - void attach(java.lang.String fileName, java.lang.String contentType, InputStreamSource source)
  - void attachBytes(java.lang.String fileName, java.lang.String contentType, byte[] bytes)
    
    deprecated:
    use attach(String, String, byte[])
  - void bcc(java.lang.Object[] args)
  - void bcc(java.util.List args)
  - void body(java.lang.CharSequence body)
  - void body(java.util.Map params)
  - void cc(java.lang.Object[] args)
  - void cc(java.util.List args)
  - protected java.lang.Object doAdd(java.lang.String id, java.lang.String contentType, InputStreamSource toAdd, boolean isAttachment)
  - protected MailMessageContentRender doRender(java.util.Map params)
  - void envelopeFrom(java.lang.CharSequence envFrom)
  - MailMessage finishMessage()
  - void from(java.lang.CharSequence from)
  - protected static java.lang.Object getDescription(SimpleMailMessage message)
  - protected static java.lang.Object getDescription(Message message)
  - protected static java.lang.Object getDescription(MimeMailMessage message)
  - private MailMessage getMessage()
  - void headers(java.util.Map headers)
  - void html(java.util.Map params)
  - void html(java.lang.CharSequence text)
  - void inline(java.lang.String contentId, java.lang.String contentType, byte[] bytes)
  - void inline(java.io.File file)
  - void inline(java.lang.String fileName, java.io.File file)
  - void inline(java.lang.String contentId, java.lang.String contentType, java.io.File file)
  - void inline(java.lang.String contentId, java.lang.String contentType, InputStreamSource source)
  - boolean isMimeCapable()
  - void locale(java.lang.String localeStr)
  - void locale(java.util.Locale locale)
  - void multipart(boolean multipart)
  - void multipart(int multipartMode)
  - void replyTo(java.lang.CharSequence replyTo)
  - @groovy.transform.CompileDynamic private void send(java.lang.Object message)
    
    Method to send messages of any type. This method is dynamically compiled to avoid the need to cast the mail sender and message to the correct types.
    Parameters:
    message - Any type of message
  - MailMessage sendMessage(java.util.concurrent.ExecutorService executorService)
  - void subject(java.lang.CharSequence title)
  - void text(java.util.Map params)
  - void text(java.lang.CharSequence text)
  - void title(java.lang.CharSequence title)
  - void to(java.lang.Object[] args)
  - void to(java.util.List args)
  - protected java.lang.String[] toDestinationAddresses(java.lang.Object addresses)

Groovy Documentation

[Groovy] Class MailMessageBuilder

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private boolean async

private final java.lang.String defaultFrom

private final java.lang.String defaultTo

private java.lang.String envelopeFrom

private MimeMessageHelper helper

private java.lang.String htmlContent

private java.util.List<Inline> inlines

private java.util.Locale locale

private final MailMessageContentRenderer mailMessageContentRenderer

private final MailSender mailSender

private MailMessage message

private int multipart

private final java.lang.String overrideAddress

private java.lang.String textContent

Property Detail

final java.lang.String defaultFrom

final java.lang.String defaultTo

final MailMessageContentRenderer mailMessageContentRenderer

final MailSender mailSender

final java.lang.String overrideAddress

Constructor Detail

MailMessageBuilder(MailSender mailSender, MailConfigurationProperties properties, MailMessageContentRenderer mailMessageContentRenderer)

Method Detail

void async(boolean async)

void attach(java.lang.String fileName, java.lang.String contentType, byte[] bytes)

void attach(java.io.File file)

void attach(java.lang.String fileName, java.io.File file)

void attach(java.lang.String fileName, java.lang.String contentType, java.io.File file)

void attach(java.lang.String fileName, java.lang.String contentType, InputStreamSource source)

void attachBytes(java.lang.String fileName, java.lang.String contentType, byte[] bytes)

void bcc(java.lang.Object[] args)

void bcc(java.util.List args)

void body(java.lang.CharSequence body)

void body(java.util.Map params)

void cc(java.lang.Object[] args)

void cc(java.util.List args)

protected java.lang.Object doAdd(java.lang.String id, java.lang.String contentType, InputStreamSource toAdd, boolean isAttachment)

protected MailMessageContentRender doRender(java.util.Map params)

void envelopeFrom(java.lang.CharSequence envFrom)

MailMessage finishMessage()

void from(java.lang.CharSequence from)

protected static java.lang.Object getDescription(SimpleMailMessage message)

protected static java.lang.Object getDescription(Message message)

protected static java.lang.Object getDescription(MimeMailMessage message)

private MailMessage getMessage()

void headers(java.util.Map headers)

void html(java.util.Map params)

void html(java.lang.CharSequence text)

void inline(java.lang.String contentId, java.lang.String contentType, byte[] bytes)

void inline(java.io.File file)

void inline(java.lang.String fileName, java.io.File file)

void inline(java.lang.String contentId, java.lang.String contentType, java.io.File file)

void inline(java.lang.String contentId, java.lang.String contentType, InputStreamSource source)

boolean isMimeCapable()

void locale(java.lang.String localeStr)

void locale(java.util.Locale locale)

void multipart(boolean multipart)

void multipart(int multipartMode)

void replyTo(java.lang.CharSequence replyTo)

@groovy.transform.CompileDynamic private void send(java.lang.Object message)

MailMessage sendMessage(java.util.concurrent.ExecutorService executorService)

void subject(java.lang.CharSequence title)

void text(java.util.Map params)

void text(java.lang.CharSequence text)

void title(java.lang.CharSequence title)

void to(java.lang.Object[] args)

void to(java.util.List args)

protected java.lang.String[] toDestinationAddresses(java.lang.Object addresses)