EmailMessageTO (Crafter Studio 3.1.10 API)

java.lang.Object
- org.craftercms.studio.api.v1.to.EmailMessageTO

All Implemented Interfaces:: Serializable

public class EmailMessageTO
extends Object
implements Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`adminEmail`
`protected String`	`authoringBaseUrl`
`protected String`	`browserUrl`
`protected String`	`content`
`static String`	`EMAIL_TEMPLATE_KEYWORDS_ADMINEMAIL`
`static String`	`EMAIL_TEMPLATE_KEYWORDS_AUTHORINGURL`
`static String`	`EMAIL_TEMPLATE_KEYWORDS_LIVEURL`
`static String`	`EMAIL_TEMPLATE_KEYWORDS_PREVIEWURL`
`static String`	`EMAIL_TEMPLATE_KEYWORDS_TITLE`
`static String`	`EMAIL_TEMPLATE_KEYWORDS_USERNAME`
`static String`	`EMAIL_TEMPLATE_REJECT_REASON`
`protected String[]`	`emailTemplateKeywords`
`protected Map<String,String>`	`keyValueMap`
`protected String`	`liveBaseUrl`
`protected String`	`personalFromName`
`protected String`	`previewBaseUrl`
`protected String`	`rejectReason`
`protected String`	`replyTo`
`protected String`	`subject`
`protected String`	`title`
`protected String`	`to`

Constructor Summary

Constructors
Constructor and Description

EmailMessageTO(String subject, String content, String to)

Constructors
Constructor and Description
`EmailMessageTO(String subject, String content, String to)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAdminEmail()`
`String`	`getAuthoringBaseUrl()`
`String`	`getBrowserUrl()`
`String`	`getContent()`
`String`	`getLiveBaseUrl()`
`String`	`getPersonalFromName()`
`String`	`getPreviewBaseUrl()`
`String`	`getRejectReason()`
`protected String`	`getRelativeUrl(String fullUrl)`
`String`	`getReplyTo()`
`String`	`getSubject()`
`String`	`getTitle()`
`String`	`getTo()`
`String`	`getValue(String key)`
`void`	`preprocessEmail()`
`protected String`	`replaceKeywordsByValue(String input)`
`void`	`setAdminEmail(String adminEmail)`
`void`	`setAuthoringBaseUrl(String authoringBaseUrl)`
`void`	`setBrowserUrl(String browserUrl)` Starts from /site
`void`	`setBrowserUrlForExternalDocument(String browserUrl)`
`void`	`setContent(String content)`
`void`	`setLiveBaseUrl(String liveBaseUrl)`
`void`	`setPersonalFromName(String personalFromName)`
`void`	`setPreviewBaseUrl(String previewBaseUrl)`
`void`	`setRejectReason(String rejectReason)`
`void`	`setReplyTo(String replyTo)`
`void`	`setSubject(String subject)`
`void`	`setTitle(String title)`
`void`	`setTo(String to)`
`void`	`setValue(String key, String value)`

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

Field Detail

subject
```
protected String subject
```

content
```
protected String content
```

to
```
protected String to
```

personalFromName
```
protected String personalFromName
```

replyTo
```
protected String replyTo
```

previewBaseUrl
```
protected String previewBaseUrl
```

liveBaseUrl
```
protected String liveBaseUrl
```

authoringBaseUrl
```
protected String authoringBaseUrl
```

browserUrl
```
protected String browserUrl
```

adminEmail
```
protected String adminEmail
```

rejectReason
```
protected String rejectReason
```

title
```
protected String title
```

keyValueMap

protected Map<String,String> keyValueMap

emailTemplateKeywords

protected String[] emailTemplateKeywords

EMAIL_TEMPLATE_KEYWORDS_ADMINEMAIL

public static final String EMAIL_TEMPLATE_KEYWORDS_ADMINEMAIL

See Also:: Constant Field Values

EMAIL_TEMPLATE_KEYWORDS_USERNAME

public static final String EMAIL_TEMPLATE_KEYWORDS_USERNAME

See Also:: Constant Field Values

EMAIL_TEMPLATE_KEYWORDS_PREVIEWURL

