AppleScript Reference for Outlook Express 5.0

| A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z |

Introduction

The following two imaginary reference entries illustrate how this document is organized, using "real world" examples of a pet dog and planting a cactus. Following each example is a section of notes that explain how an actual entry might differ from these imaginary ones.

Class/property example: dog

dog

Mammal very similar to wolf. Class.

Plural form

dogs

Elements

ear by numeric index, by condition

eye by numeric index, by condition

leg by numeric index, by condition

nose

paw by numeric index, by condition

tail

tongue

tooth by numeric index, by condition

Properties

age, breed, color, favorite toy, housebroken, last vaccination, name, neutered, sex, size

Remarks

This class is useful for discouraging intruders but is frequently affectionate as well. It is an element of both the family and the K9 corps classes.

Each paw element of a dog contains several claw and toe elements.

You can teach dogs tricks with the train command, but this operation will return an error if the age property of the dog has a high value, so place the command within a try block.

The ear, eye, eyebrow, leg, paw, and tooth elements of dog can all be accessed by index, but not the nose, tail, and tongue elements, since each dog contains only one of these elements.

Example

set the last vaccination of dog "Sparky" �
    of household "Someone" to "September 5, 1999"

Note Entries for classes and properties are quite similar, except that if the example above were an entry for a property, rather than for a class, it would not contain sections for Plural form, Elements, or properties, but would contain an additional phrase near the beginning indicating which classes have it as a property. For example, the administrative address class (see below) contains a Property of section that specifies mailing list.

The data type of a property is not specified in the entry if the values are enumerated; for example, the read status property (see below) has two possible values (read and untouched) instead of a normal data type. If a property uses a set of enumerated values rather than a standard data type, the entry has a Possible values section.

Command example: plant

plant

Place the specified flora in the ground where it can grow. Command.

Syntax

plant Reference [in Location Reference using Reference]

Result

Boolean

Remarks

The first parameter, a Reference, specifies a bush, tree, vine, or other flora to place in the ground. The optional in parameter specifies a planting location, and the optional using parameter specifies the shovel or other implement used to dig the hole.

The result is a Boolean indicating the success or failure of the operation. A value of true indicates the organism was planted successfully.

Example

plant cactus 23 in desert "Mojave" �
    using shovel 1 of backpack "Someone's Backpack"

Note If the value returned by a command is unusual in some way, the reference entry for the command will contain an Example results section after the Example section, showing values that the command might return.

Reference Entries

A

account

The e-mail account associated with the message or window. Reference.

Property of

draft news window, draft window, message

add prefix

Whether to add a prefix to messages from this mailing list. Boolean.

Property of

mailing list

Remarks

A value of true for this property specifies that the prefix contained in the prefix property of this mailing list should be added to messages from the list.

additional headers

Headers to add to outgoing messages from the e-mail account or news server that are not automatically added by the e-mail or news software. String.

Property of

IMAP account, news server, POP account

Remarks

These headers usually take the form of "X headers," an Internet convention that allows the user to add any number of arbitrary headers to an e-mail or news message as long as they begin with "X-".

Example

set the additional headers of POP account �
    "My POP Account" to �
    "X-Birthday-Of-Sender: 1 Apr 1965" & return & �
    "X-Birthday-Of-Spouse: 31 Oct 1964"

address

An e-mail address. Class.

Plural form

addresses

Properties

address, display name

address

The text of the e-mail address associated with an object of the address class. String.

Property of

address

Example

set CurAddr to the address of (address of CurSender)

address

The e-mail address of the recipient. Address.

Property of

recipient

Example

set CurAddr to the address of CurSender

address book

An address book. Class.

Plural form

address books

Remarks

This class is only used by the displayed feature property of the window class.

administrative address

The address of the mailing list's administrator. String.

Property of

mailing list

allow online access

Specifies whether to allow online access to the account and whether to show the account in the folder list. Boolean.

Property of

POP account

Remarks

A value of true indicates that online access is allowed.

Example

set the allow online access of MyAccount to true

alternate address

The alternate address of the mailing list. String.

Property of

mailing list

always send to list address

Whether to send replies to messages from this list to the list itself or to the sender of the original message. Boolean.

Property of

mailing list

Remarks

A value of true (the default) for this property specifies that replies to messages from this list should be sent to the list itself. A value of false specifies that replies should be sent to the sender of the original message.

This property has an effect only if the override property of the list is true.

application

The Outlook Express application. Class.

Plural form

applications

Elements

address by numeric index, by name, by condition

address book by numeric index, by condition

contact by numeric index, by name, by relative position, by condition

folder by numeric index, by condition

group by numeric index, by name, by relative position, by condition

IMAP account by numeric index, by condition

LDAP server by numeric index, by name, by relative position, by condition

mailing list by numeric index, by name, by relative position, by condition

news group by numeric index, by name, by relative position, by condition

news server by numeric index, by name, by relative position, by condition

POP account by numeric index, by condition

schedule by numeric index, by name, by relative position, by condition

signature by numeric index, by name, by relative position, by condition

window by numeric index, by name, by relative position, by condition

Properties

connection in progress, current identity, current messages, default LDAP server, default mail account, default news server, default signature choice, default signature type, deleted mail folder, drafts folder, frontmost, in box folder, name, out box folder, selection, sent mail folder, version

Remarks

Setting the selection is only supported for editable text, but getting the selection works for text, messages in the message list, contacts in the contact list, features in the feature table, and newsgroups in the newsgroup list for a news server.

The address book class is only used with the displayed feature property of the window class, which returns address book 1 if you are viewing the contacts.

You can get properties of the application directly by omitting the text "of application". (See the second example below.)

Examples

set CurConnection to connection in progress of application

set CurConnection to connection in progress

assistant phone number

The phone number of the assistant to the contact person. Unicode Text.

Property of

contact

Example

set the assistant phone number of NewContact to "(425) 882-8080"

assistant phone number extension

The extension of the assistant to the person listed in the contact. Unicode Text.

Property of

contact

Example

set the assistant phone number extension of NewContact to "22"

attachment

An attachment to a message. Class.

Plural form

attachments

Properties

content, encoding, file, file creator, file type, name, properties

Remarks

Since attachments are encoded within the message, they sometimes don�t have a file associated with them, only a name.

You can save attachments with the save command. If you do not provide the destination with the in parameter, a standard file dialog box appears to ask for the destination. Attachments also support the open and delete commands.

Adding attachments in Outlook Express 5.0 is extremely flexible; there's more than one way to do it. You can add attachments to both incoming and outgoing messages, and create the attachment with a file or encoded data (encoded data needs to be a full MIME part, including headers). You can use the word file instead of attachment, and you can say with properties and with data interchangeably. You can specify the location of the file to be attached with the name property of attachment, or you can use a file alias instead. There are too many possibilities to enumerate here; if you have a specific syntactic need, try it and see. The Examples section below illustrates two possibilities.

