The FooDoo Lounge

Mail 1.2 Dictionary

Copyright Apple Computer, Inc. 2002. All rights reserved.

Index

  1. Standard Suite
  2. Text Suite
  3. Mail suite
  4. Message suite

Standard Suite: Common classes and commands for most applications.

Classes:

Class application: An application's top level scripting object.

Plural form:

applications

Elements:

document by name, by numeric index, before/after another element, as a range of elements, satisfying a test

window by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

frontmost boolean [r/o] -- Is this the frontmost (active) application?

name Unicode text [r/o] -- The name of the application.

version Unicode text [r/o] -- The version of the application.

Class color: A color.

Plural form:

colors

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

Class document: A document.

Plural form:

documents

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

path Unicode text -- The document's path.

modified boolean [r/o] -- Has the document been modified since the last save?

name Unicode text -- The document's name.

Class item: A scriptable object.

Plural form:

items

Properties:

class type class [r/o] -- The class of the object.

properties record -- All of the object's properties.

Class window: A window.

Plural form:

windows

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

modal boolean [r/o] -- Whether the window is the application's current modal window.

closeable boolean [r/o] -- Whether the window has a close box.

name Unicode text -- The full title of the window.

resizable boolean [r/o] -- Whether the window can be resized.

index integer -- The index of the window in the back-to-front window ordering.

miniaturizable boolean [r/o] -- Whether the window can be miniaturized.

floating boolean [r/o] -- Whether the window floats.

bounds bounding rectangle -- The bounding rectangle of the window.

zoomed boolean -- Whether the window is currently zoomed.

visible boolean -- Whether the window is currently visible.

id integer [r/o] -- The unique identifier of the window.

titled boolean [r/o] -- Whether the window has a title bar.

miniaturized boolean -- Whether the window is currently miniaturized.

zoomable boolean [r/o] -- Whether the window can be zoomed.

document document [r/o] -- The document whose contents are being displayed in the window.

Events:

close: Close an object.

close reference -- the object for the command

[saving in Unicode text] -- The file in which to save the object.

[saving ask/yes/no] -- Specifies whether changes should be saved before closing.

count: Return the number of elements of a particular class within an object.

count reference -- the object for the command

[each type class] -- The class of objects to be counted.

Result: integer -- the reply for the command

delete: Delete an object.

delete reference -- the object for the command

duplicate: Copy object(s) and put the copies at a new location.

duplicate reference -- the object for the command

to location reference -- The location for the new object(s).

[with properties record] -- Properties to be set in the new duplicated object(s).

exists: Verify if an object exists.

exists reference -- the object for the command

Result: boolean -- the reply for the command

get: Get the data for an object.

get reference -- the object for the command

Result: anything -- the reply for the command

make: Make a new object.

make

[at location reference] -- The location at which to insert the object.

new type class -- The class of the new object.

[with data anything] -- The initial data for the object.

[with properties record] -- The initial values for properties of the object.

Result: reference -- the reply for the command

move: Move object(s) to a new location.

move reference -- the object for the command

to location reference -- The new location for the object(s).

open: Open an object.

open a list of alias -- list of objects

print: Print an object.

print a list of alias -- list of objects

quit: Quit an application.

quit reference -- the object for the command

[saving ask/yes/no] -- Specifies whether changes should be saved before quitting.

save: Save an object.

save reference -- the object for the command

[in Unicode text] -- The file in which to save the object.

[as Unicode text] -- The file type in which to save the data.

set: Set an object's data.

set reference -- the object for the command

to anything -- The new value.

Text Suite: A set of basic classes for text processing.

Classes:

Class attachment: Represents an inline text attachment. This class is used mainly for make commands.

Elements:

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

character by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> text [r/o] -- All of the properties of the superclass.

file name Unicode text -- The path to the file for the attachment

Class attribute run: This subdivides the text into chunks that all have the same attributes.

Plural form:

attribute runs

Elements:

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

character by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

size integer -- The size in points of the first character.

Class character: This subdivides the text into characters.

Plural form:

characters

Elements:

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

character by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

size integer -- The size in points of the first character.

Class paragraph: This subdivides the text into paragraphs.

Plural form:

paragraphs

Elements:

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

character by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

size integer -- The size in points of the first character.

Class text: Rich (styled) text

Elements:

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

character by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

size integer -- The size in points of the first character.

Class word: This subdivides the text into words.

Plural form:

words

Elements:

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

character by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

size integer -- The size in points of the first character.

Mail suite: Mail specific classes

Classes:

Class OLD message editor: DEPRECATED - DO NOT USE

Plural form:

OLD message editors

