mail.cfc

CFIDE.adminapi.mail
Component mail (mail)

Manages ColdFusion mail settings.

hierarchy:	WEB-INF.cftags.component CFIDE.adminapi.base CFIDE.adminapi.mail
path:	{web-root}\CFIDE\adminapi\mail.cfc
serializable:	Yes
properties:
methods:	deleteMailServer, getAvailableMailCharsets, getInternalMailServers*, getMailCharsets, getMailProperty, getMailServers, setMailProperty, setMailServer
inherited methods:	dump, getEdition, getInstallType, getJRunRootDir, isAdminUser, RDSInvoker, setJrunSN

* – private method

deleteMailServer
`public void deleteMailServer ( required string server )` Removes a server from the array of mail servers. Output: suppressed Parameters: server: string, required, server – Name of mail server to remove.
getAvailableMailCharsets
`public array getAvailableMailCharsets (` `)` Returns an array of the character sets available for Mail. Output: suppressed
getInternalMailServers*
`private array getInternalMailServers ( serverName )` Returns an array containing name, port, username, and password for all mail servers or a specified mail server. Output: suppressed Parameters: serverName: any, optional, serverName – Specifies a particular mail server.
getMailCharsets
`public array getMailCharsets (` `)` Returns an array of the character sets available for Mail. Output: suppressed
getMailProperty
`public any getMailProperty ( required propertyName )` Returns the value of specified mail property Output: suppressed Parameters: propertyName: any, required, propertyName – Valid Properties are: enableSpool enableSSL enableTLS defaultMailCharset defaultPassword defaultPort defaultUsername maintainConnections maxDeliveryThreads spoolInterval spoolToMemory MaxMessagesInMemory Timeout
getMailServers
`public array getMailServers ( serverName )` Returns an array containing name, port, username, and password for all mail servers or a specified mail server. Output: suppressed Parameters: serverName: any, optional, serverName – Specifies a particular mail server.
setMailProperty
`public void setMailProperty ( required propertyName, required propertyValue )` Sets the specified mail property to the specified value. Output: suppressed Parameters: propertyName: any, required, propertyName – Valid properties are: enableSpool enableSSL enableTLS defaultMailCharset defaultPassword defaultPort defaultUsername maintainConnections maxDeliveryThreads schedule spoolInterval spoolToMemory MaxMessagesInMemory Timeout propertyValue: any, required, propertyValue – Value for the specified mail property.
setMailServer
`public void setMailServer ( required string server, numeric port, username="", password="", priority="1" )` Adds a new server to the array of mail servers. Output: suppressed Parameters: server: string, required, server – Name of mail server. port: numeric, optional, port – Port number for mail server. username: any, optional, username – Mail server username. password: any, optional, password – Mail server password. priority: any, optional, priority – Server priority.

Leave a Reply Cancel reply