If you add a file reference to a received message without adding the encoded data, Outlook Express will encode the attachment if you redirect the message or view its source.

Examples

set EncodedAttachment to "Content-type: text/plain" & return & return & "Hello world!" & return
    make new incoming message at folder id 10 with properties {subject: "Hello", content: "Here's some text.", �
        attachment:"Macintosh HD:picture1.jpg"}

set MyMsg to make new draft window
    make new attachment at y with properties {file:"Macintosh HD:picture2.jpg"}

B

BCC recipients

E-mail addresses that will receive copies of the message. Unicode Text.

Property of

draft window

Remarks

Short for "blind CC" or "blind carbon copy." Unlike the e-mail addresses contained by the CC recipients property, the e-mail addresses contained by the BCC recipients property will not appear in the headers of outgoing mail.

bounds

The boundary rectangle for the window. Bounding Rectangle.

Property of

window

Remarks

A bounding rectangle is an AppleScript list of four integers. The first two integers specify the coordinates of the window's upper left corner, and the last two integers specify the coordinates of the window's lower right corner. For example, on a 640 x 480 pixel screen, coordinates range from (0,0) at the screen's upper left corner to (640,480) at the screen's lower right corner. Thus, a bounds property value of {0,0,640,480} would indicate that the window filled the screen.

burst

Burst a digest message into constituent messages. Command.

Syntax

burst List of Messages [to Location Reference]

Result

A reference to the burst messages.

Remarks

Some Internet mailing lists have a "digest" option, with which subscribers can receive all messages posted to the list for a specified period of time (usually a day or week) as a single e-mail message. With this command, users of Outlook Express can break apart an e-mail digest into the individual digests that compose it.

The to parameter is by default the same folder that the message is in.

Example

burst CurrentMessage to folder "Burst Digests" of the in box folder

burst message

Whether to burst digest messages from this list into constituent messages. Boolean.

Property of

mailing list

Remarks

A value of true for this property specifies that digest messages from the list should be burst into constituent messages. (For more information about digest bursting, see the entry for the burst command.)

business address

The work address of the contact. Postal Address.

Property of

contact

Example

set the street address of the business address of NewContact to "One Microsoft Way"

business fax phone number

The fax phone number of the contact's place of employment. Unicode Text.

Property of

contact

Example

set the business fax phone number of NewContact to "(555) 555-5555"

business fax phone number extension

The business fax phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the business fax phone number extension of NewContact to "22"

business phone number

The work phone number of the contact. Unicode Text.

Property of

contact

Example

set the business phone number of NewContact to "(425) 882-8080"

business phone number extension

The business phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the business phone number extension of NewContact to "22"

business web page

The home page for the contact's work or business. Unicode Text.

Property of

contact

Example

set the business web page of NewContact to "http://www.microsoft.com/"

C

CC recipients

E-mail addresses that will receive copies of the message. Unicode Text.

Property of

draft news window, draft window

Remarks

Short for "carbon copy." Unlike the e-mail addresses contained by the BCC recipients property, the e-mail addresses contained by the CC recipients property will appear in the headers of outgoing mail.

cell phone number

A cell phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the cell phone number of NewContact to "(555) 555-5555"

cell phone number extension

The cell phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the cell phone number extension of NewContact to "22"

change color

Whether to change the color of messages from this list. Boolean.

Property of

mailing list

Remarks

A value of true for this property specifies that messages from this list should be changed to the color specified by the color property of this mailing list.

character set

The default character set used by the message, message part, or server. String.

Property of

message, part

Remarks

This property is read-only on the classes news group, news server, and part.

city

The city part of the address. Unicode Text.

Property of

postal address

Example

set the city of the business address of NewContact to "Redmond"

class

The type of window. Type Class.

Property of

window

Possible values

draft news window, draft window, message window, window

Remarks

Every object class actually has a class property, even though it is only listed for the window class.

Example

if the class of the front window is message window then
    set TheMessage to get the displayed message of the front window
end if

close

Close an object.

Syntax

close Reference [saving yes|no|ask] [saving in Alias]

Remarks

The saving parameter specifies whether changes should be saved before closing the object, and setting it to ask displays a dialog box that lets the user decide whether the file should be saved.

The saving in parameter specifies the file to which to save the object. It requires an alias, not an ordinary reference to a file.

Example

close the frontmost window saving yes saving in alias "Macintosh HD:My Files:SaveFile"

closeable

Whether the window has a close box. Boolean.

Property of

window

color

The color to which to change messages from this list. RGB Color.

Property of

mailing list

Remarks

A value of true for the change color property of the mailing list specifies that messages from the list should be changed to this color. (For more information about RGB Color data types, see the entry for the color property of the message class.)

color

The color of the message when displayed in lists of messages. RGB Color.

Property of

message

Remarks

An RGB color is an AppleScript list of three integers whose values are in the range 0 to 65535. The first of these integers specifies the amount of red in the color, the second the amount of green, and the third the amount of blue. The following example sets the selected message's color to red.

Example

set color of CurrentMessage to {65535, 0, 0}

company

The contact's company, corporation, or other place of work. Unicode Text.

Property of

contact

Example

set the company of NewContact to "Microsoft"

compression type

The compression format used to compress attachments.

Property of

outgoing message

Possible values

no compression, stuffit compression

connect to

Connect to a POP, IMAP, or news server. Command.

Syntax

connect to List of Reference

Remarks

This command has the same effect as clicking Send & Receive on the Outlook Express toolbar. If used with an IMAP account, it updates the list of messages in the Inbox. If used with a news server, it updates the unread count for subscribed newsgroups.

Examples

connect to POP account "Someone's e-mail"

```
connect to every POP account
```
```
connect to pop accounts
```

connection action

What will be done with the message at the next connection.

Property of

message

Possible values

download at next connection, leave on server, remove at next connection

connection in progress

Whether any network connections are open. Read-only Boolean.

Property of

application

Remarks

Returns true if there are any connections in progress. This is useful for scripts disconnecting idle PPP connections.

contact

A contact in the address book. Class.

Plural form

contacts

Elements

email address by numeric index, by condition

Properties

assistant phone number, assistant phone number extension, business address, business fax phone number, business fax phone number extension, business phone number, business phone number extension, business web page, cell phone number, cell phone number extension, company, custom date field one, custom date field two, custom date field three, custom date field four, custom field one, custom field two, custom field three, custom field four, custom field five, custom field six, custom field seven, custom field eight, custom phone number one, custom phone number one extension, custom phone number two, custom phone number two extension, custom phone number three, custom phone number three extension, custom phone number four, custom phone number four extension, default email address, department, description, first name, home address, home fax phone number, home fax phone number extension, home phone number, home phone number extension, home web page, ID, job title, last name, main phone number, main phone number extension, nickname, other address, other business phone number, other business phone number extension, other fax phone number, other fax phone number extension, other home phone number, other home phone number extension, other phone number, other phone number extension, other web page, pager phone number, pager phone number extension, suffix, title

