Message.MessageBuilder (com.mailgun:mailgun-java 1.0.6 API)

java.lang.Object
- com.mailgun.model.message.Message.MessageBuilder

Enclosing class:: Message

public static class Message.MessageBuilder
extends Object

Constructor Summary

Constructors
Constructor and Description

MessageBuilder()

Constructors
Constructor and Description
`MessageBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Message.MessageBuilder`	`attachment(File attachment)` File attachment.
`Message.MessageBuilder`	`attachment(List<File> attachments)` File attachment.
`Message.MessageBuilder`	`bcc(List<String> bcc)` Same as `to(java.lang.String)` but for Bcc.
`Message.MessageBuilder`	`bcc(String bcc)` Same as `to(java.lang.String)` but for Bcc.
`Message.MessageBuilder`	`cc(List<String> cc)` Same as `to(java.lang.String)` but for Cc.
`Message.MessageBuilder`	`cc(String cc)` Same as `to(java.lang.String)` but for Cc.
`Message.MessageBuilder`	`deliveryTime(java.time.ZonedDateTime deliveryTime)` Desired time of delivery.
`Message.MessageBuilder`	`dkim(boolean enableDKIM)` Enables/disables DKIM signatures on per-message basis.
`Message.MessageBuilder`	`formData(feign.form.FormData attachment)` File attachment in form of `FormData`.
`Message.MessageBuilder`	`formData(List<feign.form.FormData> attachments)` File attachment in form of `FormData`.
`Message.MessageBuilder`	`inline(File attachment)` Attachment with inline disposition.
`Message.MessageBuilder`	`inline(List<File> attachments)` Attachments with inline disposition.
`Message.MessageBuilder`	`mailgunVariables(Map<String,Object> mailgunVariables)` Mailgun’s templates use a fork of the very popular template engine handlebars.
`Message.MessageBuilder`	`myVar(Map<String,Object> myVar)` Allows to attach a custom data to the message
`Message.MessageBuilder`	`recipientVariables(Map<String,Object> recipientVariables)` A dictionary, where the key is a plain recipient address and the value is a dictionary with variables that can be referenced in the message body.
`Message.MessageBuilder`	`renderTemplate(boolean renderTemplate)` Rendered template in the text part of the message in case of template sending.
`Message.MessageBuilder`	`replyTo(String replyTo)` Specify Reply-To address
`Message.MessageBuilder`	`requireTls(boolean requireTLS)` If set to `true` this requires the message only be sent over a TLS connection.
`Message.MessageBuilder`	`skipVerification(boolean skipVerification)` If set to `true`, the certificate and hostname will not be verified when trying to establish a TLS connection and Mailgun will accept any certificate during delivery.
`Message.MessageBuilder`	`tag(List<String> tags)` Tag string.
`Message.MessageBuilder`	`tag(String tag)` Tag string.
`Message.MessageBuilder`	`testMode(boolean enableSendingInTestMode)` Enables sending in test mode.
`Message.MessageBuilder`	`to(List<String> to)` Email addresses of the recipient
`Message.MessageBuilder`	`to(String to)` Email address of the recipient
`Message.MessageBuilder`	`tracking(boolean toggleTracking)` Toggles tracking on a per-message basis.
`Message.MessageBuilder`	`trackingClicks(YesNoHtml yesNoHtml)` Toggles clicks tracking on a per-message basis.
`Message.MessageBuilder`	`trackingOpens(boolean toggleOpensTracking)` Toggles opens tracking on a per-message basis.

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

- Constructor Detail
  - MessageBuilder
```
public MessageBuilder()
```
- Method Detail
  - to
```
public Message.MessageBuilder to(String to)
```
    Email address of the recipient
    
    Parameters:
    
    to - Email address of the recipient
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - to
```
public Message.MessageBuilder to(List<String> to)
```
    Email addresses of the recipient
    
    Parameters:
    
    to - Email addresses of the recipient
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cc
```
public Message.MessageBuilder cc(String cc)
```
    Same as to(java.lang.String) but for Cc.
    
    Parameters:
    
    cc - Same as to(java.lang.String) but for Cc.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cc
```
public Message.MessageBuilder cc(List<String> cc)
```
    Same as to(java.lang.String) but for Cc.
    
    Parameters:
    
    cc - Same as to(java.lang.String) but for Cc.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - bcc
```
public Message.MessageBuilder bcc(String bcc)
```
    Same as to(java.lang.String) but for Bcc.
    
    Parameters:
    
    bcc - Same as to(java.lang.String) but for Bcc.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - bcc
```
public Message.MessageBuilder bcc(List<String> bcc)
```
    Same as to(java.lang.String) but for Bcc.
    
    Parameters:
    
    bcc - Same as to(java.lang.String) but for Bcc.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attachment
```
public Message.MessageBuilder attachment(File attachment)
```
    File attachment. You can post multiple attachment values.
    
    Parameters:
    
    attachment - File attachment
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attachment
```
public Message.MessageBuilder attachment(List<File> attachments)
```
    File attachment. You can post multiple attachment values.
    
    Parameters:
    
    attachments - File attachments
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - formData
```
public Message.MessageBuilder formData(feign.form.FormData attachment)
```
    File attachment in form of FormData. This object encapsulates a byte array and its associated content type.
    You can post multiple attachment values.
    
    Parameters:
    
    attachment - attachment in form of FormData.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - formData
