Mail

Package	coldfusion.service.mxml
Class	public class Mail
Inheritance	Mail BasicService InternalConfig Object

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

The proxy class for mail services exposed by ColdFusion.

Public Properties

	Property		Defined By
		action : String Action string for the service.	BasicService
		attachments : Array A list of attachment filenames.	Mail
		bcc : String Addresses to which to copy the message, without listing them in the message header.	Mail
		cc : String Addresses to which to copy the message.	Mail
		cfContextRoot : String Context root of the ColdFusion server.	InternalConfig
		cfPort : int Port where the ColdFusion server is running.	InternalConfig
		cfServer : String Name or IP address of the ColdFusion server.	InternalConfig
		charset : String Character encoding of the mail message, including the headers.	Mail
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		content : String	Mail
		destination : String Specifies the destination for the remoting call.	InternalConfig
		failTo : String Address to which mailing systems should send delivery failure notifications.	Mail
		from : String E-mail address of the sender: A static string; for example, "support@example.com" A variable; for example, "#GetUser.EMailAddress#"	Mail
		mailerId : String Mailer ID to be passed in X-Mailer SMTP header, which identifies the mailer application.	Mail
		mailParts : Array Specifies one part of a multipart e-mail message.	Mail
		mimeAttach : String Path of the on-disk or in-memory file to attach to message.	Mail
		password : String A password to send to SMTP servers that require authentication.	Mail
		port : String TCP/IP port on which SMTP server listens for requests (normally 25).	Mail
		priority : String The message priority level.	Mail
		replyTo : String Addresses to which the recipient is directed to send replies.	Mail
		secureHttp : Boolean Boolean value that specifies if secure HTTP is used: yes: uses secure HTTP no: does not use secure HTTP	InternalConfig
		server : String SMTP server address, or (Enterprise edition only) a comma-delimited list of server addresses, to use for sending messages.	Mail
		servicePassword : String Password to access ColdFusion services.	InternalConfig
		serviceUserName : String Username to access ColdFusion services.	InternalConfig
		subject : String Message subject.	Mail
		timeout : String Number of seconds to wait before timing out connection to SMTP server.	Mail
		to : String E-mail address of the recipient: Static address, for example, "support@example.com" Variable that contains an address, for example, "#Form.Email#" Name of a query column that contains an address, for example, "#EMail#".	Mail
		type : String MIME type of the message.	Mail
		userName : String A user name to send to SMTP servers that require authentication.	Mail
		useSSL : Boolean Whether to use Secure Sockets Layer.	Mail
		useTLS : Boolean Whether to use Transport Level Security.	Mail
		wrapText : String The maximum line length, in characters of the mail text.	Mail

Public Methods

	Method		Defined By
		Mail() Creates an instance of the Mail class.	Mail
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	BasicService
		dispatchEvent(evt:Event):Boolean Dispatches an event into the event flow.	BasicService
		execute():void Sends the information to the ColdFusion service based on the action and attributes that the user sets.	Mail
		getRemoteObject():RemoteObject Returns the RemoteObject instance used by the proxy classes to make the remote object call.	BasicService
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	BasicService
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	BasicService
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	BasicService

Events

Click for more information on events

	Event		Summary	Defined By
		fault	Dispatched when a ColdFusion service call fails.	BasicService
		result	Dispatched when a ColdFusion service call returns successfully.	BasicService

Property Detail

attachments

property

public var attachments:Array

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

A list of attachment filenames.

bcc

property

public var bcc:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Addresses to which to copy the message, without listing them in the message header. To specify multiple addresses, separate the addresses with commas.

cc

property

public var cc:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Addresses to which to copy the message. To specify multiple addresses, separate the address with commas.

charset

property

public var charset:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Character encoding of the mail message, including the headers. The following list includes commonly used values:

utf-8
iso-8859-1
windows-1252
us-ascii
shift_jis
iso-2022-jp
euc-jp
euc-kr
big5
hz-gb-2312
euc-cn
utf-16

The default value is utf-8.

content

property

public var content:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

failTo

property

public var failTo:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Address to which mailing systems should send delivery failure notifications. Sets the mail envelope reverse-path value.

from

property

public var from:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

E-mail address of the sender:

A static string; for example, "support@example.com"
A variable; for example, "#GetUser.EMailAddress#"

mailerId

property

public var mailerId:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Mailer ID to be passed in X-Mailer SMTP header, which identifies the mailer application.

mailParts

property

public var mailParts:Array

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Specifies one part of a multipart e-mail message. Can only be used in the cfmail tag.

mimeAttach

property

public var mimeAttach:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Path of the on-disk or in-memory file to attach to message.

password

property

public var password:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

A password to send to SMTP servers that require authentication.

port

property

public var port:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

TCP/IP port on which SMTP server listens for requests (normally 25).

priority

property

public var priority:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

The message priority level. Can be one of the following values:

An integer in the range 1-5; 1 represents the highest priority.
One of the following string values, which correspond to the numeric values: highest or urgent, high, normal, low, and lowest or non-urgent.

replyTo

property

public var replyTo:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Addresses to which the recipient is directed to send replies.

server

property

public var server:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

SMTP server address, or (Enterprise edition only) a comma-delimited list of server addresses, to use for sending messages.

subject

property

public var subject:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Message subject. Can be dynamically generated. For example, to send messages that give customers status updates: "StatusofOrderNumber#Order_ID#".

timeout

property

public var timeout:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Number of seconds to wait before timing out connection to SMTP server.

to

property

public var to:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

E-mail address of the recipient:

Static address, for example, "support@example.com"
Variable that contains an address, for example, "#Form.Email#"
Name of a query column that contains an address, for example, "#EMail#". An e-mail message is sent for each returned row.

Use a comma-delimited list to specify multiple recipients.

type

property

public var type:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

MIME type of the message. Can be a valid MIME media type or one of the following:

text: specifies text/plain type.
plain: specifies text/plain type.
html: specifies text/html type.

userName

property

public var userName:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

A user name to send to SMTP servers that require authentication.

useSSL

property

public var useSSL:Boolean

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Whether to use Secure Sockets Layer.

useTLS

property

public var useTLS:Boolean

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Whether to use Transport Level Security.

wrapText

property

public var wrapText:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

The maximum line length, in characters of the mail text.

Constructor Detail

Mail

()

Constructor

public function Mail()

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.5

Creates an instance of the Mail class.

Method Detail

execute

()

method

public function execute():void

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Sends the information to the ColdFusion service based on the action and attributes that the user sets.

Legal Notices | Online Privacy Policy

Mail - AS3 CF

Classes x

attachments

bcc

cc

charset

content

failTo

from

mailerId

mailParts

mimeAttach

password

port

priority

replyTo

server

subject

timeout

to

type

userName

useSSL

useTLS

wrapText

Mail

execute