Elements:

outgoing message by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

Class application: Mail's top level scripting object

Plural form:

applications

Elements:

rule by name, by numeric index, before/after another element, as a range of elements, satisfying a test

imap account by name, by numeric index, before/after another element, as a range of elements, satisfying a test

smtp server by name, by numeric index, before/after another element, as a range of elements, satisfying a test

ldap server by name, by numeric index, before/after another element, as a range of elements, satisfying a test

account by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Mac account by name, by numeric index, before/after another element, as a range of elements, satisfying a test

pop account by name, by numeric index, before/after another element, as a range of elements, satisfying a test

signature by name, by numeric index, before/after another element, as a range of elements, satisfying a test

outgoing message by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

mailbox by name, by numeric index, before/after another element, as a range of elements, satisfying a test

OLD message editor by numeric index, before/after another element, as a range of elements, satisfying a test

document by name, by numeric index, before/after another element, as a range of elements, satisfying a test

window by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> application [r/o] -- All of the properties of the superclass.

highlight selected thread boolean -- Indicates whether threads should be highlighted in the Mail viewer window

selection list [r/o] -- List of messages that the user has selected

download html attachments boolean -- Indicates whether images and attachments in HTML messages should be downloaded and displayed

framework version Unicode text [r/o] -- The build number for the Message framework, used by Mail

choose signature when composing boolean -- Indicates whether user can choose a signature directly in a new compose window

message font Unicode text -- Font for messages (proportional font)

header detail custom/no headers/default/all -- The level of detail shown for headers on incoming messages

level one quoting color yellow/orange/green/other/red/blue/purple -- Color for quoted text with one level of indentation

same reply format boolean -- Indicates whether replies will be in the same text format as the message to which you are replying

use keychain boolean -- Indicates whether Mail will use the Keychain to store all email passwords

use fixed width font boolean -- Should fixed-width font be used for plain text messages?

color quoted text boolean -- Indicates whether quoted text should be colored

show online buddy status boolean -- Indicates whether Mail will show online buddy status

always cc myself boolean -- Indicates whether you will be included in the Cc: field of messages to which you are replying

background activity count integer [r/o] -- Number of background activities currently running in Mail, according to the Activity Viewer

level three quoting color yellow/orange/green/other/red/blue/purple -- Color for quoted text with two levels of indentation

fetches automatically boolean -- Indicates whether mail will automatically be fetched at a specific interval

new mail sound Unicode text -- Name of new mail sound or "None" if no sound is selected

level two quoting color yellow/orange/green/other/red/blue/purple -- Color for quoted text with two levels of indentation

message font size small real -- Font size for messages (proportional font)

message list font Unicode text -- Font for message list

use address completion boolean -- Indicates whether network directories (LDAP) and Address Book will be used for address completion

expand group addresses boolean -- Indicates whether group addresses will be expanded when entered into the address fields of a new compose message

selected signature Unicode text -- Name of current selected signature (or 'randomly', 'sequentially', or 'none')

check spelling while typing boolean -- Indicates whether spelling will be checked automatically in messages being composed

primary email Unicode text [r/o] -- The user's primary email address

include all original message text boolean -- Indicates whether all of the original message will be quoted or only the text you have selected (if any)

application version Unicode text [r/o] -- The build number for the Mail application bundle

fixed width font Unicode text -- Font for messages (fixed-width font)

message list font size small real -- Font size for message list

fixed width font size small real -- Font size for messages (fixed-width font)

fetch frequency integer -- The interval (in minutes) between automatic fetches of new mail

quote original message boolean -- Indicates whether the text of the original message will be included in replies

default message format plain text/rich text -- Default format for messages being composed or message replies

Class ldap server: LDAP servers for use in type completion in Mail

Plural form:

ldap servers

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

is active boolean -- Indicates whether this LDAP server will be used for type completion in Mail

port integer -- Port number for the LDAP server (default is 389)

host name Unicode text -- Internet address (myldapserver.company.com) for LDAP server

search base Unicode text -- Search base for this LDAP server (not required by all LDAP servers)

name Unicode text -- Name of LDAP server configuration to be displayed in Composing preferences

scope subtree/one level/base -- Scope setting for the LDAP server

Class outgoing message: A new email message

Plural form:

outgoing messages

Elements:

recipient by name, by numeric index, before/after another element, as a range of elements, satisfying a test

to recipient by name, by numeric index, before/after another element, as a range of elements, satisfying a test

cc recipient by name, by numeric index, before/after another element, as a range of elements, satisfying a test

bcc recipient by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

sender Unicode text -- The sender of the message

subject Unicode text -- Subject of email message