```
public Message.MessageBuilder formData(List<feign.form.FormData> attachments)
```
    File attachment in form of FormData. This object encapsulates a byte array and its associated content type.
    You can post multiple attachment values.
    
    Parameters:
    
    attachments - attachments in form of FormData.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - inline
```
public Message.MessageBuilder inline(File attachment)
```
    Attachment with inline disposition. You can post multiple inline values.
    
    Parameters:
    
    attachment - Attachment with inline disposition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - inline
```
public Message.MessageBuilder inline(List<File> attachments)
```
    Attachments with inline disposition. You can post multiple inline values.
    
    Parameters:
    
    attachments - Attachments with inline disposition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - renderTemplate
```
public Message.MessageBuilder renderTemplate(boolean renderTemplate)
```
    Rendered template in the text part of the message in case of template sending.
    
    Parameters:
    
    renderTemplate - Pass true if you want to have rendered template in the text part of the message in case of template sending.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tag
```
public Message.MessageBuilder tag(String tag)
```
    Tag string.
    
    Parameters:
    
    tag - Tag string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Tagging
  - tag
```
public Message.MessageBuilder tag(List<String> tags)
```
    Tag string.
    
    Parameters:
    
    tags - Tag strings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Tagging
  - dkim
```
public Message.MessageBuilder dkim(boolean enableDKIM)
```
    Enables/disables DKIM signatures on per-message basis.
    
    Parameters:
    
    enableDKIM - Enables/disables DKIM signatures on per-message basis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - deliveryTime
```
public Message.MessageBuilder deliveryTime(java.time.ZonedDateTime deliveryTime)
```
    Desired time of delivery.
    
    Note: Messages can be scheduled for a maximum of 3 days in the future.
    
    Parameters:
    
    deliveryTime - Desired time of delivery.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - testMode
```
public Message.MessageBuilder testMode(boolean enableSendingInTestMode)
```
    Enables sending in test mode.
    
    Parameters:
    
    enableSendingInTestMode - Enables sending in test mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Sending in Test Mode
  - tracking
```
public Message.MessageBuilder tracking(boolean toggleTracking)
```
    Toggles tracking on a per-message basis.
    
    Parameters:
    
    toggleTracking - Toggles tracking on a per-message basis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Tracking Messages
  - trackingClicks
```
public Message.MessageBuilder trackingClicks(YesNoHtml yesNoHtml)
```
    Toggles clicks tracking on a per-message basis. Has higher priority than domain-level setting.
    
    Pass TRUE, FALSE or HTML_ONLY
    
    Parameters:
    
    yesNoHtml - YesNoHtml
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - trackingOpens
```
public Message.MessageBuilder trackingOpens(boolean toggleOpensTracking)
```
    Toggles opens tracking on a per-message basis. Has higher priority than domain-level setting.
    
    Parameters:
    
    toggleOpensTracking - Toggles opens tracking on a per-message basis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - requireTls
```
public Message.MessageBuilder requireTls(boolean requireTLS)
```
    If set to true this requires the message only be sent over a TLS connection. If a TLS connection can not be established, Mailgun will not deliver the message.
    If set to false Mailgun will still try and upgrade the connection, but if Mailgun can not, the message will be delivered over a plaintext SMTP connection.
    The default is false.
    
    Parameters:
    
    requireTLS - requires TLS
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - skipVerification
```
public Message.MessageBuilder skipVerification(boolean skipVerification)
```
    If set to true, the certificate and hostname will not be verified when trying to establish a TLS connection and Mailgun will accept any certificate during delivery.
    If set to false, Mailgun will verify the certificate and hostname. If either one can not be verified, a TLS connection will not be established.
    The default is false.
    
    Parameters:
    
    skipVerification - skip verification certificate and hostname
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replyTo
```
public Message.MessageBuilder replyTo(String replyTo)
```
    Specify Reply-To address
    
    Parameters:
    
    replyTo - Reply-To address
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - recipientVariables
```
public Message.MessageBuilder recipientVariables(Map<String,Object> recipientVariables)
```
    A dictionary, where the key is a plain recipient address and the value is a dictionary with variables that can be referenced in the message body.
    
    Parameters:
    
    recipientVariables - A dictionary, where the key is a plain recipient address and the value is a dictionary with variables that can be referenced in the message body.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Batch Sending
  - myVar
```
public Message.MessageBuilder myVar(Map<String,Object> myVar)
```
    Allows to attach a custom data to the message
    
    Parameters:
    
    myVar - dictionary
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - mailgunVariables
```
public Message.MessageBuilder mailgunVariables(Map<String,Object> mailgunVariables)
```
    Mailgun’s templates use a fork of the very popular template engine handlebars.
    
    Use this field to provide values for a substitution to render them in the template.
    
    Parameters:
    
    mailgunVariables - A dictionary where the key is a placeholder and the value is a value for a substitution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Class Message.MessageBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessageBuilder

Method Detail

to

to

cc

cc

bcc

bcc

attachment

attachment

formData

formData

inline

inline

renderTemplate

tag

tag

dkim

deliveryTime

testMode

tracking

trackingClicks

trackingOpens

requireTls

skipVerification

replyTo

recipientVariables

myVar

mailgunVariables