The FooDoo Lounge

Mail 1.3.4 Dictionary

Copyright © 2003 Apple Computer, Inc., All Rights Reserved.

Index

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

Standard Suite: Common classes and commands for most applications.

Classes:

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

Plural form:

applications

Elements:

document

window

Properties:

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

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

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

Class color: A color.

Plural form:

colors

Class document: A document.

Plural form:

documents

Properties:

path plain text -- The document's path.

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

name plain text -- The document's name.

Class item: Abstract object provides a base class for scripting classes. It is never used directly.

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:

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

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

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

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

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

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

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

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

miniaturized boolean -- Whether the window is currently miniaturized.

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

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

visible boolean -- Whether the window is currently visible.

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

zoomed boolean -- Whether the window is currently zoomed.

Events:

close: Close an object.

close reference -- the object to close

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

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

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

count reference -- the object whose elements are to be counted

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

Result: integer -- the number of elements

delete: Delete an object.

delete reference -- the object to delete

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

duplicate reference -- the object(s) to duplicate

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

exists: Verify if an object exists.

exists reference -- the object in question

Result: boolean -- true if it exists, false if not

get: Get the data for an object.

get reference

Result: anything

make: Make a new object.

make

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

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

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

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

Result: reference -- to the new object

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

move reference -- the object(s) to move

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

open: Open an object.

open reference -- list of objects to open

print: Print an object.

print reference -- list of objects to print

quit: Quit an application.

quit

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

save: Save an object.

save reference -- the object to save, usually a document or window

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

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

set: Set an object's data.

set reference

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.

Plural form:

attachments

Properties:

<Inheritance> text [r/o] -- inherits elements and properties of the text class.

file name plain 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

Properties:

<Inheritance> text [r/o] -- inherits elements and properties of the text class.

Class character: This subdivides the text into characters.

Plural form:

characters

Properties:

<Inheritance> text [r/o] -- inherits elements and properties of the text class.

Class paragraph: This subdivides the text into paragraphs.

Plural form:

paragraphs

Properties:

<Inheritance> text [r/o] -- inherits elements and properties of the text class.

Class text: Rich (styled) text

Plural form:

text

Elements:

paragraph

word

character

attribute run

attachment

Properties:

color color -- The color of the first character.

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

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

Class word: This subdivides the text into words.

Plural form:

words

Properties:

<Inheritance> text [r/o] -- inherits elements and properties of the text class.

Mail: Classes and commands for the Mail application

Classes:

Class application: Mail's top level scripting object.

Plural form:

applications

Elements:

account

outgoing message

smtp server

Mac account

imap account

ldap server

mailbox

OLD message editor

message viewer

pop account

rule

signature

Properties:

<Inheritance> application [r/o] -- inherits elements and properties of the application class.

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

always bcc myself boolean -- Indicates whether you will be included in the Bcc: field of messages which you are composing

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

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

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

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

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

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

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

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

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

drafts mailbox mailbox [r/o] -- The top level Drafts mailbox

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

fixed width font plain text -- Font for plain text messages, only used if 'use fixed width font' is set to true

fixed width font size real -- Font size for plain text messages, only used if 'use fixed width font' is set to true

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

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

inbox mailbox [r/o] -- The top level In mailbox

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)

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

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

junk mailbox mailbox [r/o] -- The top level Junk mailbox

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

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

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

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

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

message list font plain text -- Font for message list

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

new mail sound plain text -- Name of new mail sound or 'None' if no sound is selected

outbox mailbox [r/o] -- The top level Out mailbox

should play other mail sounds boolean -- Indicates whether sounds will be played for various things such as when a messages is sent or if no mail is found when manually checking for new mail or if there is a fetch error

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

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

sent mailbox mailbox [r/o] -- The top level Sent mailbox

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

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

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

trash mailbox mailbox [r/o] -- The top level Trash mailbox

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

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

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

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