content text -- Contents of an email message

visible boolean -- Controls whether the message window is shown on the screen. The default is false

message signature signature -- The signature of the message

id integer [r/o] -- The unique identifier of the message

Class signature: Email signatures

Plural form:

signatures

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

name anything -- Name of the signature

content Unicode text -- Contents of email signature. If there is a version with fonts and/or styles, that will be returned over the plain text version

Events:

GetURL: Opens a mailto URL

GetURL reference -- the object for the command

check for new mail: Command to trigger checking email for all active accounts

check for new mail reference -- the object for the command

[for account ] -- Specify the account that you wish to check for mail

mailto: Opens a mailto URL

mailto reference -- the object for the command

synchronize: Command to trigger synchronizing of an IMAP account with the server

synchronize reference -- the object for the command

with account -- The name of the account to synchronize

Message suite: Message specific classes

Classes:

Class Mac account: A .Mac account

Plural form:

Mac accounts

Elements:

mailbox by name, by numeric index, before/after another element, as a range of elements, satisfying a test

smtp server by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> imap account [r/o] -- All of the properties of the superclass.

Class account: A Mail account for receiving messages (IMAP/POP/.Mac). To create a new receiving account, use the 'pop account', 'imap account', and 'Mac account' objects

Plural form:

accounts

Elements:

mailbox by name, by numeric index, before/after another element, as a range of elements, satisfying a test

smtp server by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

is enabled boolean -- Indicates whether the account is enabled or not

empty trash on quit boolean -- Indicates whether the messages in deleted messages mailboxes will be permanently deleted on quit

server name Unicode text -- The host name used to connect to an account

user name Unicode text -- The user name used to connect to an account

empty sent messages on quit boolean -- Indicates whether the messages in the sent messages mailboxes will be deleted on quit

move deleted messages to trash boolean -- Indicates whether messages that are deleted will be moved to the trash mailbox

account directory Unicode text [r/o] -- The directory where the account stores things on disk

include when getting new mail boolean -- Indicates whether the account will be included when getting new mail

uses ssl boolean -- Indicates whether SSL is enabled for this receiving account

password Unicode text -- Password for this account. Can be set, but not read via scripting

account type imap/Mac/pop/smtp [r/o] -- The type of an account

email addresses list -- The list of email addresses configured for an account

full name Unicode text -- The users full name configured for an account

empty trash frequency integer -- Number of days before messages in the trash are permanently deleted (0 = never delete, -1 = delete on quit)

empty junk messages on quit boolean -- Indicates whether the messages in the junk messages mailboxes will be deleted on quit

port integer -- The port used to connect to an account

name Unicode text -- The name of an account

empty junk messages frequency integer -- Number of days before archived sent messages are deleted (0 = never delete, -1 = delete on quit)

empty sent messages frequency integer -- Number of days before archived sent messages are deleted (0 = never delete, -1 = delete on quit)

Class bcc recipient: An email recipient in the Bcc: field

Plural form:

bcc recipients

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

name Unicode text -- The name used for display

address anything -- The recipients email address

Class cc recipient: An email recipient in the Cc: field

Plural form:

cc recipients

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

name Unicode text -- The name used for display

address anything -- The recipients email address

Class imap account: An IMAP email account

Plural form:

imap accounts

Elements:

mailbox by name, by numeric index, before/after another element, as a range of elements, satisfying a test

smtp server by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> account [r/o] -- All of the properties of the superclass.

compact mailboxes when closing boolean -- Indicates whether an IMAP mailbox is automatically compacted when you quit Mail or switch to another mailbox

authentication md5/kpop/password/kerberos 4/kerberos 5/none -- Preferred authentication scheme for account

message caching all messages but omit attachments/all messages and their attachments/do not keep copies of any messages/only messages I have read -- Message caching setting for this account

store sent messages on server boolean -- Indicates whether sent messages will be stored on the IMAP server

store deleted messages on server boolean -- Indicates whether deleted messages will be stored on the IMAP server

store drafts on server boolean -- Indicates whether drafts will be stored on the IMAP server

store junk mail on server boolean -- Indicates whether junk mail will be stored on the IMAP server

Class mailbox: A mailbox that holds messages

Plural form:

mailboxes

Elements:

message by numeric index, before/after another element, as a range of elements, satisfying a test

account by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

unread count integer [r/o] -- The number of unread messages in the mailbox

name Unicode text -- The name of a mailbox

Class message: An email message

Plural form:

messages

Elements:

recipient by name, by numeric index, before/after another element, as a range of elements, satisfying a test

