|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.core.mail.Mail
public class Mail
I model a cfmail object with extra pizzazz
Constructor Summary | |
---|---|
init()
Initialize the Mail object |
Method Summary | |
---|---|
any |
addAttachments(any files, [boolean remove='false'])
Add attachment(s) to this payload using a list or array of file locations |
any |
addMailParam([any contentID], [any disposition], [any file], [any type], [any name], [any value], [boolean remove], [any content])
Add mail params to this payload |
any |
addMailPart([string charset], [string type], [numeric wraptext], [string body])
Add a new mail part to this mail payload |
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 |
any |
setBcc(string newBcc)
Sets a new value for the bcc property |
any |
setBody(string Body)
Set Body |
any |
setBodyTokens(struct tokenMap)
Sets a new struct of body tokens that can be used for replacement when the mail is sent |
any |
setCc(string newCc)
Sets a new value for the cc property |
any |
setCharset(string newCharset)
Sets a new value for the charset property |
any |
setDebug(boolean newDebug)
Sets a new value for the debug property |
any |
setFailto(string newFailto)
Sets a new value for the failto property |
any |
setFrom(string newFrom)
Sets a new value for the from property |
any |
setGroup(string newGroup)
Sets a new value for the group property |
any |
setGroupcasesensitive(boolean newGroupcasesensitive)
Sets a new value for the groupcasesensitive property |
any |
setHTML([any body])
Sets up a mail part that is HTML using utf8 for you by calling addMailpart() |
any |
setMailerid(string newMailerid)
Sets a new value for the mailerid property |
any |
setMaxrows(numeric newMaxrows)
Sets a new value for the maxrows property |
void |
setMemento([struct memento])
|
any |
setMimeattach(string newMimeattach)
Sets a new value for the mimeattach property |
any |
setPassword(string newPassword)
Sets a new value for the password property |
any |
setPort(numeric newPort)
Sets a new value for the port property |
any |
setPriority(string newPriority)
Sets a new value for the priority property |
any |
setQuery(string newQuery)
Sets a new value for the query property |
any |
setReadReceipt([any email])
Set the email address that will receive read receipts |
any |
setReplyto(string newReplyto)
Sets a new value for the replyto property |
any |
setSendReceipt([any email])
Sets the email that get's notified once the email is delivered by setting the appropriate mail headers |
any |
setServer(string newServer)
Sets a new value for the server property |
any |
setSpoolenable(boolean newSpoolenable)
Sets a new value for the spoolenable property |
any |
setStartrow(numeric newStartrow)
Sets a new value for the startrow property |
any |
setSubject(string newSubject)
Sets a new value for the subject property |
any |
setText([any body])
Sets up a mail part that is TEXT using utf8 for you by calling addMailpart() |
any |
setTimeout(numeric newTimeout)
Sets a new value for the timeout property |
any |
setTo(string newTo)
Sets a new value for the to property |
any |
setType(string newType)
Sets a new value for the type property |
any |
setUseSSL(boolean newUseSSL)
Sets a new value for the useSSL property |
any |
setUseTLS(boolean newUseTLS)
Sets a new value for the useTLS property |
any |
setUsername(string newUsername)
Sets a new value for the username property |
any |
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 |
---|
public init()
Method Detail |
---|
public any addAttachments(any files, [boolean remove='false'])
files
- A list or array of files to attach to this payloadremove
- If true, ColdFusion removes attachment files (if any) after the mail is successfully delivered.public any addMailParam([any contentID], [any disposition], [any file], [any type], [any name], [any value], [boolean remove], [any content])
contentID
- Initial value for the contentID property.disposition
- Initial value for the dispositio nproperty.file
- Initial value for the file property.type
- Initial value for the type property.name
- Initial value for the name property.value
- Initial value for the value property.remove
- If true, ColdFusion removes attachment files (if any) after the mail is successfully delivered.content
- Lets you send the contents of a ColdFusion variable as an attachment.public any addMailPart([string charset], [string type], [numeric wraptext], [string body])
charset
- Initial value for the charset property.type
- Initial value for the type property.wraptext
- Initial value for the wraptext property.body
- Initial value for the body property.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])
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.public any getBcc()
public string getBody()
public any getBodyTokens()
public any getCc()
public any getCharset()
public any getDebug()
public any getFailto()
public any getFrom()
public any getGroup()
public any getGroupcasesensitive()
public Array getMailParams()
public Array getMailParts()
public any getMailerid()
public any getMaxrows()
public struct getMemento()
public any getMimeattach()
public any getPassword()
public any getPort()
public any getPriority()
public any getQuery()
public any getReplyto()
public any getServer()
public any getSpoolenable()
public any getStartrow()
public any getSubject()
public any getTimeout()
public any getTo()
public any getType()
public any getUseSSL()
public any getUseTLS()
public any getUsername()
public any getWraptext()
public boolean propertyExists(string property)
property
- The property to checkpublic any setBcc(string newBcc)
newBcc
public any setBody(string Body)
Body
public any setBodyTokens(struct tokenMap)
tokenMap
public any setCc(string newCc)
newCc
public any setCharset(string newCharset)
newCharset
public any setDebug(boolean newDebug)
newDebug
public any setFailto(string newFailto)
newFailto
public any setFrom(string newFrom)
newFrom
public any setGroup(string newGroup)
newGroup
public any setGroupcasesensitive(boolean newGroupcasesensitive)
newGroupcasesensitive
public any setHTML([any body])
body
- The HTML content to set in the mail partpublic any setMailerid(string newMailerid)
newMailerid
public any setMaxrows(numeric newMaxrows)
newMaxrows
public void setMemento([struct memento])
memento
public any setMimeattach(string newMimeattach)
newMimeattach
public any setPassword(string newPassword)
newPassword
public any setPort(numeric newPort)
newPort
public any setPriority(string newPriority)
newPriority
public any setQuery(string newQuery)
newQuery
public any setReadReceipt([any email])
email
public any setReplyto(string newReplyto)
newReplyto
public any setSendReceipt([any email])
email
public any setServer(string newServer)
newServer
public any setSpoolenable(boolean newSpoolenable)
newSpoolenable
public any setStartrow(numeric newStartrow)
newStartrow
public any setSubject(string newSubject)
newSubject
public any setText([any body])
body
- The HTML content to set in the mail partpublic any setTimeout(numeric newTimeout)
newTimeout
public any setTo(string newTo)
newTo
public any setType(string newType)
newType
public any setUseSSL(boolean newUseSSL)
newUseSSL
public any setUseTLS(boolean newUseTLS)
newUseTLS
public any setUsername(string newUsername)
newUsername
public any setWraptext(numeric newWraptext)
newWraptext
public boolean validate()
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |