Packagecoldfusion.service.mxml
Classpublic class Mail
InheritanceMail Inheritance BasicService

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

The proxy class for mail services exposed by ColdFusion.



Public Properties
 PropertyDefined By
  attachments : Array
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
  charset : String
Character encoding of the mail message, including the headers.
Mail
  content : String
Mail
  failTo : String
Address to which mailing systems should send delivery failure notifications.
Mail
  from : String
E-mail message 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
  server : String
SMTP server address, or (Enterprise edition only) a comma-delimited list of server addresses, to use for sending messages.
Mail
  subject : String
Message subject.
Mail
  timeout : String
Number of seconds to wait before timing out connection to SMTP server.
Mail
  to : String
Message recipient e-mail addresses: 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
 MethodDefined By
  
Creates an instance of the Mail class.
Mail
  
Sends the information to the ColdFusion service based on the action and attributes that the user sets.
Mail
Property Detail
attachmentsproperty
public var attachments:Array

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

bccproperty 
public var bcc:String

Language Version: ActionScript 3.0
Product Version: CF 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.

ccproperty 
public var cc:String

Language Version: ActionScript 3.0
Product Version: CF 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.

charsetproperty 
public var charset:String

Language Version: ActionScript 3.0
Product Version: CF 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:

The default value is utf-8.

contentproperty 
public var content:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

failToproperty 
public var failTo:String

Language Version: ActionScript 3.0
Product Version: CF 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.

fromproperty 
public var from:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

E-mail message sender:

mailerIdproperty 
public var mailerId:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

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

mailPartsproperty 
public var mailParts:Array

Language Version: ActionScript 3.0
Product Version: CF 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.

mimeAttachproperty 
public var mimeAttach:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

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

passwordproperty 
public var password:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

A password to send to SMTP servers that require authentication.

portproperty 
public var port:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

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

priorityproperty 
public var priority:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

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

replyToproperty 
public var replyTo:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Addresses to which the recipient is directed to send replies.

serverproperty 
public var server:String

Language Version: ActionScript 3.0
Product Version: CF 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.

subjectproperty 
public var subject:String

Language Version: ActionScript 3.0
Product Version: CF 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#".

timeoutproperty 
public var timeout:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

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

toproperty 
public var to:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Message recipient e-mail addresses:

typeproperty 
public var type:String

Language Version: ActionScript 3.0
Product Version: CF 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:

userNameproperty 
public var userName:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

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

useSSLproperty 
public var useSSL:Boolean

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to use Secure Sockets Layer.

useTLSproperty 
public var useTLS:Boolean

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Whether to use Transport Level Security.

wrapTextproperty 
public var wrapText:String

Language Version: ActionScript 3.0
Product Version: CF 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: CF 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: CF 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.