Remarks

The contact class inherits from the address class but adds a number of fields. It can contain a number of email address elements, each of which has a contents property that is a string. The default email address property is a reference to one of these e-mail addresses.

The business address, home address, and other address fields use a postal address record structure.

You can create a contact with the make command specifying initial properties. The open and close commands will open and close a contact window. Contacts can also be deleted or duplicated.

Contacts are elements of the application class, not the address book class.

content

The encoded content of the attachment, if it has been encoded, or the text of the part. String.

Property of

attachment, part

content

The text of the message displayed by the window, if the window is displaying a message. Unicode Text.

Property of

draft news window, draft window, message, window

Remarks

Returns the content of the message being displayed, or an error if a message is not being displayed.

Examples

set CurContent to the content of CurMessage

set the content of myWindow to "I got your message. Thanks!"

content

The text of the group entry. Read-only Address.

Property of

group entry

content

The text of the signature. Unicode Text.

Property of

signature

The text of the address. String.

Property of

email address

Example

set WorkEmail to make email address at NewContact
set the contents of WorkEmail to "someone@microsoft.com"

convert

Convert text among character sets.

Syntax

convert Anything [from String] [to String]

Result

Anything

Remarks

The first parameter (designated Anything) is a string or piece of Unicode text to convert to another format. The from parameter specifies the character set of the data passed as the first parameter; the default is Unicode Text. The to parameter specifies the character set to which to convert the data passed; the default here is also Unicode Text.

The from and to parameters can contain the names of any character set that the Apple Text Encoding Converter recognizes. See Apple documentation for more information on the Text Encoding Converter.

Example

convert MyUnicodeString to "x-mac-japanese"

convert BulletChar from "x-mac-roman" to "x-mac-japanese"

set MyUnicodeString to convert ascii character 128 from "iso-8859-1"

count

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

Syntax

count Reference each Type Class

Result

Integer

Remarks

The Reference parameter represents the object whose elements are to be counted, and the each parameter represents the class of the elements to be counted. The result is an integer specifying the number of elements.

Example

count every message of the in box folder

country

The contact's country, nation, or region. Unicode Text.

Property of

postal address

Example

set the country of the business address of NewContact to "USA"

current identity

The identity currently being used for email. Reference.

Property of

application

Example

set the current identity to GeorgeWorkIdentity

current messages

The current messages (depending on context), including messages currently being filtered. Read-only List of Reference.

Property of

application

Remarks

This is a context-sensitive list of the current messages, which is meant to simplify writing scripts. It is also the only way to refer to the message currently being filtered.

If there is a message window open, this property refers to the message being read. If there is a list of messages frontmost, this property refers to the messages selected in the list. If a message is being filtered, this property refers to the message being filtered. If none of these cases is true, the property returns an empty list.

custom date field one

The first custom date field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom date field one of NewContact to "7/8/1999"

custom date field two

The second custom date field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom date field two of NewContact to "7/8/1999"

custom date field three

The third custom date field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom date field three of NewContact to "7/8/1999"

custom date field four

The fourth custom date field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom date field four of NewContact to "7/8/1999"

custom field one

The first custom field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom field one of NewContact to "aaa"

custom field two

The second custom field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom field two of NewContact to "bbb"

custom field three

The third custom field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom field three of NewContact to "ccc"

custom field four

The fourth custom field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom field four of NewContact to "ddd"

custom field five

The fifth custom field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom field five of NewContact to "eee"

custom field six

The sixth custom field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom field six of NewContact to "fff"

custom field seven

The seventh custom field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom field seven of NewContact to "ggg"

custom field eight

The eighth custom field for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom field eight of NewContact to "hhh"

custom phone number one

The first custom phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom phone number one of NewContact to "(555) 555-5555"

custom phone number one extension

The extension of the first custom phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the custom phone number one extension of NewContact to "22"

custom phone number two

The second custom phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom phone number two of NewContact to "(555) 555-5555"

custom phone number two extension

The extension of the second custom phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the custom phone number two extension of NewContact to "22"

custom phone number three

The third custom phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom phone number three of NewContact to "(555) 555-5555"

custom phone number three extension

The extension of the third custom phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the custom phone number three extension of NewContact to "22"

custom phone number four

The fourth custom phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set custom phone number four of NewContact to "(555) 555-5555"

custom phone number four extension

The extension of the fourth custom phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the custom phone number four extension of NewContact to "22"

D

data size

Return the size of an object. Command.

Syntax

data size Reference [as Type Class]

Result

Integer

Remarks

The Reference parameter represents the object whose data size is to be returned, and the optional as parameter represents the data type for which the size is calculated. The result is an integer specifying the size in bytes.

default email address

Specifies the e-mail address of the contact that should be used in most circumstances. Reference.

Property of

contact

Example

set WorkEmail to make email address at NewContact
set the contents of WorkEmail to "someone@microsoft.com"
set the default email address of NewContact to WorkEmail

default LDAP server

Specifies which LDAP server the user prefers to obtain e-mail addresses from most of the time. Reference.

Property of

application

default mail account

Specifies which e-mail account the user prefers to send mail from most of the time. Reference.

Property of

application

Property of

set default mail account to POP account 1

set default mail account to IMAP account "Someone"

default news server

Specifies which news server the user prefers to read news from most of the time. Reference.

Property of

application

default signature choice

Indicates the user's signature if the default signature type property has been set to other. Reference.

Property of

application, IMAP account, news server, POP account

Remarks

This property is read-only on the application class, where it returns the value of the default signature choice property of the default mail account.

default signature type

The default type of signature to be used for new messages.

Property of

application, IMAP account, news server, POP account

Possible values

none (no signature), random (choose a random signature from the signatures available), other (use the signature referred to by the property default signature choice)

delete

Delete an element from an object.

Syntax

delete Reference

delete duplicate

Whether to delete duplicates of messages that were sent to both the user and the list. Boolean.

Property of

mailing list

Remarks

A value of true for this property specifies that duplicates of messages that were sent to both the user and the list should be deleted.

delete messages from server after

How many days Outlook Express should wait before deleting messages from the e-mail server. Integer.

Property of

POP account

delete messages from server when deleted from computer

Whether to delete e-mail from the e-mail server when it has been deleted from the folders in Outlook Express. Boolean.

Property of

POP account

Remarks

A value of true for this property indicates that e-mail should be deleted from the server when it is deleted from Outlook Express.

deleted mail folder

The folder where messages are stored after they have been deleted. Reference.

Property of

application

delete my mail

Whether to delete copies of incoming messages that the user sent to the list. Boolean.

Property of

mailing list

Remarks

A value of true for this property specifies that copies of incoming messages that the user sent to the list should be deleted.

delete original

Whether to delete the original digest messages from this list after bursting them into constituent messages. Boolean.

Property of

mailing list

Remarks

A value of true for this property specifies that digest messages from the list should be deleted after being burst into constituent messages. (For more information about digest bursting, see the entry for the burst command.)

