The FooDoo Lounge

Claris Emailer 2.0.3 Dictionary

Copyright © 1995-1998 Claris Corporation. All rights reserved.

Index

  1. Standard Suite
  2. Emailer Suite
  3. Addressing mail
  4. Mail suite
  5. Standard URL Suite
  6. Mail Agent Protocol Suite
  7. Bookmark suite
  8. Miscellaneous Standards

Standard Suite: Common terms for most applications

Classes:

Class application: An application program

Plural form:

applications

Elements:

menu by numeric index, by name, satisfying a test

window by numeric index, by name, satisfying a test

account by numeric index, by name, by ID

signature by numeric index, by name

folder by numeric index, by name, satisfying a test, by ID

priority by numeric index, by name, satisfying a test

incoming message window by numeric index, by name, satisfying a test

outgoing message window by numeric index, by name, satisfying a test

browser window by numeric index, by name, satisfying a test

address book window by numeric index, by name, satisfying a test

message by ID

incoming message by ID

outgoing message by ID

auto file log by ID

error log by ID

address by numeric index, by name, satisfying a test, by ID

contact by numeric index, by name, satisfying a test, by ID

group by numeric index, by name, satisfying a test, by ID

Properties:

frontmost boolean [r/o] -- is this the frontmost application?

name international text [r/o] -- the name

selection anything -- the selection visible to the user

version version [r/o] -- the version of the application

clipboard a list of anything [r/o] -- the clipboard

in box folder reference [r/o] -- to the In Box folder

out box folder reference [r/o] -- to the Out Box folder

sent mail folder reference [r/o] -- to the Sent Mail folder

deleted mail folder reference [r/o] -- to the Deleted Mail folder

read mail folder reference [r/o] -- to the Read Mail folder

log folder reference [r/o] -- to the log folder

entire folder hierarchy a list of reference [r/o] -- to every folder in the hierarchy

schedules enabled boolean -- Are schedules enabled?

connection in progress boolean [r/o] -- Is there a connection in progress?

filtered message reference [r/o] -- to the message currently being filtered

printing font international text -- the printing font

printing font size small integer -- the printing font size

properties record -- The list of all properties of the application

Class file: A file

Plural form:

files

Properties:

name string [r/o] -- the name of the file

Class window: A window

Plural form:

windows

Properties:

bounds bounding rectangle -- the boundary rectangle for the window

closeable boolean [r/o] -- Does the window have a close box?

titled boolean [r/o] -- Does the window have a title bar?

index integer -- the number of the window

floating boolean [r/o] -- Does the window float?

modal boolean [r/o] -- Is the window modal?

resizable boolean [r/o] -- Is the window resizable?

zoomable boolean [r/o] -- Is the window zoomable?

zoomed boolean -- Is the window zoomed?

name international text [r/o] -- the title of the window

selection anything -- the selection visible to the user

visible boolean [r/o] -- is the window visible?

position point -- the position of the upper-left corner

modified boolean [r/o] -- has the window been modified since the last save?

properties record -- The list of all properties of the window

Events:

close: Close an object

close reference -- the object to close

[saving yes/no/ask] -- specifies whether or not changes should be saved before closing

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 the elements to be counted

Result: integer -- the number of elements

data size: Return the size in bytes of an object

data size reference -- the object whose data size is to be returned

[as type class] -- the data type for which the size is calculated

Result: integer -- the size of the object in bytes

delete: Delete an element from an object

delete reference -- the element to delete

duplicate: Duplicate object(s)

duplicate reference -- the object(s) to duplicate

[to location reference] -- the new location for the object(s)

Result: reference -- to the duplicated 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 -- the object whose data is to be returned

[as a list of type class] -- the desired types for the data, in order of preference

Result: anything -- the data from the object

make: Make a new element

make

new type class -- the class of the new element

[at location reference] -- the location at which to insert the element

[with data anything] -- the initial data for the element

[with properties record] -- the initial values for the properties of the element

Result: reference -- to the new object(s)

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)

Result: reference -- to the object(s) after they have been moved

open: Open the specified object(s)

open reference -- list of objects to open

print: Print the specified object(s)

print reference -- list of objects to print

quit: Quit an application program

quit

[saving yes/no/ask] -- Specifies whether or not to save currently open documents

save: Save an object

save reference -- the object to save

[in alias] -- the file in which to save the object

[as type class] -- the file type of the document in which to save the data

set: Set an object's data

set reference -- the object to change

to anything -- the new value

Emailer Suite: Events specific to Claris Emailer

Classes:

Class account: An account