public static final String EMAIL_TEMPLATE_KEYWORDS_PREVIEWURL

See Also:: Constant Field Values

EMAIL_TEMPLATE_KEYWORDS_LIVEURL

public static final String EMAIL_TEMPLATE_KEYWORDS_LIVEURL

See Also:: Constant Field Values

EMAIL_TEMPLATE_KEYWORDS_AUTHORINGURL

public static final String EMAIL_TEMPLATE_KEYWORDS_AUTHORINGURL

See Also:: Constant Field Values

EMAIL_TEMPLATE_KEYWORDS_TITLE

public static final String EMAIL_TEMPLATE_KEYWORDS_TITLE

See Also:: Constant Field Values

EMAIL_TEMPLATE_REJECT_REASON

public static final String EMAIL_TEMPLATE_REJECT_REASON

See Also:: Constant Field Values

Constructor Detail

EmailMessageTO

public EmailMessageTO(String subject,
                      String content,
                      String to)

Method Detail

getBrowserUrl
```
public String getBrowserUrl()
```

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

getAdminEmail
```
public String getAdminEmail()
```

setAdminEmail

public void setAdminEmail(String adminEmail)

setBrowserUrl
```
public void setBrowserUrl(String browserUrl)
```
Starts from /site

Parameters:

browserUrl -

setBrowserUrlForExternalDocument

public void setBrowserUrlForExternalDocument(String browserUrl)

getRelativeUrl

protected String getRelativeUrl(String fullUrl)

getPreviewBaseUrl
```
public String getPreviewBaseUrl()
```

setPreviewBaseUrl

public void setPreviewBaseUrl(String previewBaseUrl)

getLiveBaseUrl
```
public String getLiveBaseUrl()
```

setLiveBaseUrl

public void setLiveBaseUrl(String liveBaseUrl)

getAuthoringBaseUrl
```
public String getAuthoringBaseUrl()
```

setAuthoringBaseUrl

public void setAuthoringBaseUrl(String authoringBaseUrl)

setRejectReason

public void setRejectReason(String rejectReason)

getRejectReason
```
public String getRejectReason()
```

getValue
```
public String getValue(String key)
```

setValue

public void setValue(String key,
                     String value)

getPersonalFromName
```
public String getPersonalFromName()
```

setPersonalFromName

public void setPersonalFromName(String personalFromName)

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

setReplyTo

public void setReplyTo(String replyTo)

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

setSubject

public void setSubject(String subject)

getContent
```
public String getContent()
```

setContent

public void setContent(String content)

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

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

preprocessEmail
```
public void preprocessEmail()
```

replaceKeywordsByValue

protected String replaceKeywordsByValue(String input)

Class EmailMessageTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

subject

content

to

personalFromName

replyTo

previewBaseUrl

liveBaseUrl

authoringBaseUrl

browserUrl

adminEmail

rejectReason

title

keyValueMap

emailTemplateKeywords

EMAIL_TEMPLATE_KEYWORDS_ADMINEMAIL

EMAIL_TEMPLATE_KEYWORDS_USERNAME

EMAIL_TEMPLATE_KEYWORDS_PREVIEWURL

EMAIL_TEMPLATE_KEYWORDS_LIVEURL

EMAIL_TEMPLATE_KEYWORDS_AUTHORINGURL

EMAIL_TEMPLATE_KEYWORDS_TITLE

EMAIL_TEMPLATE_REJECT_REASON

Constructor Detail

EmailMessageTO

Method Detail

getBrowserUrl

getTitle

setTitle

getAdminEmail

setAdminEmail

setBrowserUrl

setBrowserUrlForExternalDocument

getRelativeUrl

getPreviewBaseUrl

setPreviewBaseUrl

getLiveBaseUrl

setLiveBaseUrl

getAuthoringBaseUrl

setAuthoringBaseUrl

setRejectReason

getRejectReason

getValue

setValue

getPersonalFromName

setPersonalFromName

getReplyTo

setReplyTo

getSubject

setSubject

getContent

setContent

getTo

setTo

preprocessEmail

replaceKeywordsByValue