delivery status

Whether the message has been sent or not.

Property of

outgoing message

Possible values

sent, unsent

department

The workplace department of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the department of NewContact to "Human Resources"

description

A written description of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the description of NewContact to "Interesting person. Potential business partner?"

display name

The name used to display the e-mail address. Unicode Text.

Property of

address

Example

set CurFirstName to the first word of �
    the display name of CurSender

displayed feature

The feature (folder, server, and so forth) being displayed, if there is one. Read-only Reference.

Property of

window

Remarks

If the window is not displaying a feature, an error is returned, so use this property within a try block.

displayed message

The message being displayed, if there is one. Read-only Reference.

Property of

window

Remarks

Returns a reference to the message. If the window is not displaying a message, an error is returned, so use this property within a try block. (See the current messages property for an alternative to this property.)

Example

if the class of the front window is message window then
     set TheMessage to get the displayed message of the front window
end if

download

Download IMAP messages or news articles from the server. Command.

Syntax

download List of Message

draft news window

A window with an unsent message. Class.

Plural form

draft news windows

Elements

attachment by numeric index, by condition

Properties

account, CC recipients, compression type, content, encoding, news group recipients, other signature choice, priority, send attachments to cc recipients, signature type, subject, use DOS file names

Remarks

This class only supports news messages, not mail messages. It represents a window used to edit a news message before you send it.

draft window

A window with an unsent message. Class.

Plural form

draft windows

Elements

attachment by numeric index, by condition

recipient by numeric index, by condition

Properties

account, BCC recipients, CC recipients, content, other signature choice, priority, signature type, subject, to recipients

Remarks

This class only supports mail messages, not news messages. It represents a window used to edit an e-mail message before you send it.

The following example shows how to add files to the draft window. (Note that you cannot say �make new file� because of a conflict with the Apple file scripting addition.)

Example

make file at the front window with data file "Macintosh HD:My File"

drafts folder

The folder where unsent, unfinished messages are stored. Reference.

Property of

application

duplicate

Duplicate object or objects. Command.

Syntax

duplicate Reference [to Location Reference]

Result

Reference

Remarks

The Reference parameter specifies the object or objects to duplicate, and the to parameter specifies the new location for the duplicated objects. The result is a reference to the duplicated objects.

E

edited

Whether the message has been edited. Boolean.

Property of

message

Remarks

A value of true for this property indicates that the message has been edited.

email address

The e-mail address of the account. String.

Property of

IMAP account, POP account

Example

set the email address of MyAccount to "someone@microsoft.com"

email address

An e-mail address. Class.

Plural form

email addresses

Properties

contents

Remarks

The contact class contains a number of email address elements, each of which has a contents property that is a string.

Example

set WorkEmail to make email address at NewContact
set the contents of WorkEmail to "someone@microsoft.com"

enabled

Whether the mailing list setting for this mailing list is enabled. Boolean.

Property of

mailing list

Remarks

A value of true for this property specifies that the setting for this list in Outlook Express should filter the mail into a folder or perform other actions on mail from the list.

enabled

Whether the schedule is enabled. Boolean.

Property of

schedule

encoding

The MIME encoding of the data in the part or attachment. Read-only.

Property of

attachment, outgoing message, part

Possible values

7bit encoding, 8bit encoding, AppleDouble, AppleSingle, base64, binhex, no encoding, quoted printable, unknown encoding, uuencode

exists

Verify whether an object exists. Command.

Syntax

exists Reference

Result

Boolean

Remarks

The Reference parameter specifies the object whose existence is being checked. This command returns true if the object exists.

F

file

An alias to the file associated with the attachment. Read-only Alias.

Property of

attachment

file creator

The file creator of the attachment. Type Class.

Property of

attachment

Remarks

Even though the file creator property is of the type Type Class, you can treat it as a four-character String. For example, a text file attachment created by Microsoft Word would have a file type property of "TEXT" and a file creator property of "MSWD".

Example

if the file creator of attachment 1 of message 1 of folder 1 is "MSWD" then
    display dialog "It's a Word file!"
end if

file outgoing

Whether to file outgoing messages to the list in the specified folder.

Property of

mailing list

Remarks

If the value of this property is true, outgoing messages sent to the mailing list will be filed in the folder specified by the storage property of the mailing list object.

file type

The file type of the attachment. Type Class.

Property of

attachment

Remarks

Even though the file type property is of the type Type Class, you can treat it as a String. For example, a text file attachment created by Microsoft Word would have a file type property of "TEXT" and a file creator property of "MSWD".

Example

if the file type of attachment 1 of message 1 of folder 1 is "PICT" then
    display dialog "A picture!"
end if

find

Find contacts containing an e-mail address. Command.

Syntax

find String

Result

Reference

Remarks

The String parameter specifies the e-mail address to find in the address book, and the result is a list of contacts that contain the e-mail address.

The find command provides a quick way to map an e-mail address to any contacts that contain it.

Example

find "someone@microsoft.com"

Example result

{contact id 398}

first name

The first name or given name of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the first name of NewContact to "Someone"

flagged

Whether the message has been flagged for follow-up. Boolean.

Property of

message

Remarks

Setting this property to true on a message object will add a small red flag to the left of the message's Subject line in a window that lists the message. Setting this property to false will remove any flag image already there.

floating

Specifies whether the window floats. Read-only Boolean.

Property of

window

folder

A folder for storing e-mail. Class.

Plural form

folders

Elements

folder by numeric index, by condition

incoming message by numeric index, by ID, by condition

message by numeric index, by ID, by condition

outgoing message by numeric index, by ID, by condition

Properties

ID, name, parent, unread message count

Remarks

The folder class represents the message folders in Outlook Express 5.0. Folders can have other folders (called subfolders) as elements, so a subfolder can be referred to thus: folder "My Subfolder" of folder "Parent Folder".

When Outlook Express 5.0 returns a reference to a folder, it always does so by ID. Every folder has a unique ID, so you can refer to a folder as folder id 23 regardless of whether it�s a top-level folder or a subfolder. This way, the folder reference is valid even after a folder moves.

The name of the folder is a read/write property.

You can move folders with the move command. To move a folder to the top level, either specify the application as the destination, or leave it out by not specifying a to parameter.

You can make, delete, and open folders, but you cannot duplicate them.

When you create a folder with the make command, the folder will be created inside another folder if one is specified with the at parameter. If the name is not specified with the with properties parameter, the new folder will be given the default name.

Examples

```
make new folder
```
```
make new folder at folder "Parent"
```

make new folder with properties {name:"New"}

forwarded

Whether the message has been forwarded. Boolean.

Property of

message

Example

set the forwarded of CurMessage to false

frontmost

Whether Outlook Express is the currently active application. Boolean.

Property of

application

full name

The full name of the user who owns the e-mail account. Unicode Text.

Property of

IMAP account, POP account

Example

set the full name of MyAccount to "Someone S. Someone"

G

get

Get the data for an object. Command.

Syntax

get Reference [as List of Type Class]

Result

Anything

Remarks

The Reference parameter specifies the object whose data is to be returned, and the optional as parameter specifies the desired types for the data in order of preference. This command can return any type of data in AppleScript.

group

A list of contacts to send e-mail to. Class.

Plural form

groups

Elements

group entry by numeric index, by ID, by condition

Properties

name, show only name in messages

Remarks

A group is a mailing list, not in the sense of an Internet mailing list (see the entry for the mailing list class), but rather a personal distribution list containing a list of e-mail addresses to which you can send e-mail collectively.

If you add a contact to a group through the regular Outlook Express user interface, then the contact will be linked to the group; you will see a contact icon next to the contact's name, and if the contact's email address changes, then the address listed in the group will change as well. However, you can only get the address for an entry in the group, not a reference to the contact to which it is linked.

When creating groups, you can create them as links.

Remarks

make new group with properties {name: "My Group", �
    group entries: {contact 1, group 7, "Someone S. Someone <someone@microsoft.com>", �
    {display name: "Someone S. Someone", address: "someone@microsoft.com"}}}

group entry

An entry in a group. Class.

Plural form

group entries

Properties

content

Remarks

A group entry is an element of a group representing a person who is a member of the e-mail distribution list A group entry can be a raw e-mail address, a link to one of the email addresses of a contact, or a link to a group. (See the passage on group for more information about links.)

H

handle URL

Handle a URL and display it in a window.

Syntax

handle URL String [attaching List of File Specification]

Remarks

The String parameter can be a news:, nntp:, or mailto: URL, and the optional File Specification parameter contains a list of files to attach.

This command is the AppleScript interface to the URL handler of Outlook Express 5.0, which Internet Config uses to pass URLs of the above types to Outlook Express.

Example

tell application "Outlook Express"
    handle URL "mailto:someone@microsoft.com?subject=Something"
end tell

has html

Whether the message contains HTML text. Read-only Boolean.

Property of

message

Remarks

Setting the value of this property to true on a message will cause Outlook Express to treat the content of the message as HTML text.

Example

make new outgoing message with properties {has html: true, content: "<html><b>Hello!</b></html>"}

headers

The Internet message headers of the message or part. Read-only String.

Property of

message, part

Example

set TheHeaders to the headers of Message1

home address

The home postal address of the person listed in the contact. Postal Address.

Property of

contact

Remarks

This is not an e-mail address, but rather the physical location where the person lives.

Example

set the street address of the home address of NewContact to "888 999th Avenue #100A"

home fax phone number

The home fax phone number of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the home fax phone number of NewContact to "(555) 555-1111"

home fax phone number extension

The home fax phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the home fax phone number extension of NewContact to "22"

home phone number

The home phone number of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the home phone number of NewContact to "(555) 555-1111"

home phone number extension

The home phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the home phone number extension of NewContact to "22"

home web page

The URL for the personal Web page of the person listed in the contact, if available. Unicode Text.

Property of

contact

Remarks

You should use the property business web page if you want to specify the Web page for the person's place of business.

Example

set the home web page of NewContact to "http://www.microsoft.com/~someone/"

I

ID

Unique internal identification number in Outlook Express 5.0 for the contact, folder, e-mail account, etc. Read-only Integer.

Property of

contact, folder, IMAP account, LDAP server, mailing list, message, news group, news server, POP account, schedule, signature

Example

set id1 to the ID of message i of MyFolder

identity

A collection of accounts and other preferences. Class.

Properties

name

Remarks

Every user of an Outlook Express installation should create his or her own identity.

IMAP account

An account for accessing mail from an IMAP server. Class.

Plural form

IMAP accounts

Elements

folder by numeric index, by condition

Properties

additional headers, default signature choice, default signature type, email address, full name, ID, IMAP ID, IMAP port, IMAP requires SSL, IMAP server, include in send and receive all, name, password, root folder path, send secure password, SMTP port, SMTP requires SSL, SMTP server

Remarks

The properties of the IMAP account mirror the fields in Preferences. The only notable exception is the password field, which is write-only. This status can�t be expressed in the dictionary, which lists the property as read/write even though, for obvious security reasons, you will get an error if you try to get the password of an account.

IMAP accounts support the connect to, make, and delete commands.

Example

set MyAccount to IMAP account "temp"
set the name of MyAccount to "Someone's IMAP account"

IMAP ID

The account ID on the account's IMAP server. String.

Property of

IMAP account

Example

set the IMAP ID of MyAccount to "someone"

IMAP port

The port to use when connecting to the account's IMAP server. Integer.

Property of

IMAP account

Example

set the IMAP port of MyAccount to 143

IMAP requires SSL

Whether the account's IMAP server requires that SSL be used when connecting to it. Boolean.

Property of

IMAP account

Remarks

The value of this property is true if the IMAP server requires SSL.

Example

set the IMAP requires SSL of MyAccount to false

IMAP server

The IMAP server used to retrieve mail for the account. String.

Property of

IMAP account

Example

set the IMAP server of MyAccount to "violet-msg-13"

in box folder

The folder where new messages are filed. Reference.

Property of

application

Remarks

If you have a POP server account, your mail is automatically received in the Inbox created by Outlook Express. This folder is read-only, just like the deleted mail folder.

Example

set MyFolder to the folder "Old Messages" of the in box folder

include in random

Whether the signature is included in the random list. Boolean.

Property of

signature

Remarks

If the signature is included in the random list, the value for this property is true.

include in send and receive all

Whether the account's e-mail should be sent and received when Send & Receive All is clicked. Boolean.

Property of

IMAP account, POP account

Remarks

If the account is included, the value for this property is true.

Example

set the include in send and receive all of MyAccount to true

incoming message

An incoming e-mail message. Class.

Plural form

incoming messages

Elements

attachment by numeric index, by condition

recipient by numeric index, by condition

Remarks

The incoming message class inherits all the properties and elements from the regular message class.

Example

if the class of theSelection = folder then �
    set MessagesToProcess to get �
         (every incoming message of theSelection)

index

The index of the Outlook Express window on the screen. Integer.

Property of

window

Remarks

The frontmost Outlook Express window on the screen has an index value of 1; the one immediately behind it has an index value of 2, and so forth.

J

job title

The contact's job title. Unicode Text.

Property of

contact

L

last name

The last name, or surname, of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the last name of NewContact to "Someone"

LDAP port

The port to use when connecting to the LDAP server. Integer.

Property of

LDAP server

LDAP requires SSL

Whether the LDAP server requires that SSL be used when connecting to it. Boolean.

Property of

LDAP server

Remarks

The value of this property is true if the LDAP server requires SSL.

LDAP server

A server using Lightweight Directory Access Protocol (LDAP). Class.

Plural form

LDAP servers

Properties

ID, LDAP port, LDAP requires SSL, LDAP server, name, password, requires authentication, user name

Remarks

LDAP is a protocol for accessing online directory services. These directory services let you search their databases to find the names and e-mail addresses of people or businesses.

LDAP server

The address of the LDAP server. String.

Property of

LDAP server

Remarks

This property of the LDAP server class should not be confused with the class itself.

leave on server

Whether to leave e-mail that has been read on the POP server. Boolean.

Property of

POP account

Remarks

If the value of this property is true, read e-mail will be left on the POP server.

Example

set the leave on server of MyAccount to true

list address

The e-mail address to which the user should send mail intended for the whole mailing list. String.

Property of

mailing list

M

mailing list

An Internet e-mail list. Class.

Plural form

mailing lists

Properties

add prefix, administrative address, alternate address, always send to list address, burst message, change color, color, delete duplicate, delete my mail, delete original, enabled, file outgoing, ID, list address, mark as read, name, notes, override, prefix, server address, storage

main phone number

The main phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the main phone number of NewContact to "(555) 555-5555"

main phone number extension

The main phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the main phone number extension of NewContact to "22"

make

Make a new element.

Syntax

make new Type Class at Anything [with data Anything] [with properties Record]

Result

Reference

Remarks

The first parameter (Type Class) specifies the class of the element being created; the at parameter specifies the location at which to insert the element; the with data parameter specifies the initial data for the element; and the with properties parameter specifies the initial values for the properties of the element. The result is a reference to the new element.

Example

set MyContact to make new contact �
     with properties {first name:"Someone", last name:"Someone"}

mark as read

Whether to mark messages from this list as read. Boolean.

Property of

mailing list

maximum message size

The maximum size in kilobytes of messages that Outlook Express should download from the e-mail server. Integer.

Property of

POP account

message

A message in e-mail or news. Class.

Plural form

messages

Elements

attachment by numeric index, by condition

part by numeric index, by condition

recipient by numeric index, by condition

Properties

account, Boolean, character set, color, connection action, content, edited, flagged, forwarded, has html, headers, ID, online status, priority, properties, read status, redirected, replied to, sender, source, storage, subject, time received, time sent

Remarks

The message class is derived from the Apple Mail Suite. In the language of object-oriented programming, message is an abstract base class. That is, there are no objects of class message, but only objects that belong to its subclasses (incoming message and outgoing message).

The following table specifies commands that can be used on the message class.

Command	Description
data size	Returns the size of a message.
delete	Deletes a message.
duplicate	Duplicates a message. The to parameter controls the destination (the message is duplicated in the same folder if to is omitted).
make	Can be used to create incoming and outgoing messages.
move	Moves a message to another folder.
open	Opens a message into a message window.
print	Prints a message.
save	Saves a message.
send	Sends all unsent outgoing messages.

If a destination folder is not specified, a message is put in the folder that makes the most sense (in box folder for incoming messages, out box folder or drafts folder for outgoing messages).

The initial properties of the message must be specified. They can either be specified with the source property, which is the complete RFC-822 message, or individually. When specified individually, enclosures can be added by including a list of files with the attachment label (which will use the default encoding method). The recipients can be specified with the recipient label of the with properties record. Since the recipient contains an address record within it, record nesting can be complex.

Example

make new message at the in box folder with properties �
     {subject:"subject", time sent:current date, content:"body", �
     attachment:{alias "Macintosh HD:file 1", alias "Macintosh HD:file 2"}, �
     recipient:{{recipient type:to recipient, address:{display name: �
     "Someone S. Someone", address:"someone@microsoft.com"}}, {recipient type:cc recipient, �
     address:{display name:"Someone S. Someone 2", address:"someone2@microsoft.com"}}}, �
     account:POP account 1}

message window

A window displaying a message that has been sent or received. Class.

modal

Whether the window is modal. Read-only Boolean.

Property of

window

Remarks

A modal window is one that must be responded to before any other activity can take place on the screen (for example, a dialog box displaying a serious error).

move

Move object(s) to a new location. Command.

Syntax

move Reference to Location Reference

Remarks

The first parameter (Reference) specifies the objects to move, and the second parameter (Location Reference) specifies the new location for the objects. The result is a reference to the objects after they have been moved.

N

name

The visible title of the application (Outlook Express), identity, or window. String.

Property of

application, identity, window

Remarks

This property is read-only on the application class.

name

The name of the object in question as seen by AppleScript. Unicode Text.

Property of

attachment, folder, group, IMAP account, LDAP server, mailing list, news group, news server, POP account, schedule, signature

Example

set the name of MyAccount to "Someone's work e-mail"

name

What sort of address the postal address is. String.

Property of

Postal Address

Possible values

"business", "home", "other"

news group

A newsgroup. Class.

Plural form

news groups

Elements

incoming message by numeric index, by ID

message by numeric index, by ID

Properties

ID, name, news server, unread message count

Remarks

The news group class represents Usenet newsgroups. It has messages as elements, similar to the way folders have messages as elements.

News groups are elements of the application class and also the news server class. The news group elements of the application refer to the newsgroups of the default news server, since most users have only one news server.

The news group class supports the open and refresh commands.

Example

if the class of theSelection = news group then
    set MessagesToProcess to get �
        (every incoming message of theSelection)

news group recipients

The newsgroups to which the message will be posted when complete. Unicode Text.

Property of

draft news window

news server

A news server. Class.

Plural form

news servers

Elements

news group by numeric index, by name, by condition

Properties

additional headers, default signature choice, default signature type, ID, name, NNTP port, NNTP requires SSL, NNTP server, number headers to get, organization, password, requires authentication, sending account, user name

Remarks

Like the POP account and IMAP account classes, the news server class mirrors the preferences. However, the news server properties are all read-only.

Only subscribed newsgroups are listed as elements of a news server.

news server

The server to which the newsgroup belongs. Reference.

Property of

news group

nickname

The nickname of the person listed in the contact. Unicode Text.

Property of

contact

NNTP port

The port to use when connecting to the NNTP server. Integer.

Property of

news server

NNTP requires SSL

Whether the NNTP server requires that SSL be used when connecting to it. Boolean.

Property of

news server

Remarks

The value of this property is true if the NNTP server requires SSL.

NNTP server

The address of the NNTP server. String.

Property of

news server

notes

Human-readable notes about the mailing list. Unicode Text.

Property of

mailing list

number headers to get

The number of headers to download at a time. Integer.

Property of

news server

O

online status

Whether the message is still on the server, fully downloaded, or in some state in between.

Property of

message

Possible values

fully downloaded, headers only, not on server, partially downloaded

open

Open the specified objects. Command.

Syntax

open Reference

Remarks

The parameter of this command specifies the object or objects to open.

organization

The organization of the user. Unicode Text.

Property of

news server

Remarks

A user's organization can be a corporation, a club, a governmental department, or any other organization that is appropriate.

Example

set the organization of MyAccount to "Microsoft"

other address

A tertiary postal address (not an e-mail address) for the person listed in the contact. Postal Address.