Plural form:

accounts

Properties:

name string [r/o] -- name of the account

Class address book window: The address book window

Plural form:

address book windows

Properties:

<Inheritance> window [r/o] -- subclass of item

Class auto file log: An auto file log

Plural form:

auto file logs

Properties:

<Inheritance> message [r/o] -- subclass of item

filed messages a list of reference [r/o] -- List of filed messages

Class browser window: A browser window

Plural form:

browser windows

Properties:

<Inheritance> window [r/o] -- subclass of item

current folder reference [r/o] -- to folder being browsed

sort column status column/subject column/date column/name column/priority column/account column -- Column used to sort messages

sort order ascending/descending -- Sort order

Class contact: A contact in the address book

Plural form:

contacts

Elements:

email address by numeric index, by name, satisfying a test

Properties:

<Inheritance> address [r/o] -- subclass of item

first name string -- the contact's first name

last name string -- the contact's last name

description string -- the description of the contact

ldif entry string [r/o] -- information about the contact in ldif format

default email address reference -- reference to the contact's default email address

hide in lists boolean -- true if the contact is not shown in address book lists

Class email address: An email address contained by a contact

Plural form:

email addresses

Properties:

address string -- internet address as a string

description string -- a description of the address

Class error log: An error log message

Plural form:

error logs

Properties:

<Inheritance> message [r/o] -- subclass of item

Class folder: A folder of messages

Plural form:

folders

Elements:

folder by numeric index, by name, satisfying a test

Properties:

<Inheritance> message container [r/o] -- subclass of item

name string -- name of the folder

parent reference [r/o] -- to the folder's parent

shown in folder list boolean -- Is this a favorite folder?

has unread messages boolean [r/o] -- Does the folder have any unread messages?

Class group: A group of contacts in the address book

Plural form:

groups

Elements:

group member by numeric index, by name, satisfying a test

Properties:

name string -- name of the group

description string -- a description of the group

ldif entry string [r/o] -- information about the group in ldif format

Class group member: Information for a member of a group in the address book

Plural form:

group members

Properties:

entry reference -- reference to the contact for the member

address choice reference -- reference to one of the contact's email addresses

Class incoming message window: An incoming message window

Plural form:

incoming message windows

Properties:

<Inheritance> message window [r/o] -- subclass of item

Class message window: A message window

Plural form:

message windows

Properties:

<Inheritance> window [r/o] -- subclass of item

displayed message reference [r/o] -- to the message displayed in the window

selection string -- Selected text

message font string -- Font used to display message

message font size small integer -- Size of font used to display message

headers displayed boolean -- Is the headers pane expanded?

enclosures displayed boolean -- Is the enclosures pane expanded?

Class outgoing message window: An outgoing message window

Plural form:

outgoing message windows

Properties:

<Inheritance> message window [r/o] -- subclass of item

Class outgoing recipient: A recipient of an outgoing message

Plural form:

outgoing recipients

Properties:

<Inheritance> recipient [r/o] -- subclass of item

delivery status unsent/sent/problem -- Delivery status of recipient

Class priority: A message priority

Plural form:

priorities

Properties:

name string -- name of the priority

index integer [r/o] -- Index of the priority

color RGB color -- The color of the priority

Class recipient_old: recipient entry, for compatibility only. Use recipient from Mail Suite instead.

Properties:

name_old string -- Name of the recipient

address_old string -- Internet address of the recipient

type_old small integer -- Addressing type for the recipient

Class signature: A message signature

Plural form:

signatures

Properties:

name string [r/o] -- name of the signature

contents string -- text of the signature

Events:

check mail: Marks an account for checking

check mail

[account_name string] -- Name of the account

[account ID string] -- User ID

[server name string] -- Server name

[server zone string] -- Zone name

connect to: Connect to service or account and transfer mail

connect to string -- The service or account to connect to

[sending boolean] -- True to send messages to the specified service or account

[checking boolean] -- True to get messages from the specified service or account

[TCP control boolean] -- True to have Emailer control TCP with plugin

convert Emailer1: Convert your 1.X mail to 2.X mail

convert Emailer1

create mail: Create new outgoing mail. For compatibility only. Use make new message instead.

create mail

[subject string] -- Subject of the message

[body string] -- Body of the message

[compress boolean] -- True to compress enclosures

[encoding small integer] -- Encoding for the enclosure

[files a list of list] -- List of files to attach

[recipients a list of record] -- List of recipient_old records

[save boolean] -- True to save and schedule

filter: Apply mail actions to incoming message

filter reference -- Incoming message to filter

