MailTemplate (Magnolia Mail module 5.5.3 API)

java.lang.Object
- info.magnolia.module.mail.MailTemplate

```
public class MailTemplate
extends Object
```
Mail template used to send emails with Magnolia.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MAIL_ATTACHMENTS`
`static String`	`MAIL_BODY`
`static String`	`MAIL_CC`
`static String`	`MAIL_CONTENT_TYPE`
`static String`	`MAIL_FROM`
`static String`	`MAIL_HTML`
`static String`	`MAIL_PARAMETERS`
`static String`	`MAIL_SUBJECT`
`static String`	`MAIL_TEMPLATE_FILE`
`static String`	`MAIL_TO`
`static String`	`MAIL_TO_WORKFLOW`
`static String`	`MAIL_TYPE`

Constructor Summary

Constructors
Constructor and Description

MailTemplate()
Deprecated.
since 5.5. Use MailTemplate(MailModule) instead.

MailTemplate(MailModule mailModule)

Constructors
Constructor and Description
`MailTemplate()` Deprecated. since 5.5. Use `MailTemplate(MailModule)` instead.
`MailTemplate(MailModule mailModule)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttachment(MailAttachment attachment)`
`List<MailAttachment>`	`getAttachments()`
`String`	`getBcc()`
`String`	`getCc()`
`String`	`getContentType()`
`String`	`getFrom()`
`String`	`getName()`
`Map<String,Object>`	`getParameters()`
`String`	`getPassword()`
`String`	`getReplyTo()`
`String`	`getSubject()`
`String`	`getTemplateFile()`
`String`	`getText()`
`String`	`getTo()`
`String`	`getType()`
`String`	`getUsername()`
`javax.mail.Session`	`initSession()`
`void`	`setAttachments(List<MailAttachment> attachments)`
`void`	`setBcc(String bcc)`
`void`	`setCc(String cc)`
`void`	`setContentType(String contentType)`
`void`	`setFrom(String from)`
`void`	`setName(String name)`
`void`	`setParameters(Map<String,Object> parameters)`
`void`	`setPassword(String password)`
`void`	`setReplyTo(String replyTo)`
`void`	`setSubject(String subject)`
`void`	`setTemplateFile(String templateFile)`
`void`	`setText(String text)`
`void`	`setTo(String to)`
`void`	`setType(String type)`
`void`	`setUsername(String username)`
`void`	`setValues(Map<String,Object> params, List<MailAttachment> attachments)`

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

Field Detail

MAIL_CONTENT_TYPE
```
public static String MAIL_CONTENT_TYPE
```

MAIL_FROM
```
public static String MAIL_FROM
```

MAIL_SUBJECT
```
public static String MAIL_SUBJECT
```

MAIL_TO
```
public static String MAIL_TO
```

MAIL_TO_WORKFLOW
```
public static String MAIL_TO_WORKFLOW
```

MAIL_CC
```
public static String MAIL_CC
```

MAIL_TYPE
```
public static String MAIL_TYPE
```

MAIL_PARAMETERS
```
public static String MAIL_PARAMETERS
```

MAIL_ATTACHMENTS
```
public static String MAIL_ATTACHMENTS
```

MAIL_BODY
```
public static String MAIL_BODY
```

MAIL_HTML
```
public static final String MAIL_HTML
```
See Also:

Constant Field Values

MAIL_TEMPLATE_FILE

public static final String MAIL_TEMPLATE_FILE

See Also:: Constant Field Values

Constructor Detail
- MailTemplate
```
public MailTemplate(MailModule mailModule)
```
- MailTemplate
```
@Deprecated
public MailTemplate()
```
  Deprecated. since 5.5. Use MailTemplate(MailModule) instead.

Method Detail

getParameters

public Map<String,Object> getParameters()

setParameters

public void setParameters(Map<String,Object> parameters)

getAttachments

public List<MailAttachment> getAttachments()

setAttachments

public void setAttachments(List<MailAttachment> attachments)

addAttachment

public void addAttachment(MailAttachment attachment)

getFrom
```
public String getFrom()
```

setFrom
```
public void setFrom(String from)
```

getTo
```
public String getTo()
```

setTo
```
public void setTo(String to)
```

getSubject
```
public String getSubject()
```

setSubject

public void setSubject(String subject)

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getContentType
```
public String getContentType()
```

setContentType

public void setContentType(String contentType)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getText
```
public String getText()
```

setText
```
public void setText(String text)
```

getCc
```
public String getCc()
```

setCc
```
public void setCc(String cc)
```

getUsername
```
public String getUsername()
```

setUsername

public void setUsername(String username)

getPassword
```
public String getPassword()
```

setPassword

public void setPassword(String password)

setValues

public void setValues(Map<String,Object> params,
                      List<MailAttachment> attachments)

getTemplateFile
```
public String getTemplateFile()
```

setTemplateFile

public void setTemplateFile(String templateFile)

getBcc
```
public String getBcc()
```

setBcc
```
public void setBcc(String bcc)
```

getReplyTo
```
public String getReplyTo()
```

setReplyTo

public void setReplyTo(String replyTo)

initSession

public javax.mail.Session initSession()

Class MailTemplate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAIL_CONTENT_TYPE

MAIL_FROM

MAIL_SUBJECT

MAIL_TO

MAIL_TO_WORKFLOW

MAIL_CC

MAIL_TYPE

MAIL_PARAMETERS

MAIL_ATTACHMENTS

MAIL_BODY

MAIL_HTML

MAIL_TEMPLATE_FILE

Constructor Detail

MailTemplate

MailTemplate

Method Detail

getParameters

setParameters

getAttachments

setAttachments

addAttachment

getFrom

setFrom

getTo

setTo

getSubject

setSubject

getType

setType

getContentType

setContentType

getName

setName

getText

setText

getCc

setCc

getUsername

setUsername

getPassword

setPassword

setValues

getTemplateFile

setTemplateFile

getBcc

setBcc

getReplyTo

setReplyTo

initSession