Plural form:

ldap servers

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

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

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

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

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

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

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

Class message viewer: Represents the object responsible for managing a viewer window

Plural form:

message viewers

Elements:

message

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

window window [r/o] -- The window for the viewer

drafts mailbox mailbox [r/o] -- The top level Drafts mailbox

inbox mailbox [r/o] -- The top level In mailbox

junk mailbox mailbox [r/o] -- The top level Junk mailbox

outbox mailbox [r/o] -- The top level Out mailbox

sent mailbox mailbox [r/o] -- The top level Sent mailbox

trash mailbox mailbox [r/o] -- The top level Trash mailbox

sort column attachments column/buddy availability column/message color/date received column/date sent column/flags column/from column/mailbox column/message status column/number column/size column/subject column/to column -- The column that is currently sorted in the viewer

sorted ascending boolean -- Whether the viewer is sorted ascending or not

mailbox list visible boolean -- Controls whether the list of mailboxes is visible or not

preview pane is visible boolean -- Controls whether the preview pane of the message viewer window is visible or not

visible columns attachments column/buddy availability column/message color/date received column/date sent column/flags column/from column/mailbox column/message status column/number column/size column/subject column/to column -- List of columns that are visible. The subject column and the message status column will always be visible

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

visible messages a list of message -- List of messages currently being displayed in the viewer

selected messages a list of message -- List of messages currently selected

selected mailboxes a list of mailbox -- List of mailboxes currently selected in the list of mailboxes

window window -- The window for the message viewer

Class outgoing message: A new email message

Plural form:

outgoing messages

Elements:

bcc recipient

cc recipient

recipient

to recipient

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

content text -- The contents of the message

sender plain text -- The sender of the message

subject plain text -- The subject of the message

content text -- The contents of the 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] -- inherits elements and properties of the item class.

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

name plain text -- Name of the signature

Events:

GetURL: Opens a mailto URL.

GetURL plain text -- the mailto URL

bounce: Bounces a message back to the sender.

bounce message -- the message to bounce

check for new mail: Triggers a check for email.

check for new mail

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

duplicate: Copy message(s) and put the copies in the specified mailbox.

duplicate reference -- the object(s) to duplicate

to mailbox -- The new mailbox for the messages(s).

extract address from: Command to get just the email address of a fully specified email address. E.g. Calling this with "John Doe <jdoe@example.com>" as the direct object would return "jdoe@example.com"

extract address from plain text -- fully formatted email address

Result: plain text -- the email address

extract name from: Command to get the full name out of a fully specified email address. E.g. Calling this with "John Doe <jdoe@example.com>" as the direct object would return "John Doe"

extract name from plain text -- fully formatted email address

Result: plain text -- the full name

forward: Creates a forwarded message.

forward message -- the message to forward

[opening window boolean] -- Whether the window for the forwarded message is shown. Default is to not show the window.

Result: outgoing message -- the message to be forwarded

mailto: Opens a mailto URL.

mailto plain text -- the mailto URL

move: Move message(s) to a new mailbox.

move reference -- the message(s) to move

to mailbox -- The new mailbox for the message(s).

perform mail action with messages: Script handler invoked by rules and menus that execute AppleScripts. The direct parameter of this handler is a list of messages being acted upon.

perform mail action with messages a list of message -- the message being acted upon

[in mailboxes mailbox] -- If the script is being executed by the user selecting an item in the scripts menu, this argument will specify the mailboxes that are currently selected. Otherwise it will not be specified.

[for rule rule] -- If the script is being executed by a rule action, this argument will be the rule being invoked. Otherwise it will not be specified.

redirect: Creates a redirected message.

redirect message -- the message to redirect

[opening window boolean] -- Whether the window for the redirected message is shown. Default is to not show the window.

Result: outgoing message -- the redirected message

reply: Creates a reply message.

reply message -- the message to reply to

[opening window boolean] -- Whether the window for the reply message is shown. Default is to not show the window.

[reply to all boolean] -- Whether to reply to all recipients. Default is to reply to the sender only.

Result: outgoing message -- the reply message

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

synchronize

with account -- The name of the account to synchronize

Message: Classes and commands for the Message framework

Classes:

Class Mac account: A .Mac email account

Plural form:

Mac accounts

Properties:

<Inheritance> imap account [r/o] -- inherits elements and properties of the imap account class.

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

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

delivery account smtp server -- The delivery account used when sending mail from this account

name plain text -- The name of an account

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

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

email addresses a list of plain text -- The list of email addresses configured for an account

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

empty junk messages frequency integer -- Number of days before junk 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)

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

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

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

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

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

account directory 'file' [r/o] -- The directory where the account stores things on disk

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

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

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

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

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

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

Plural form:

bcc recipients

Properties:

<Inheritance> recipient [r/o] -- inherits elements and properties of the recipient class.

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

Plural form:

cc recipients

Properties:

<Inheritance> recipient [r/o] -- inherits elements and properties of the recipient class.

Class container: A mailbox that contains other mailboxes.

Plural form:

containers

Properties:

<Inheritance> mailbox [r/o] -- inherits elements and properties of the mailbox class.

Class header: A header value for a message. E.g. To, Subject, From.

Plural form:

headers

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

content plain text -- Contents of the header

name plain text -- Name of the header value

Class imap account: An IMAP email account

Plural form:

imap accounts

Properties:

<Inheritance> account [r/o] -- inherits elements and properties of the account class.

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

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

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

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

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

Class mailbox: A mailbox that holds messages

Plural form:

mailboxes

Elements:

mailbox

message

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

name plain text -- The name of a mailbox

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

account account [r/o]

container mailbox [r/o]

Class message: An email message

Plural form:

messages

Elements:

bcc recipient

cc recipient

recipient

to recipient

header

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

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

background color blue/gray/green/none/orange/other/purple/red/yellow -- The background color of the message

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

content text -- Contents of an email message

date received date [r/o] -- The date a message was received

date sent date [r/o] -- The date a message was sent

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

flagged status boolean -- Indicates whether the message is flagged or not

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

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

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

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

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

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

sender plain text -- The sender of the message

subject plain text -- The subject of the message

was forwarded boolean -- Indicates whether the message was forwarded or not

was redirected boolean -- Indicates whether the message was redirected or not

was replied to boolean -- Indicates whether the message was replied to or not

Class pop account: A POP email account

Plural form:

pop accounts

Properties:

<Inheritance> account [r/o] -- inherits elements and properties of the account class.

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

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

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

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

Class recipient: An email recipient

Plural form:

recipients

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

address plain text -- The recipients email address

name plain text -- The name used for display

Class rule: Class for message rules

Plural form:

rules

Elements:

rule condition

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

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

delete message boolean -- If rule matches, delete message

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

forward message plain 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

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

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

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

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

run script 'file' -- If rule matches, run this AppleScript. Set to POSIX path of compiled AppleScript file. Set to empty string to disable this action

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

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

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

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

enabled boolean -- Indicates whether the rule is enabled

name plain text -- Name of rule

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

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

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

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

Plural form:

rule conditions

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

expression plain text -- Rule expression field

header plain text -- Rule header key

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

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

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

Plural form:

smtp servers

Properties:

<Inheritance> item [r/o] -- inherits elements and properties of the item class.

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

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

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

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

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

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

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

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

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

Class to recipient: An email recipient in the To: field

Plural form:

to recipients

Properties:

<Inheritance> recipient [r/o] -- inherits elements and properties of the recipient class.

Events:

send: Sends a message.

send message -- the message to send

 

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/Mail_134_asDict.html
|| created: 16-Aug-04, 10:20 PM; updated: 16-Aug-04, 10:20 PM
|| size: 119511 bytes