forward: Forward a message

forward reference -- message to forward

[to a list of recipient] -- recipients of new message

Result: reference -- to the forwarded message

redirect: Redirect a message

redirect reference -- message to redirect

[to a list of recipient] -- recipients of new message

Result: reference -- to the redirected message

reply to: Create a new outgoing message as a reply to an incoming message

reply to reference -- incoming message to reply to

[replying to all boolean] -- Should the reply to go to all recipients of the message?

Result: reference -- to the reply message

Addressing mail: Address type for Mail Suite

Classes:

Class address: Electronic messaging address

Plural form:

addresses

Properties:

display name international text -- Name used for address display

address type internet/fax/appletalk/powershare/powertalk -- Address type (default is internet)

address international text -- Address string

url international text -- URL for address

Mail suite: A suite for scripting electronic messaging

Classes:

Class incoming message: An incoming message

Plural form:

incoming messages

Properties:

<Inheritance> message [r/o] -- subclass of item

read status untouched/opened/read/in trash -- Read status of message

receiving account account [r/o] -- the account the message was received from

reply id integer -- ID of reply to message (or 0 for none)

redirect id integer -- ID of redirect of message (or 0 for none)

long headers string [r/o] -- The long headers

time received date [r/o] -- Time at which the message was received

Class message: Electronic message

Plural form:

messages

Elements:

file by name, by numeric index, satisfying a test

recipient by name, by numeric index, satisfying a test

Properties:

sender address [r/o] -- Sender of the message

subject international text -- Subject of the message

content string -- Content of message

time sent date [r/o] -- Time at which the message was sent

storage reference -- to the folder that contains the message

message priority priority -- the priority of the message

id integer [r/o] -- unique ID for message

headers string [r/o] -- The message headers

properties record -- The list of all properties of the message

Class message container: Message container

Plural form:

message containers

Elements:

message by name, by numeric index, satisfying a test

incoming message by name, by numeric index, satisfying a test

outgoing message by name, by numeric index, satisfying a test

auto file log by name, by numeric index, satisfying a test

error log by name, by numeric index, satisfying a test

message container by name, by numeric index, satisfying a test

Properties:

properties record -- The list of all properties of the message container

Class outgoing message: An outgoing message

Plural form:

outgoing messages

Elements:

outgoing recipient by name, by numeric index, satisfying a test

Properties:

<Inheritance> message [r/o] -- subclass of item

delivery status unsent/sent/problem [r/o] -- Delivery status of message

scheduled boolean -- Is the message scheduled to be sent during the next connection?

signature type none/default for account/random/internet config/other -- Type of signature to be used for the message

other signature choice reference -- to signature to be used, if signature type is other

sending account account -- account to use to send message

compress enclosures boolean -- Compress enclosures?

enclosure encoding service default/no encoding/binhex/base64/uuencode/AppleSingle/AppleDouble -- Type of encoding to use for enclosures

Class recipient: Message recipient

Plural form:

recipients

Properties:

address address -- Recipient address

recipient type to recipient/cc recipient/bcc recipient -- Recipient type

Events:

send: Send items

send reference -- Items to send

Standard URL Suite: Standard Suite for Uniform Resource Locators

Events:

handle URL: Create a message based on a mailto: URL

handle URL string -- The mailto: URL

resolve URL: Resolve a URL and pass it to Internet Config

resolve URL string -- The URL to resolve

Mail Agent Protocol Suite: Suite for receiving of notification new maill

Events:

start notifying: Start notifying an application of new mail

start notifying alias -- An application to notify

stop notifying: Stop notifying an application of new mail

stop notifying alias -- An application currently being notified, or omit for all

Bookmark suite: Suite for handling bookmarks

Events:

save bookmark: Add a mailto URL to the address book

save bookmark string -- mailto URL to add

[name string] -- The user's name

Miscellaneous Standards: Miscellaneous standard events and classes

Classes:

Class menu: A menu

Plural form:

menus

Elements:

menu item by numeric index, by name

Properties:

menu ID small integer [r/o] -- the menu ID for the menu

name international text [r/o] -- the name

Class menu item: A menu item

Plural form:

menu items

Properties:

enabled boolean [r/o] -- Is the menu item is enabled?

item number small integer [r/o] -- the menu item number

name international text [r/o] -- The name

Events:

copy: Copy an object to the clipboard

copy

cut: Cut an object to the clipboard

cut

paste: Paste an object from the clipboard

paste

select: Select object(s)

select reference -- Object(s) to select

undo: Undo the action of the previous event or user interaction

undo

 

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