|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.core.mail.MailSettingsBean
public class MailSettingsBean
I model mail server settings to be used with our Mail Service
Constructor Summary | |
---|---|
init([string server=''], [string username=''], [string password=''], [numeric port='0'], [struct protocol='[runtime expression]'], [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 priority], [string query], [string replyto], [boolean spoolenable], [numeric startrow], [string subject], [numeric timeout], [string type], [boolean useSSL], [boolean useTLS], [numeric wraptext])
I return a mail setting bean |
Method Summary | |
---|---|
any |
getMemento()
Get the memento |
any |
getPassword()
Get Password DEPRECATED |
any |
getPort()
Get port DEPRECATED |
any |
getServer()
Get server DEPRECATED |
any |
getTransit()
Get the protocol implementation object |
any |
getUsername()
Get Username DEPRECATED |
any |
getValue(any setting, [any default])
Get a value of a setting |
any |
getprotocol()
Get protocolsettings |
void |
registerProtocol([any class='coldbox.system.core.mail.protocols.CFMailProtocol'], [any properties='[runtime expression]'])
I register a protocol with the settings |
void |
setMemento(struct memento)
Set the memento |
any |
setPassword([any password])
Set Password DEPRECATED |
any |
setPort([any port])
Set port DEPRECATED |
any |
setProtocol([struct protocol])
Set protocolsettings |
any |
setServer([any server])
Set server DEPRECATED |
any |
setUsername([any username])
Set Username DEPRECATED |
any |
setValue(any setting, any value)
Set a new setting value and return yourself |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init([string server=''], [string username=''], [string password=''], [numeric port='0'], [struct protocol='[runtime expression]'], [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 priority], [string query], [string replyto], [boolean spoolenable], [numeric startrow], [string subject], [numeric timeout], [string type], [boolean useSSL], [boolean useTLS], [numeric wraptext])
server
- Initial value for the server property.username
- Initial value for the username property.password
- Initial value for the password property.port
- Initial value for the port property.protocol
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.priority
- Initial value for the priority property.query
- Initial value for the query property.replyto
- Initial value for the replyto 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.useSSL
- Initial value for the useSSL property.useTLS
- Initial value for the useTLS property.wraptext
- Initial value for the wraptext property.Method Detail |
---|
public any getMemento()
public any getPassword()
public any getPort()
public any getServer()
public any getTransit()
public any getUsername()
public any getValue(any setting, [any default])
setting
- The name of the setting to retrievedefault
- The default value to returnpublic any getprotocol()
public void registerProtocol([any class='coldbox.system.core.mail.protocols.CFMailProtocol'], [any properties='[runtime expression]'])
class
- The instantiation path of the mail protocol objectproperties
- The properties to construct the protocol object withpublic void setMemento(struct memento)
memento
public any setPassword([any password])
password
public any setPort([any port])
port
public any setProtocol([struct protocol])
protocol
public any setServer([any server])
server
public any setUsername([any username])
username
public any setValue(any setting, any value)
setting
- The name of the setting value
- The value of the setting
|
ColdBox Platform v3.8.0 | ||||
FRAMES |