SendTemplate

Mandrill Templates

Modelling the responses/requests for the /messages/send-template.json method

Every template defined in mandrill is represented by its own type.

A template has a name and a message object, which is represented by net.gutefrage.mandrill.messages.SendTemplate.Message.

The message object defines:

- the recipients - the recipients individual merge_vars (placeholders) - the global_merge_vars that are inserted in each template

JSON format

This is the minimal format that gets generated by our API

{
   "key": "the-api-key",
   "subject": "optional subject to override defaults in mandrill template",
   "template_name": "template-name",
   "template_content": [],
   "send_at": "YYYY-MM-DD HH:MM:SS",
   "message": {
     "to": [{
         "email": "test@example.com"
     }],
     "merge_vars": [
       {
         "rcpt": "test@example.com",
         "vars": [
            {
              "name": "SOME_LINK",
              "content": "https://www.example.com"
            }
         ]
       }
     ]
   }
}

key: A valid API key
template_name: The immutable name or slug of a template that exists in the user's account. For backwards-compatibility, the template name may also be used but the immutable slug is preferred.
template_content: Additional template content
message: An array of template content to send. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block
send_at: When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance.

See also: https://mandrillapp.com/api/docs/messages.JSON.html#method=send-template
https://mandrillapp.com/templates

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new SendTemplate(key: MandrillApiKey, template_name: TemplateName, to: Seq[Recipient] = Nil, template_content: Seq[TemplateContent] = Nil, message: Message = SendTemplate.Message(), send_at: Option[MandrillDateTime] = None)

key
A valid API key
template_name
The immutable name or slug of a template that exists in the user's account. For backwards-compatibility, the template name may also be used but the immutable slug is preferred.
template_content
Additional template content
message
An array of template content to send. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block
send_at
When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bcc(email: String, mergeVars: (String, String)*): SendTemplate

Adds a new recipient for this template with header type BCC.
Adds a new recipient for this template with header type BCC.
TODO write usage examples
email
Recipient email
mergeVars
Optional variables for this recipient
returns
A new template with the recipient added
def cc(email: String, mergeVars: (String, String)*): SendTemplate

Adds a new recipient for this template with header type CC.
Adds a new recipient for this template with header type CC.
TODO write usage examples
email
Recipient email
mergeVars
Optional variables for this recipient
returns
A new template with the recipient added
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val key: MandrillApiKey

A valid API key
val message: Message

An array of template content to send.
An array of template content to send. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def sendAt(schedule: DateTime): SendTemplate

Schedules this template at the given point in time.
Schedules this template at the given point in time. If you specify a time in the past, the message will be sent immediately.
An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance.
schedule
The time the message should be sent
returns
A new template with sendAt date
val send_at: Option[MandrillDateTime]

When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format.
When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def templateContent(first: (String, String), rest: (String, String)*): SendTemplate

Adds template contents to this template
Adds template contents to this template
TODO write usage examples
first
first template content item
rest
optional other template content items
returns
A new template with template content items added
val template_content: Seq[TemplateContent]

Additional template content
val template_name: TemplateName

The immutable name or slug of a template that exists in the user's account.
The immutable name or slug of a template that exists in the user's account. For backwards-compatibility, the template name may also be used but the immutable slug is preferred.
def to(email: String, mergeVars: (String, String)*): SendTemplate

Adds a new recipient for this template.
Adds a new recipient for this template.
TODO write usage examples
email
Recipient email
mergeVars
Optional variables for this recipient
returns
A new template with the recipient added
def to(recipient: Recipient, mergeVars: Seq[MergeVar] = Nil): SendTemplate

Adds a new recipient for this template.
Adds a new recipient for this template.
TODO write usage examples
recipient
New recipient
mergeVars
Optional variables for this recipient
returns
A new template with the recipient added
val to: Seq[Recipient]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object SendTemplate | package messages

case class SendTemplate(key: MandrillApiKey, template_name: TemplateName, to: Seq[Recipient] = Nil, template_content: Seq[TemplateContent] = Nil, message: Message = SendTemplate.Message(), send_at: Option[MandrillDateTime] = None) extends Product with Serializable

Mandrill Templates

JSON format

Instance Constructors

new SendTemplate(key: MandrillApiKey, template_name: TemplateName, to: Seq[Recipient] = Nil, template_content: Seq[TemplateContent] = Nil, message: Message = SendTemplate.Message(), send_at: Option[MandrillDateTime] = None)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def bcc(email: String, mergeVars: (String, String)*): SendTemplate

def cc(email: String, mergeVars: (String, String)*): SendTemplate

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val key: MandrillApiKey

val message: Message

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def sendAt(schedule: DateTime): SendTemplate

val send_at: Option[MandrillDateTime]

final def synchronized[T0](arg0: ⇒ T0): T0

def templateContent(first: (String, String), rest: (String, String)*): SendTemplate

val template_content: Seq[TemplateContent]

val template_name: TemplateName

def to(email: String, mergeVars: (String, String)*): SendTemplate

def to(recipient: Recipient, mergeVars: Seq[MergeVar] = Nil): SendTemplate

val to: Seq[Recipient]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped