ebox.system.core.mail.concurrent.Callable interface">
Callable Overview  Package   Class 
ColdBox Platform - CacheBox Version 1.1
FRAMES  

cachebox.system.core.mail
Class Mail

WEB-INF.cftags.component
        extended by cachebox.system.core.mail.Mail

public class Mail

extends WEB-INF.cftags.component

I model a cfmail object with extra pizzazz

Constructor Summary
init()
          Initialize the Mail object
 
Method Summary
 void addMailParam([string contentID], [string disposition], [string file], [string type], [string name], [string value])
 void addMailPart([string charset], [string type], [numeric wraptext], [string body])
 Mail config([string from], [string to], [string body], [string bcc], [string cc], [string charset], [boolean debug], [string failto], [string group], [boolean groupcasesensitive], [string mailerid], [numeric maxrows], [string mimeattach], [string password], [numeric port], [string priority], [string query], [string replyto], [string server], [boolean spoolenable], [numeric startrow], [string subject], [numeric timeout], [string type], [string username], [boolean useSSL], [boolean useTLS], [numeric wraptext])
          Configure the Mail object
 any getBcc()
          Gets the bcc property
 string getBody()
          Get body
 any getBodyTokens()
          Gets the bodyTokens property
 any getCc()
          Gets the cc property
 any getCharset()
          Gets the charset property
 any getDebug()
          Gets the debug property
 any getFailto()
          Gets the failto property
 any getFrom()
          Gets the from property
 any getGroup()
          Gets the group property
 any getGroupcasesensitive()
          Gets the groupcasesensitive property
 Array getMailParams()
          Gets the mailParams property
 Array getMailParts()
          Gets the mailParts defined in this Mail object
 any getMailerid()
          Gets the mailerid property
 any getMaxrows()
          Gets the maxrows property
 struct getMemento()
 any getMimeattach()
          Gets the mimeattach property
 any getPassword()
          Gets the password property
 any getPort()
          Gets the port property
 any getPriority()
          Gets the priority property
 any getQuery()
          Gets the query property
 any getReplyto()
          Gets the replyto property
 any getServer()
          Gets the server property
 any getSpoolenable()
          Gets the spoolenable property
 any getStartrow()
          Gets the startrow property
 any getSubject()
          Gets the subject property
 any getTimeout()
          Gets the timeout property
 any getTo()
          Gets the to property
 any getType()
          Gets the type property
 any getUseSSL()
          Gets the useSSL property
 any getUseTLS()
          Gets the useTLS property
 any getUsername()
          Gets the username property
 any getWraptext()
          Gets the wraptext property
 boolean propertyExists(string property)
          Checks if a mail property exists
 void setBcc(string newBcc)
          Sets a new value for the bcc property
 void setBody(string Body)
          Set Body
 void setBodyTokens(struct tokenMap)
          Sets a new struct of body tokens that can be used for replacement when the mail is sent
 void setCc(string newCc)
          Sets a new value for the cc property
 void setCharset(string newCharset)
          Sets a new value for the charset property
 void setDebug(boolean newDebug)
          Sets a new value for the debug property
 void setFailto(string newFailto)
          Sets a new value for the failto property
 void setFrom(string newFrom)
          Sets a new value for the from property
 void setGroup(string newGroup)
          Sets a new value for the group property
 void setGroupcasesensitive(boolean newGroupcasesensitive)
          Sets a new value for the groupcasesensitive property
 void setMailerid(string newMailerid)
          Sets a new value for the mailerid property
 void setMaxrows(numeric newMaxrows)
          Sets a new value for the maxrows property
 void setMemento([struct memento])
 void setMimeattach(string newMimeattach)
          Sets a new value for the mimeattach property
 void setPassword(string newPassword)
          Sets a new value for the password property
 void setPort(numeric newPort)
          Sets a new value for the port property
 void setPriority(string newPriority)
          Sets a new value for the priority property
 void setQuery(string newQuery)
          Sets a new value for the query property
 void setReplyto(string newReplyto)
          Sets a new value for the replyto property
 void setServer(string newServer)
          Sets a new value for the server property
 void setSpoolenable(boolean newSpoolenable)
          Sets a new value for the spoolenable property
 void setStartrow(numeric newStartrow)
          Sets a new value for the startrow property
 void setSubject(string newSubject)
          Sets a new value for the subject property
 void setTimeout(numeric newTimeout)
          Sets a new value for the timeout property
 void setTo(string newTo)
          Sets a new value for the to property
 void setType(string newType)
          Sets a new value for the type property
 void setUseSSL(boolean newUseSSL)
          Sets a new value for the useSSL property
 void setUseTLS(boolean newUseTLS)
          Sets a new value for the useTLS property
 void setUsername(string newUsername)
          Sets a new value for the username property
 void setWraptext(numeric newWraptext)
          Sets a new value for the wraptext property
 boolean validate()
          validates the basic fields of To, From and Body
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()
Initialize the Mail object

Method Detail

addMailParam

public void addMailParam([string contentID], [string disposition], [string file], [string type], [string name], [string value])

Parameters:
contentID - Initial value for the contentIDproperty.
disposition - Initial value for the dispositionproperty.
file - Initial value for the fileproperty.
type - Initial value for the typeproperty.
name - Initial value for the nameproperty.
value - Initial value for the valueproperty.

addMailPart

public void addMailPart([string charset], [string type], [numeric wraptext], [string body])

Parameters:
charset - Initial value for the charsetproperty.
type - Initial value for the typeproperty.
wraptext - Initial value for the wraptextproperty.
body - Initial value for the bodyproperty.

config

public Mail config([string from], [string to], [string body], [string bcc], [string cc], [string charset], [boolean debug], [string failto], [string group], [boolean groupcasesensitive], [string mailerid], [numeric maxrows], [string mimeattach], [string password], [numeric port], [string priority], [string query], [string replyto], [string server], [boolean spoolenable], [numeric startrow], [string subject], [numeric timeout], [string type], [string username], [boolean useSSL], [boolean useTLS], [numeric wraptext])
Configure the Mail object

Parameters:
from - Initial value for the from property.
to - Initial value for the to property.
body - Initial value for the email body.
bcc - Initial value for the bcc property.
cc - Initial value for the cc property.
charset - Initial value for the charset property.
debug - Initial value for the debug property.
failto - Initial value for the failto property.
group - Initial value for the group property.
groupcasesensitive - Initial value for the groupcasesensitive property.
mailerid - Initial value for the mailerid property.
maxrows - Initial value for the maxrows property.
mimeattach - Initial value for the mimeattach property.
password - Initial value for the password property.
port - Initial value for the port property.
priority - Initial value for the priority property.
query - Initial value for the query property.
replyto - Initial value for the replyto property.
server - Initial value for the server property.
spoolenable - Initial value for the spoolenable property.
startrow - Initial value for the startrow property.
subject - Initial value for the subject property.
timeout - Initial value for the timeout property.
type - Initial value for the type property.
username - Initial value for the username property.
useSSL - Initial value for the useSSL property.
useTLS - Initial value for the useTLS property.
wraptext - Initial value for the wraptext property.

getBcc

public any getBcc()
Gets the bcc property

getBody

public string getBody()
Get body

getBodyTokens

public any getBodyTokens()
Gets the bodyTokens property

getCc

public any getCc()
Gets the cc property

getCharset

public any getCharset()
Gets the charset property

getDebug

public any getDebug()
Gets the debug property

getFailto

public any getFailto()
Gets the failto property

getFrom

public any getFrom()
Gets the from property

getGroup

public any getGroup()
Gets the group property

getGroupcasesensitive

public any getGroupcasesensitive()
Gets the groupcasesensitive property

getMailParams

public Array getMailParams()
Gets the mailParams property

getMailParts

public Array getMailParts()
Gets the mailParts defined in this Mail object

getMailerid

public any getMailerid()
Gets the mailerid property

getMaxrows

public any getMaxrows()
Gets the maxrows property

getMemento

public struct getMemento()

getMimeattach

public any getMimeattach()
Gets the mimeattach property

getPassword

public any getPassword()
Gets the password property

getPort

public any getPort()
Gets the port property

getPriority

public any getPriority()
Gets the priority property

getQuery

public any getQuery()
Gets the query property

getReplyto

public any getReplyto()
Gets the replyto property

getServer

public any getServer()
Gets the server property

getSpoolenable

public any getSpoolenable()
Gets the spoolenable property

getStartrow

public any getStartrow()
Gets the startrow property

getSubject

public any getSubject()
Gets the subject property

getTimeout

public any getTimeout()
Gets the timeout property

getTo

public any getTo()
Gets the to property

getType

public any getType()
Gets the type property

getUseSSL

public any getUseSSL()
Gets the useSSL property

getUseTLS

public any getUseTLS()
Gets the useTLS property

getUsername

public any getUsername()
Gets the username property

getWraptext

public any getWraptext()
Gets the wraptext property

propertyExists

public boolean propertyExists(string property)
Checks if a mail property exists

Parameters:
property - The property to check

setBcc

public void setBcc(string newBcc)
Sets a new value for the bcc property

Parameters:
newBcc

setBody

public void setBody(string Body)
Set Body

Parameters:
Body

setBodyTokens

public void setBodyTokens(struct tokenMap)
Sets a new struct of body tokens that can be used for replacement when the mail is sent. The tokens are replaced in the body content ast @token@ delimmitted.

Parameters:
tokenMap

setCc

public void setCc(string newCc)
Sets a new value for the cc property

Parameters:
newCc

setCharset

public void setCharset(string newCharset)
Sets a new value for the charset property

Parameters:
newCharset

setDebug

public void setDebug(boolean newDebug)
Sets a new value for the debug property

Parameters:
newDebug

setFailto

public void setFailto(string newFailto)
Sets a new value for the failto property

Parameters:
newFailto

setFrom

public void setFrom(string newFrom)
Sets a new value for the from property

Parameters:
newFrom

setGroup

public void setGroup(string newGroup)
Sets a new value for the group property

Parameters:
newGroup

setGroupcasesensitive

public void setGroupcasesensitive(boolean newGroupcasesensitive)
Sets a new value for the groupcasesensitive property

Parameters:
newGroupcasesensitive

setMailerid

public void setMailerid(string newMailerid)
Sets a new value for the mailerid property

Parameters:
newMailerid

setMaxrows

public void setMaxrows(numeric newMaxrows)
Sets a new value for the maxrows property

Parameters:
newMaxrows

setMemento

public void setMemento([struct memento])

Parameters:
memento

setMimeattach

public void setMimeattach(string newMimeattach)
Sets a new value for the mimeattach property

Parameters:
newMimeattach

setPassword

public void setPassword(string newPassword)
Sets a new value for the password property

Parameters:
newPassword

setPort

public void setPort(numeric newPort)
Sets a new value for the port property

Parameters:
newPort

setPriority

public void setPriority(string newPriority)
Sets a new value for the priority property

Parameters:
newPriority

setQuery

public void setQuery(string newQuery)
Sets a new value for the query property

Parameters:
newQuery

setReplyto

public void setReplyto(string newReplyto)
Sets a new value for the replyto property

Parameters:
newReplyto

setServer

public void setServer(string newServer)
Sets a new value for the server property

Parameters:
newServer

setSpoolenable

public void setSpoolenable(boolean newSpoolenable)
Sets a new value for the spoolenable property

Parameters:
newSpoolenable

setStartrow

public void setStartrow(numeric newStartrow)
Sets a new value for the startrow property

Parameters:
newStartrow

setSubject

public void setSubject(string newSubject)
Sets a new value for the subject property

Parameters:
newSubject

setTimeout

public void setTimeout(numeric newTimeout)
Sets a new value for the timeout property

Parameters:
newTimeout

setTo

public void setTo(string newTo)
Sets a new value for the to property

Parameters:
newTo

setType

public void setType(string newType)
Sets a new value for the type property

Parameters:
newType

setUseSSL

public void setUseSSL(boolean newUseSSL)
Sets a new value for the useSSL property

Parameters:
newUseSSL

setUseTLS

public void setUseTLS(boolean newUseTLS)
Sets a new value for the useTLS property

Parameters:
newUseTLS

setUsername

public void setUsername(string newUsername)
Sets a new value for the username property

Parameters:
newUsername

setWraptext

public void setWraptext(numeric newWraptext)
Sets a new value for the wraptext property

Parameters:
newWraptext

validate

public boolean validate()
validates the basic fields of To, From and Body

Overview  Package   Class 
ColdBox Platform - CacheBox Version 1.1
FRAMES