Mail

Provides information and actions for routed messages. A subtype of Message.

Properties

The following table lists properties along with their access and descriptions.

Property

Access

Description

Archived

R/W

Boolean. TRUE if this message has been archived.

Categories

R/O

Categories Collection. The collection of Category objects on this Mail, Appointment, Document Reference, Note, Phone Message, Task, or AddressBookEntry.

ChecklistCompleted

R/W

Boolean. TRUE if the item is part of the Checklist folder Messages collection or a Task item AND the item has been marked Completed. FALSE otherwise.

ChecklistCompletedDate

R/W

Date. The date this item was marked completed.

ChecklistDueDate

R/W

Date. The date this item should be Completed. Returns an error if the Message item is not a Task or is not part of the Checklist folder Messages collection.

ChecklistPercentComplete

R/W

Integer. Between 0 and 100 percent, how complete the checklist item is. If this value is set to a number outside the 0 to 100 range, an error is returned. If the value is set to 100, the item will also be marked complete.

ChecklistShowOnCalendarDate

R/W

Date. The date this item should appear on the calendar task list.

ClientMessageID

R/O

The ClientMessageId method will return the string that the GroupWise Client puts in the properties page of an item.

CommonMessageID

R/O

String. The ID of the message, regardless of its location. For example, an email will have the same CommonMessageID for both Sent and Received.

Completed

R/W

Boolean. TRUE if the current user is done with this message and it’s ready to be sent to the next user in the recipient list.

DelayedDeliveryDate

R/W

Date. When the Message.Send() method is called, the message is not delivered until the specified Date. This property can be used only on a Draft Message.

Delegated

R/O

Boolean. TRUE if this message was delegated to you.

DeliveredDate

R/O

Date. The date and time this message item was delivered to the account.

Forwarded

R/O

Boolean. TRUE if this item has been forwarded to another user. Otherwise, FALSE.

LastModifiedRetentionDate

R/O

Normally an item is retained after a set amount of time. It is possible to add personal notes or personal attachments on items. The LastModifiedRetentionDate is used for retention software to know that significant data has changed on the item and that the retention software needs to capture the item again.

MessageProperty

R/O

String. Based on the MessagePropertiesConstant passed in, a different string is returned.

NotifyWhenCompleted

R/W

Enum (NotifyMessageConstants). Specifies the type of notification to send when this message has been marked completed.

PersonalSubject

R/W

String. A text string to be shown by the GroupWise Windows client as the Subject text. This text appears only for the current user. The normal subject or their own Personal Subject text appears for other users.

Replied

R/O

Boolean. TRUE if this item has been replied to. Otherwise, FALSE.

Sharer

R/O

Address. The user who added this message to a shared folder. If this message was not added to a shared folder, this will be the same as the Sender property.

ShowOnChecklist

R/W

Boolean. TRUE if the item is part of the Checklist folder Messages collection. FALSE otherwise.

Size

R/O

Returns the size of the attachments and message body. If there are no attachments, only the size of the message body is returned.

Methods

GetMIME ()

Some developers will store the GroupWise data as MIME. The GetMIME method will return all GroupWise items whether or not it has a MIME/RFC822 attachment. This method is very CPU intensive and should be avoided unless absolutely needed.

LocalDelete()

Deletes this message only from the currently connected post office database. No synchronization will take place between the master database and a remote database.

Mail Delegate()

Delegate this message to another user. Returns the OutBox mail message.

RemoveChecklistDueDate()

Removes the Checklist Due Date from the Message item. Returns an error if the item is not on the Checklist.