to recipient by name, by numeric index, before/after another element, as a range of elements, satisfying a test

cc recipient by name, by numeric index, before/after another element, as a range of elements, satisfying a test

bcc recipient by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

date sent date -- The date a message was received

content text -- Contents of an email message

source Unicode text [r/o] -- Raw source of the message

mailbox mailbox -- The mailbox in which this message is filed

sender Unicode text -- The sender of the message

message id Unicode text [r/o] -- The unique message ID string

message size integer -- The size (in bytes) of a message

reply to Unicode text -- The address that replies should be sent to

subject Unicode text -- Subject of email message

is junk mail boolean -- Indicates whether the message has been marked junk or evaluated to be junk by the junk mail filter.

is deleted boolean -- Indicates whether the message is deleted or not

is read boolean -- Indicates whether the message is read or not

headers Unicode text [r/o] -- All the headers of the message

Class pop account: A POP email account

Plural form:

pop accounts

Elements:

mailbox by name, by numeric index, before/after another element, as a range of elements, satisfying a test

smtp server by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> account [r/o] -- All of the properties of the superclass.

authentication md5/kpop/password/kerberos 4/kerberos 5/none -- Preferred authentication scheme for account

delete messages when moved from inbox boolean -- Indicates whether messages will be deleted from the server when moved from your POP inbox

big message warning size integer -- If message size (in bytes) is over this amount, Mail will prompt you asking whether you want to download the message

delayed message deletion interval integer -- Number of days before messages that have been downloaded will be deleted from the server. Set to 0 to have them deleted immediately

delete mail on server boolean -- Indicates whether POP account deletes messages on the server after downloading

Class recipient: An email recipient

Plural form:

recipients

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

name Unicode text -- The name used for display

address anything -- The recipients email address

Class rule: Class for message rules

Plural form:

rules

Elements:

rule condition by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

is enabled boolean -- Indicates whether rule is enabled

redirect message list -- If rule matches, redirect message to this address or multiple addresses, separate by commas. Set to empty string to disable this action

delete message boolean -- If rule matches, delete message

should transfer message boolean -- Indicates whether the rule has a transfer action

transfer message mailbox -- If rule matches, transfer to this mailbox

mark read boolean -- If rule matches, mark message as read

name Unicode text -- Name of rule

play sound Unicode text -- If rule matches, play this sound (specify name of sound or path to sound)

all conditions must be met boolean -- Indicates whether all conditions must be met for rule to execute

forward text Unicode text -- If rule matches, prepend this text to the forwarded message. Set to empty string to include no prepended text

highlight text using color boolean -- Indicates whether the color will be used to highlight the text or background of a message in the message list

color message yellow/orange/none/other/green/gray/red/blue/purple -- If rule matches, apply this color

stop evaluating rules boolean -- If rule matches, stop rule evaluation for this message

forward message Unicode text -- If rule matches, forward message to this address, or multiple addresses, separated by commas. Set to empty string to disable this action

mark flagged boolean -- If rule matches, mark message as flagged

reply text Unicode text -- If rule matches, reply to message and prepend with this text. Set to empty string to disable this action

Class rule condition: Class for conditions that can be attached to a single rule

Plural form:

rule conditions

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

type matches every message/message is junk mail/to header/message content/cc header/sender is in my address book/sender is not in my address book/to or cc header/subject header/sender is member of group/account/sender is not member of group/any recipient/... -- Rule type

expression Unicode text -- Rule expression field

qualifier is equal to value/does contain value/does not contain value/ends with value/begins with value -- Rule qualifier (Contains, Does not contain, Starts with, Ends with, Is equal to). Set to empty string to remove qualifier

Class smtp server: An SMTP account (for sending email)

Plural form:

smtp servers

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

authentication md5/kpop/password/kerberos 4/kerberos 5/none -- Preferred authentication scheme for account

is enabled boolean -- Indicates whether the account is enabled or not

server name Unicode text -- The host name used to connect to an account

user name Unicode text -- The user name used to connect to an account

server port integer -- The port used to connect to an account

name Unicode text [r/o] -- The name of an account

account type Unicode text [r/o] -- The type of an account

use ssl boolean -- Indicates whether SSL is enabled for this receiving account

password Unicode text -- Password for this account. Can be set, but not read via scripting

Class to recipient: An email recipient in the To field

Plural form:

to recipients

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

name Unicode text -- The name used for display

address anything -- The recipients email address

Events:

send: Sends a message

send reference -- the object for the command

 

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/Mail_120_asDict.html
|| created: 4-Aug-03, 9:48 PM; updated: 4-Aug-03, 2:48 PM
|| size: 115953 bytes