Property of

contact

Example

set the street address of the other address of NewContact to �
       "12345 527th St."

other business phone number

A secondary business phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the other business phone number of NewContact to "(555) 555-3333"

other business phone number extension

The other business phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the other business phone number extension of NewContact to "22"

other fax phone number

A secondary fax phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the other fax phone number of NewContact to "(555) 555-2222"

other fax phone number extension

The other fax phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the other fax phone number extension of NewContact to "22"

other home phone number

A secondary home phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the other home phone number of NewContact to "(555) 555-2222"

other home phone number extension

The other home phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the other home phone number extension of NewContact to "22"

other phone number

A secondary phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the other phone number of NewContact to "(555) 555-2222"

other phone number extension

The other phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the other phone number extension of NewContact to "22"

other signature choice

The signature to be used if the signature type property for the window has a value of other. Reference.

Property of

draft news window, draft window

other web page

A tertiary Web page for the person listed in the contact. Unicode Text.

Property of

contact

Remarks

You might, for example, use this property for a hobbyist organization with which the person is affiliated. (You should use the business web page property for work URLs and home web page for personal URLs.)

Example

set the other web page of NewContact to "http://www.microsoft.com/"

out box folder

The folder where outgoing messages are stored until Outlook Express connects to the Internet. Read-only Reference.

Property of

application

outgoing message

An outgoing e-mail message. Class.

Plural form

outgoing messages

Elements

attachment by numeric index, by condition

recipient by numeric index, by condition

Properties

compression type, delivery status, encoding, resent, send attachments to cc recipients, use Windows file names

override

Whether to override the default behavior of Outlook Express when replying to messages from this list. Boolean.

Property of

mailing list

Remarks

A value of true for this property specifies that the default behavior of Outlook Express should be overridden when replying to messages from this list, and that the always send to list address property of the list should be used instead.

P

pager phone number

A pager phone number for the person listed in the contact. Unicode Text.

Property of

contact

Example

set the pager phone number of NewContact to "(555) 555-5555"

pager phone number extension

The pager phone number extension of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the pager phone number extension of NewContact to "22"

parent

The folder containing the folder in question, or the application itself if the folder in question is at the top level. Reference.

Property of

folder

Remarks

You can tell if a folder is a top-level folder by seeing if the class of the folder returned by this property is application.

part

A message part. Class.

Plural form

parts

Elements

part by numeric index, by condition

Properties

character set, content, encoding, headers, properties, subtype, type

password

The password used to access the account or server. String.

Property of

IMAP account, LDAP server, POP account, news server

Remarks

This property is write-only for security reasons. AppleScript dictionaries cannot display properties as write-only, so the Outlook Express dictionary lists the property as read/write, but you will receive an error if you try to get the password of an account.

For the sake of security, you may want to save any scripts that set this property as "run-only."

Example

set the password of MyAccount to "top_secret"

POP account

An account for accessing mail from a POP server. Class.

Plural form

POP accounts

Properties

additional headers, allow online access, default signature choice, default signature type, delete messages from server after, delete messages from server when deleted from computer, email address, full name, ID, include in send and receive all, leave on server, maximum message size, name, password, POP ID, POP port, POP requires SSL, POP server, send secure password, SMTP port, SMTP requires SSL, SMTP server

Example

set MyAccount to POP account "temp"
set the name of MyAccount to "Someone's POP account"

POP ID

The account ID on the POP server. String.

Property of

POP account

Example

set the POP ID of MyAccount to "someone"

POP port

The port to use when connecting to the POP server. Integer.

Property of

POP account

Example

set the POP port of MyAccount to 110

POP requires SSL

Whether the POP server requires that SSL be used when connecting to it. Boolean.

Property of

POP account

Remarks

The value of this property is true if the POP server requires SSL.

Example

set the POP requires SSL of MyAccount to false

POP server

The POP server used to retrieve mail for the account. String.

Property of

POP account

position

The coordinates of the window's upper left corner. Read-only Point.

Property of

window

Remarks

A point is an AppleScript List of two integers that specifies screen coordinates. For example, on a 640 x 480 pixel screen, coordinates range from (0,0) at the screen's upper left corner to (640,480) at the screen's lower right corner. Thus, a position property value of {0,0} would indicate that the window's upper left corner was at the screen's upper left corner.

postal address

A postal (street) address. Class.

Plural form

postal addresses

Properties

city, country, name, state, street address, street address 2, zip

prefix

Whether to add a prefix to messages from this mailing list. Boolean.

Property of

mailing list

Remarks

A value of true for the add prefix property of this mailing list specifies that the prefix should be added to messages from the list.

print

Print the specified objects. Command.

Syntax

print Reference

Remarks

The single parameter for this command specifies the object or objects to print.

priority

The importance of the message.

Property of

draft news window, draft window, message

Possible values

lowest, low, normal, high, highest

Example

set the priority of CurMessage to normal

properties

A property that allows setting or getting the properties of the object. Record.

Remarks

This property is implemented on virtually every class in Outlook Express that has properties.

You can both set and get properties with this property. The second example below returns an AppleScript record with all the properties of the message.

Example

set myWindow to make new draft window with properties �
           {subject:"Hey there...", content:"Long time no see!"}

```
get the properties of CurrentMessage
```

set the properties of CurrentMessage to {subject: "Hey there...", content: "Long time no see!"}

Q

quit

Quit Outlook Express. Command.

Syntax

quit [saving yes|no|ask]

Remarks

The saving parameter specifies whether or not to save currently open documents.

R

read status

Whether the message has been read.

Property of

message

Possible values

read, untouched

Example

set the read status of CurMessage to read

recipient

A message recipient. Class.

Plural form

recipients

Properties

address, recipient type

Remarks

The recipient class also comes from the Mail Suite. It has a type and an address record. This nested record makes it a bit complex, especially since the record is called address and there�s an address field within that address.

Recipients do not support any commands and are only returned from messages with read-only access.

The example results below correspond to the following examples.

Examples

get recipient type of recipient 1 of message 1 of folder 1

get address of recipient 1 of message 1 of folder 1

get address of address of recipient 1 of message 1 of folder 1

Example results

```
to recipient
```

{address:"someone@microsoft.com", display name:"Someone S. Someone"}

```
someone@microsoft.com
```

recipient type

The type of the recipient.

Property of

recipient

Possible values

bcc recipient, cc recipient, newsgroup recipient, to recipient

redirected

Whether the message has been redirected. Boolean.

Property of

message

Example

set the redirected of CurMessage to false

refresh

Refresh an object. Command.

Syntax

refresh Reference

Remarks

The refresh command can be used to refresh the message list for all newsgroups on a server (if the news server is the direct object) or for an individual newsgroup (if it is given as a direct object). It can also refresh the message list for all messages in a POP or IMAP account.

Examples

```
refresh news server "My server"
```

refresh news group "alt.whatever.random" of news server "news.microsoft.com"

