coldbox.system.core.mail

Class Mail

WEB-INF.cftags.component
        extended by coldbox.system.core.mail.Mail
Class Attributes:
  • output : false
    •  

    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
    None
    Constructor Detail

    init

    public init()

    Initialize the Mail object

    Method Detail

    addAttachments

    public any addAttachments(any files, [boolean remove='false'])

    Add attachment(s) to this payload using a list or array of file locations

    Parameters:
    files - A list or array of files to attach to this payload
    remove - If true, ColdFusion removes attachment files (if any) after the mail is successfully delivered.

    addMailParam

    public any addMailParam([any contentID], [any disposition], [any file], [any type], [any name], [any value], [boolean remove], [any content])

    Add mail params to this payload

    Parameters:
    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.

    addMailPart

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

    Add a new mail part to this mail payload

    Parameters:
    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.

    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 any setBcc(string newBcc)

    Sets a new value for the bcc property

    Parameters:
    newBcc

    setBody

    public any setBody(string Body)

    Set Body

    Parameters:
    Body

    setBodyTokens

    public any 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 any setCc(string newCc)

    Sets a new value for the cc property

    Parameters:
    newCc

    setCharset

    public any setCharset(string newCharset)

    Sets a new value for the charset property

    Parameters:
    newCharset

    setDebug

    public any setDebug(boolean newDebug)

    Sets a new value for the debug property

    Parameters:
    newDebug

    setFailto

    public any setFailto(string newFailto)

    Sets a new value for the failto property

    Parameters:
    newFailto

    setFrom

    public any setFrom(string newFrom)

    Sets a new value for the from property

    Parameters:
    newFrom

    setGroup

    public any setGroup(string newGroup)

    Sets a new value for the group property

    Parameters:
    newGroup

    setGroupcasesensitive

    public any setGroupcasesensitive(boolean newGroupcasesensitive)

    Sets a new value for the groupcasesensitive property

    Parameters:
    newGroupcasesensitive

    setHTML

    public any setHTML([any body])

    Sets up a mail part that is HTML using utf8 for you by calling addMailpart()

    Parameters:
    body - The HTML content to set in the mail part

    setMailerid

    public any setMailerid(string newMailerid)

    Sets a new value for the mailerid property

    Parameters:
    newMailerid

    setMaxrows

    public any setMaxrows(numeric newMaxrows)

    Sets a new value for the maxrows property

    Parameters:
    newMaxrows

    setMemento

    public void setMemento([struct memento])

    Parameters:
    memento

    setMimeattach

    public any setMimeattach(string newMimeattach)

    Sets a new value for the mimeattach property

    Parameters:
    newMimeattach

    setPassword

    public any setPassword(string newPassword)

    Sets a new value for the password property

    Parameters:
    newPassword

    setPort

    public any setPort(numeric newPort)

    Sets a new value for the port property

    Parameters:
    newPort

    setPriority

    public any setPriority(string newPriority)

    Sets a new value for the priority property

    Parameters:
    newPriority

    setQuery

    public any setQuery(string newQuery)

    Sets a new value for the query property

    Parameters:
    newQuery

    setReadReceipt

    public any setReadReceipt([any email])

    Set the email address that will receive read receipts. I just place the appropriate mail headers

    Parameters:
    email

    setReplyto

    public any setReplyto(string newReplyto)

    Sets a new value for the replyto property

    Parameters:
    newReplyto

    setSendReceipt

    public any setSendReceipt([any email])

    Sets the email that get's notified once the email is delivered by setting the appropriate mail headers

    Parameters:
    email

    setServer

    public any setServer(string newServer)

    Sets a new value for the server property

    Parameters:
    newServer

    setSpoolenable

    public any setSpoolenable(boolean newSpoolenable)

    Sets a new value for the spoolenable property

    Parameters:
    newSpoolenable

    setStartrow

    public any setStartrow(numeric newStartrow)

    Sets a new value for the startrow property

    Parameters:
    newStartrow

    setSubject

    public any setSubject(string newSubject)

    Sets a new value for the subject property

    Parameters:
    newSubject

    setText

    public any setText([any body])

    Sets up a mail part that is TEXT using utf8 for you by calling addMailpart()

    Parameters:
    body - The HTML content to set in the mail part

    setTimeout

    public any setTimeout(numeric newTimeout)

    Sets a new value for the timeout property

    Parameters:
    newTimeout

    setTo

    public any setTo(string newTo)

    Sets a new value for the to property

    Parameters:
    newTo

    setType

    public any setType(string newType)

    Sets a new value for the type property

    Parameters:
    newType

    setUseSSL

    public any setUseSSL(boolean newUseSSL)

    Sets a new value for the useSSL property

    Parameters:
    newUseSSL

    setUseTLS

    public any setUseTLS(boolean newUseTLS)

    Sets a new value for the useTLS property

    Parameters:
    newUseTLS

    setUsername

    public any setUsername(string newUsername)

    Sets a new value for the username property

    Parameters:
    newUsername

    setWraptext

    public any 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