Powermail AS Dictionary
Powermail AS Dictionary
- Subject: Powermail AS Dictionary
- From: Michelle Steiner <email@hidden>
- Date: Tue, 28 Aug 2001 10:09:30 -0700
Required Suite: Terms that every application should support
Standard Suite: Common terms for most applications
close: Close an object
close reference -- the objects to close
[saving yes/no/ask] -- specifies whether or not changes should be
saved before closing
[in alias] -- the file in which to save the object
data size: Return the size in bytes of an object
data size reference -- the object whose data size is to be returned
Result: integer -- the size of the object in bytes
get: Get the data for an object
get reference -- the object whose data is to be returned
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 -- Object specifier for the new element
open: Open the specified object(s)
open reference -- Objects to open. Can be a list of files or an object
specifier.
print: Print the specified object(s)
print reference -- Objects to print. Can be a list of files or an
object specifier.
save: save a set of objects
save reference -- Objects to save.
[in alias] -- the file in which to save the object(s)
[as type class] -- the file type of the document in which to save the
data
set: Set an object9s data
set reference -- the object to change
to anything -- the new value
quit: Quit the Finder
quit
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
exists: Verify if an object exists
exists reference -- the object in question
Result: boolean -- true if it exists, false if not
delete: Delete an element from an object
delete reference -- the element to delete
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
Class application: An application program
Elements:
window by numeric index, by name, before/after another element
message database by numeric index
account by numeric index, by name
text signature by numeric index, by name
filter by numeric index, by name
scheduling by numeric index, by name
Properties:
connection in progress boolean [r/o] -- Are there any network
connections in progress?
current messages a list of reference [r/o] -- the current messages
(like the selection in the mail browser, or the message currently being
filtered)
in tray reference [r/o] -- to the in tray
out tray reference [r/o] -- to the out tray
sent mail container reference [r/o] -- to the sent mail folder
mail trash reference [r/o] -- to the mail trash
current scheduling reference -- the active mail scheduling
configuration
user folder alias [r/o] -- folder containung user's database files
attachment folder alias [r/o] -- folder where attachments are
downloaded
additions folder alias [r/o] -- PowerMail Additions folder
version version [r/o] -- the version of the application
frontmost boolean [r/o] -- is this the frontmost application?
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 -- the title of the window
visible boolean [r/o] -- is the window visible?
position point [r/o] -- upper left coordinates of window
displayed message reference [r/o] -- to the message being displayed,
if there is one
content Unicode text -- body of displayed message, if there is one
Miscellaneous: Miscellaneous useful events.
copy: Copy an object to the clipboard
copy reference -- the object to copy to the clipboard
cut: Cut an object to the clipboard
cut reference -- the object to cut to the clipboard
paste: Paste an object from the clipboard
paste reference
revert: Restore the object to its last saved state
revert reference -- the object to revert
select: Select the specified object
select reference -- the object to select
undo: Undoes the effects of the last command, if possible.
undo
odds and ends: Things that should be in some standard suite, but aren9t
SetTellTarget: Makes an object the 3focus2 of AppleEvents
SetTellTarget
[to reference] -- reference to new focus of AppleEvents
select: Select the specified object
select reference -- the object to select
PowerMail suite: A suite for scripting electronic messaging
send: Send items
send reference -- Items to send
Result: reference -- Outgoing items
connect to: Connect to an account
connect to reference -- the account to connect to
send waiting messages: sends the queued messages
send waiting messages
perform: performs a mail filer on the selected messages
perform reference -- the filter to perform
reply to: make a new reply message
reply to reference -- the 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
forward: make a new outgoing message to forward an incoming message
forward reference -- the message to reply to
[to a list of recipient] -- recipients of new message
Result: reference -- to the forward message
redirect: make a new outgoing message to redirect an incoming message
redirect reference -- the message to reply to
[to a list of recipient] -- recipients of new message
Result: reference -- to the redirected message
Class address: An e-mail message address
Plural form:
addresses
Properties:
display name Unicode text [r/o] -- the display name
address string [r/o] -- the e-mail address
Class message: Electronic message
Plural form:
messages
Elements:
attachment by numeric index
recipient by numeric index
Properties:
ID integer [r/o] -- the message's unique ID
sender address -- Sender of the message
subject Unicode text -- Subject of the message
content Unicode text -- Content of message
time sent date -- Time at which the message was sent
time received date -- time at which the message was received or created
status
draft/waiting/sending/sent/failed/confirmed/unread/read/replied/redirected/
forwarded -- Status of message
account item -- account from which the message has been retrieved or
sent
label small integer -- label of the message (integer from 0 to 10)
storage reference
headers string [r/o] -- the message headers
source string [r/o]
Class message container: Message container
Plural form:
message containers
Elements:
message by name, by numeric index
message container by name, by numeric index
Properties:
name Unicode text [r/o] -- the name of the folder
ID integer [r/o] -- the folder's unique ID
parent reference [r/o]
unread count integer [r/o] -- the number of unread messages in the
folder
unread count in hierarchy integer [r/o] -- the number of unread
messages in the folder and it's subfolders
unsent count integer [r/o] -- the number of unsent messages in the
folder
Class recipient: Message recipient
Plural form:
recipients
Properties:
address address -- Recipient address
recipient type to recipient/cc recipient/bcc recipient -- Recipient
type
Class message database: PowerMail message database
Plural form:
message databases
Elements:
message container by numeric index
Properties:
ID integer [r/o] -- the database's unique ID
kind local database/IMAP database [r/o] -- the kind of message
database
Class account: An e-mail account
Plural form:
accounts
Properties:
name Unicode text -- the name of the account
ID integer [r/o] -- the account's unique ID
kind POP account/IMAP account
use internet settings boolean -- true if this account uses the default
internet settings from the internet control panel
full name Unicode text -- the name of the user
address string -- the e-mail address of the account
user ID string -- the account ID on the server
incoming server string -- the POP/IMAP server used to retrieve mail
password string -- the password used to access the POP/IMAP server
(this property is write only)
external password boolean -- true if passord is stored in the keychain
outgoing server string -- the SMTP server used to send mail with the
account
text signature type none/internet/random/other -- the default type of
signature to be used for new messages
text signature choice reference -- the signature (if type is other)
leave on server boolean -- true to leave a copy of retrieved mail on
the server
delete from server after integer -- delete messages from the server
after number of days
delete from server when trashed boolean -- delete messages from the
server when they are deleted from local database
retrieve all boolean -- true to systematically retrieve all messages
from server
requires APOP boolean -- true to always send the password securely
Class scheduling: a mail scheduling configuration
Plural form:
schedulings
Properties:
name Unicode text -- the name of the scheduling
ID integer [r/o] -- the scheduling's unique ID
only when connected boolean -- automatic mail transfer anly if a
network connection is available
disconnect when done boolean -- disconnect PPP after mail transfer
retrieve every integer -- automaticly retrieve mail every seconds
retrieve on startup boolean -- automaticly retrieve mail on startup
retrieve accounts reference -- list of accounts to retrieve
send when queued boolean -- send mail immediately when queued
send when retrieving boolean -- automaticly send queued mail when
retrieving new mail
send before quitting boolean -- automatically send queued mail before
quitting PowerMail
default account item -- default account for new mail
use default account when replying boolean -- use default account when
replying
outgoing server string -- the SMTP server used to send mail
outgoing server user string -- user for SMTP server
Class attachment: An attachment to a message
Plural form:
attachments
Properties:
name Unicode text [r/o] -- the name of the attachment file
file type type class [r/o] -- the type of file
file creator type class [r/o] -- the creator of file
file size integer [r/o] -- the length of the file in bytes
file alias [r/o] -- alias to the file
encoding no encoding/binhex/base64/uuencode/AppleDouble/quoted
printable/smart encoding/unknown encoding [r/o] -- the MIME encoding of
the data
compression unknown compression/no compression/stuffit/zip [r/o] --
the compression format
Class text signature: a text signature
Plural form:
text signatures
Properties:
name Unicode text -- the name of the signature
ID integer [r/o] -- the signature's unique ID
in random boolean -- true if the signature is included in the random
list
signature Unicode text -- the signature text
Class filter: a mail filter
Plural form:
filters
Properties:
name Unicode text -- the name of the filter
ID integer [r/o] -- the filter's unique ID
Text Suite Subset: A set of classes for text processing
Class text: Text
Elements:
insertion point by numeric index, before/after another element,
satisfying a test, as a range of elements
character by numeric index, before/after another element, satisfying a
test, as a range of elements
word by numeric index, before/after another element, satisfying a test,
as a range of elements
line by numeric index, before/after another element, satisfying a test,
as a range of elements
paragraph by numeric index, before/after another element, satisfying a
test, as a range of elements
Properties:
class type class [r/o] -- the class
length integer [r/o] -- length of the text element, in characters
offset integer [r/o] -- the offset from the beginning of the
document, in characters
Class insertion point: An insertion location between two characters
Plural form:
insertion points
Properties:
<Inheritance> text [r/o] -- subclass of text
Class character: A character
Plural form:
characters
Properties:
<Inheritance> text [r/o] -- subclass of text
Class word: A word
Plural form:
words
Properties:
<Inheritance> text [r/o] -- subclass of text
Class line: A line
Plural form:
lines
Properties:
<Inheritance> text [r/o] -- subclass of text
Class paragraph: A paragraph
Plural form:
paragraphs
Properties:
<Inheritance> text [r/o] -- subclass of text
Class text style info: The on and off styles of a text item
Properties:
on styles a list of
plain/bold/italic/underline/outline/shadow/condensed/expanded [r/o]
off styles a list of
plain/bold/italic/underline/outline/shadow/condensed/expanded [r/o]
URL Suite: Standard suite for Uniform Resource Locators
GetURL: handles the mailto: URL
GetURL string -- The URL
[attaching a list of file specification] -- list of files to attach
Result: small integer -- error result
----------------------------------------------------------------------
| Michelle Steiner | We're not human beings having a spiritual |
| | experience. We're spiritual beings |
| email@hidden | having a human experience. |
----------------------------------------------------------------------