replied to

Whether the message has been replied to. Boolean.

Property of

message

Example

set the replied to of CurMessage to false

requires authentication

Whether the server requires a user name and password. Boolean.

Property of

LDAP server, news server

resent

Whether the message has been resent. Boolean.

Property of

outgoing message

Remarks

A value of true for this property indicates that the message has been resent.

resizable

Whether the window can be resized. Read-only Boolean.

Property of

window

root folder path

The path to the IMAP root folder for the specified account. String.

Property of

IMAP account

S

save

Save an object. Command.

Syntax

save Reference [in Alias] [as Type Class]

Remarks

The first parameter is a reference to the object to save; the optional in parameter is an alias to the file in which to save the object; the optional as parameter is a reference to the file type of the document in which to save the data. If you use the in parameter, Outlook Express will save your file without displaying a dialog. If you use the as parameter by adding "as text" when you call this command, Outlook Express will save your file as styled text.

When your script runs this command, Outlook Express displays a standard file dialog box from which you can save your message as a message file. Message files are identical to the type of file created when you drag a message to the desktop. You can also drag message files back into Outlook Express or double-click them to open them within the application.

schedule

A schedule. Class.

Plural form

schedules

Properties

enabled, ID, name

Remarks

With a schedule, you can perform actions within Outlook Express on a regular basis, such as sending and receiving e-mail, emptying the Deleted Items folder, and running AppleScripts.

selection

The selection visible to the user. Anything.

Property of

application

Example

set theSelection to the selection

send

Send e-mail messages. Command.

Syntax

send [List of Messages] [sending later Boolean]

Remarks

The send command can be used in three ways.

With no direct object, it sends all queued messages.
With a single message or a list of messages as direct object, it will send those messages as if Send & Receive had been clicked (queuing or sending immediately).
With a message window as direct object, it will send the message window in a similar way.

The first parameter specifies the message or messages to send; omitting this parameter sends all queued messages. The sending later parameter specifies whether the message should just be queued to send later (the default value is false).

Example

send myWindow

send attachments to cc recipients

Whether attachments to the message should be sent to the CC and BCC recipients. Boolean.

Property of

outgoing message

Remarks

A value of true for this property specifies that CC and BCC recipients receive the attachments to the message.

send secure password

Whether the password should be sent securely. Boolean.

Property of

IMAP account, POP account

Example

set the send secure password of MyAccount to true

sender

The e-mail address that sent the message. Address.

Property of

message

Example

set CurSender to sender of CurMessage

sending account

For a specified server, the e-mail account that Outlook Express should use to send e-mail responses to newsgroup articles. Reference.

Property of

news server

sent mail folder

The folder where copies of mail messages that you send are stored. Read-only Reference.

Property of

application

server address

The address of the list server for the mailing list. String.

Property of

mailing list

set

Set an object's data. Command.

Syntax

set Reference to Anything

Remarks

The first parameter specifies the object to change, and the to parameter specifies the new value.

show only name in messages

Whether to show only the group name in sent messages. Boolean.

Property of

group

Remarks

If this property is set to true for a group object, then members of the group cannot see the addresses of other group members on the messages they receive, but instead only the name of the group where the addresses would otherwise be; the members' addresses are effectively placed in the BCC field. (See the BCC recipients property.)

signature

An e-mail signature. Class.

Plural form

signatures

Properties

content, ID, include in random, name

Remarks

The signature class represents signatures, which have a unique ID, name and contents. Signatures can be opened, deleted, duplicated, and created.

signature type

The type of signature to be used for the message.

Property of

draft news window, draft window

Possible values

none, other, random

SMTP port

The port to use when connecting to the SMTP server. Integer.

Property of

IMAP account, POP account

Example

set the SMTP port of MyAccount to 25

SMTP requires SSL

Whether the SMTP server requires that SSL be used when connecting to it.

Property of

IMAP account, POP account

Remarks

The value of this property is true if the SMTP server requires SSL.

Example

set the SMTP requires SSL of MyAccount to false

SMTP server

The SMTP server used to send e-mail from the account. String.

Property of

IMAP account, POP account

Example

set the SMTP server of MyAccount to "smtp.microsoft.com"

source

The raw source text of the message. String.

Property of

message

state

The state or province of the postal address. Unicode Text.

Property of

postal address

Example

set the state of the business address of NewContact to "WA"

storage

The folder to which mailing list messages will be filed. Reference.

Property of

mailing list

storage

The folder that contains the message. Reference.

Property of

message

street address

The first line of the street address of the postal address. Unicode Text.

Property of

postal address

Example

set the street address of the home address of NewContact to "888 999th Avenue"

street address 2

The second line of the street address of the postal address. Unicode Text.

Property of

postal address

Example

set the street address of the home address of NewContact to "Apartment 100A"

subject

The topic of the message. Unicode Text.

Property of

draft news window, draft window, message

Example

set CurSubject to the subject of CurMessage

subtype

The MIME subtype of the message part. Read-only String.

Property of

part

suffix

The suffix of the name of the person listed in the contact. Unicode Text.

Property of

contact

Remarks

Typical suffixes include "Jr." and "III."

T-Z

time received

The date and time when the message was received. Date.

Property of

message

time sent

The date and time when the message was sent. Date.

Property of

message

title

The title of the person listed in the contact. Unicode Text.

Property of

contact

Example

set the title of NewContact to "Editor-in-Chief"

titled

Whether the window has a title bar. Read-only Boolean.

Property of

window

to recipients

The "to" recipients (as text) of the message. Unicode Text.

Property of

draft window

Example

set the to recipients of myWindow to TargetAddress

type

The MIME type of the message part. Read-only String.

Property of

part

unread message count

The number of unread messages in the folder or newsgroup. Read-only Integer.

Property of

folder, news group

use Windows file names

Whether the attachments to the message should be sent with Microsoft Windows-style file names. Boolean.

Property of

outgoing message

Remarks

A value of true for this property indicates that attachments should be sent with Windows file names. Outlook Express will then append ".txt" to the names of text files, ".doc" to the names of Microsoft Word files, and so on.

user name

The user name used to access the server.

Property of

LDAP server, news server

Example

set the user name of MyServer to "someone"

version

The version of Outlook Express currently running. Version.

Property of

application

visible

Whether the window is visible. Boolean.

Property of

window

window

An application window. Class.

Plural form

windows

Properties

bounds, class, closeable, content, displayed feature, displayed message, floating, index, modal, name, position, resizable, titled, visible, zoomable, zoomed

Remarks

The message window subclass is defined so that you can examine the class of a window to see if it�s a message window. More classes may be provided in the future.

The close command closes a window.

zip

The zip code or other postal code for the postal address. Unicode Text.

Property of

postal address

Example

set the zip of the business address of NewContact to "98052-6399"

zoomable

Whether the window is zoomable. Read-only Boolean.

Property of

window

zoomed

Whether the window is zoomed. Boolean.

Property of

window