Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: update javadoc macros

...

Advanced Tables - Table Plus
enableHeadingAttributesfalse
enableSortingfalse
classm5-configuration-tree
enableHighlightingfalse


Node name

Mgnl f
modules

Mgnl f
mail

Mgnl f
apps

Mgnl f
fieldTypes

Mgnl f
config

Mgnl f
commands


Mail command

Javadoc
rangeHigherVersion5.5
className0info.magnolia.module.mail.commands.MailCommand
renderTypeasynchronous
is used to send all mails in Magnolia. The command can execute on events such as user actions, workflow steps and scheduled jobs. You can write message templates and test them manually in the Mail tools app before automating the process for production use.

...

Templates are configured in /modules/mail/config/templateConfiguration. The testFreemarker template is provided as an example.

Javadoc
rangeHigherVersion5.5
className0info.magnolia.module.mail.MailTemplate
renderTypeasynchronous
allows for a number of configuration nodes and properties. The following are the most commonly used:

...

templatesConfiguration

required

Templates configuration node.

<template name>

required

Template name.

attachments

optional

Javadoc
rangeHigherVersion5.5
className0info.magnolia.module.mail.templates.MailAttachment
renderTypeasynchronous
 provides for a number of attachment options.

parameters

optional

Any parameters to be passed to the script.

templateFile

required

Relative path to the template script. 

type

required

Scripting language used in the template.

contentType

optional

Type of content for the message body. It is only necessary to include this property for HTML emails.

from

optional

Email address that will appear in the From field of the message, unless defined elsewhere, for example in Form module.

subject

optional

Subject line of the email, unless defined elsewhere for example in the Form module.

...

The mimeMultipart property can be used to define the structure of a

Javadoc
rangeHigherVersion5.5
className0info.magnolia.module.mail.templates.MgnlMultipartEmail
renderTypeasynchronous
 :

Advanced Tables - Table Plus
enableHeadingAttributesfalse
enableSortingfalse
classm5-configuration-tree
enableHighlightingfalse


Node nameValue

Mgnl n
<template configuration>

 

Mgnl n
attachments

 

Mgnl n
<attachment name>

 

Mgnl p
mimeMultipart

mixed

Mgnl p
url

 http://www.magnolia-cms.com/.imaging/amplify-miami-2014/imageForTeaserBinary/miami.png

Mgnl n
<attachment name>

 

Mgnl p
mimeMultipart

related

Mgnl p
url

 http://www.magnolia-cms.com/.imaging/amplify-miami-2014/imageForTeaserBinary/miami.png


...

<attachment name>

optional

Attachment name.

mimeMulitpart

optional, default is related

Defines the structure of a 

Javadoc
rangeHigherVersion5.5
className0info.magnolia.module.mail.templates.MgnlMultipartEmail
renderTypeasynchronous
.

Values:

  • mixed: Standard email attachment.
  • related: Attachment shown inline.

MailAttachment does not use Content-ID properties but uses attachment names (not file names).

...