MailItem Members (Outlook)

GitHub-Mark-64px

Contribute to this content

Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation.

Represents a mail message.

Events

Name

Description

AfterWrite

Occurs after Microsoft Outlook has saved the item.

AttachmentAdd

Occurs when an attachment has been added to an instance of the parent object.

AttachmentRead

Occurs when an attachment in an instance of the parent object has been opened for reading.

AttachmentRemove

Occurs when an attachment has been removed from an instance of the parent object.

BeforeAttachmentAdd

Occurs before an attachment is added to an instance of the parent object.

BeforeAttachmentPreview

Occurs before an attachment associated with an instance of the parent object is previewed.

BeforeAttachmentRead

Occurs before an attachment associated with an instance of the parent object is read from the file system, an attachment stream, or an Attachment object.

BeforeAttachmentSave

Occurs just before an attachment is saved.

BeforeAttachmentWriteToTempFile

Occurs before an attachment associated with an instance of the parent object is written to a temporary file.

BeforeAutoSave

Occurs before the item is automatically saved by Outlook.

BeforeCheckNames

Occurs just before Microsoft Outlook starts resolving names in the recipient collection for an item (which is an instance of the parent object).

BeforeDelete

Occurs before an item (which is an instance of the parent object) is deleted.

BeforeRead

Occurs before Microsoft Outlook begins to read the properties for the item.

Close

Occurs when the inspector associated with an item (which is an instance of the parent object) is being closed.

CustomAction

Occurs when a custom action of an item (which is an instance of the parent object) executes.

CustomPropertyChange

Occurs when a custom property of an item (which is an instance of the parent object) is changed.

Forward

Occurs when the user selects the Forward action for an item, or when the Forward method is called for the item, which is an instance of the parent object.

Open

Occurs when an instance of the parent object is being opened in an Inspector.

PropertyChange

Occurs when an explicit built-in property (for example, Subject) of an instance of the parent object is changed.

Read

Occurs when an instance of the parent object is opened for editing by the user.

ReadComplete

Occurs when Outlook has completed reading the properties of the item.

Reply

Occurs when the user selects the Reply action for an item, or when the Reply method is called for the item, which is an instance of the parent object.

ReplyAll

Occurs when the user selects the ReplyAll action for an item, or when the ReplyAll method is called for the item, which is an instance of the parent object.

Send

Occurs when the user selects the Send action for an item, or when the Send method is called for the item, which is an instance of the parent object.

Unload

Occurs before an Outlook item is unloaded from memory, either programmatically or by user action.

Write

Occurs when an instance of the parent object is saved, either explicitly (for example, using the Save or SaveAs methods) or implicitly (for example, in response to a prompt when closing the item's inspector).

Methods

Name

Description

AddBusinessCard

Appends contact information based on the Electronic Business Card (EBC) associated with the specified ContactItem object to the MailItem object.

ClearConversationIndex

Clears the index of the conversation thread for the mail message.

ClearTaskFlag

Clears the MailItem object as a task.

Close

Closes and optionally saves changes to the Outlook item.

Copy

Creates another instance of an object.

Delete

Removes the item from the folder that contains the item.

Display

Displays a new Inspector object for the item.

Forward

Executes the Forward action for an item and returns the resulting copy as a MailItem object.

GetConversation

Obtains a Conversation object that represents the conversation to which this item belongs.

MarkAsTask

Marks a MailItem object as a task and assigns a task interval for the object.

Move

Moves a Microsoft Outlook item to a new folder.

PrintOut

Prints the Outlook item using all default settings.The PrintOut method is the only Outlook method that can be used for printing.

Reply

Creates a reply, pre-addressed to the original sender, from the original message.

ReplyAll

Creates a reply to all original recipients from the original message.

Save

Saves the Microsoft Outlook item to the current folder or, if this is a new item, to the Outlook default folder for the item type.

SaveAs

Saves the Microsoft Outlook item to the specified path and in the format of the specified file type. If the file type is not specified, the MSG format (.msg) is used.

Send

Sends the e-mail message.

ShowCategoriesDialog

Displays the Show Categories dialog box, which allows you to select categories that correspond to the subject of the item.

Properties

Name

Description

Actions

Returns an Actions collection that represents all the available actions for the item. Read-only.

AlternateRecipientAllowed

Returns a Boolean value that indicates whether the mail message can be forwarded. Read/write.

Application

Returns an Application object that represents the parent Outlook application for the object. Read-only.

Attachments

Returns an Attachments object that represents all the attachments for the specified item. Read-only.

AutoForwarded

A Boolean value that returns True if the item was automatically forwarded. Read/write.

AutoResolvedWinner

Returns a Boolean that determines if the item is a winner of an automatic conflict resolution. Read-only.

BCC

Returns a String representing the display list of blind carbon copy (BCC) names for a MailItem. Read/write.

BillingInformation

Returns or sets a String representing the billing information associated with the Outlook item. Read/write.

Body

Returns or sets a String representing the clear-text body of the Outlook item. Read/write.

BodyFormat

Returns or sets an OlBodyFormat constant indicating the format of the body text. Read/write.

Categories

Returns or sets a String representing the categories assigned to the Outlook item. Read/write.

CC

Returns a String representing the display list of carbon copy (CC) names for a MailItem. Read/write.

Class

Returns an OlObjectClass constant indicating the object's class. Read-only.

Companies

Returns or sets a String representing the names of the companies associated with the Outlook item. Read/write.

Conflicts

Return the Conflicts object that represents the items that are in conflict for any Outlook item object. Read-only.

ConversationID

Returns a String that uniquely identifies a Conversation object that the MailItem object belongs to. Read-only.

ConversationIndex

Returns a String that indicates the relative position of the item within the conversation thread. Read-only.

ConversationTopic

Returns a String representing the topic of the conversation thread of the Outlook item. Read-only.

CreationTime

Returns a Date indicating the creation time for the Outlook item. Read-only.

DeferredDeliveryTime

Returns or sets a Date indicating the date and time the mail message is to be delivered. Read/write.

DeleteAfterSubmit

Returns or sets a Boolean value that is True if a copy of the mail message is not saved upon being sent, and False if a copy is saved. Read/write.

DownloadState

Returns a constant that belongs to the OlDownloadState enumeration indicating the download state of the item. Read-only.

EntryID

Returns a String representing the unique Entry ID of the object. Read-only.

ExpiryTime

Returns or sets a Date indicating the date and time at which the item becomes invalid and can be deleted. Read/write.

FlagRequest

Returns or sets a String that indicates the requested action for a mail item. Read/write.

FormDescription

Returns the FormDescription object that represents the form description for the specified Outlook item. Read-only.

GetInspector

Returns an Inspector object that represents an inspector initialized to contain the specified item. Read-only.

HTMLBody

Returns or sets a String representing the HTML body of the specified item. Read/write.

Importance

Returns or sets an OlImportance constant indicating the relative importance level for the Outlook item. Read/write.

InternetCodepage

Returns or sets a Long that determines the Internet code page used by the item. Read/write.

IsConflict

Returns a Boolean that determines if the item is in conflict. Read-only.

IsMarkedAsTask

Returns a Boolean value that indicates whether the MailItem is marked as a task. Read-only.

ItemProperties

Returns an ItemProperties collection that represents all standard and user-defined properties associated with the Outlook item. Read-only.

LastModificationTime

Returns a Date specifying the date and time that the Outlook item was last modified. Read-only.

MarkForDownload

Returns or sets an OlRemoteStatus constant that determines the status of an item once it is received by a remote user. Read/write.

MessageClass

Returns or sets a String representing the message class for the Outlook item. Read/write.

Mileage

Returns or sets a String representing the mileage for an item. Read/write.

NoAging

Returns or sets a Boolean value that is True to not age the Outlook item. Read/write.

OriginatorDeliveryReportRequested

Returns or sets a Boolean value that determines whether the originator of the meeting item or mail message will receive a delivery report. Read/write.

OutlookInternalVersion

Returns a Long representing the build number of the Outlook application for an Outlook item. Read-only.

OutlookVersion

Returns a String indicating the major and minor version number of the Outlook application for an Outlook item. Read-only.

Parent

Returns the parent Object of the specified object. Read-only.

Permission

Sets or returns an OlPermission constant that determines what permissions to grant to the recipients of the e-mail item. Read/write.

PermissionService

Sets or returns an OlPermissionService constant that determines the permission service that will be used when sending a message protected by Information Rights Management (IRM). Read/write.

PermissionTemplateGuid

Returns or sets a String value that represents the GUID of the template file to apply to the MailItem in order to specify Information Rights Management (IRM) permissions. Read/write.

PropertyAccessor

Returns a PropertyAccessor object that supports creating, getting, setting, and deleting properties of the parent MailItem object. Read-only.

ReadReceiptRequested

Returns a Boolean value that indicates True if a read receipt has been requested by the sender.

ReceivedByEntryID

Returns a String representing the EntryID for the true recipient as set by the transport provider delivering the mail message. Read-only.

ReceivedByName

Returns a String representing the display name of the true recipient for the mail message. Read-only.

ReceivedOnBehalfOfEntryID

Returns a String representing the EntryID of the user delegated to represent the recipient for the mail message. Read-only.

ReceivedOnBehalfOfName

Returns a String representing the display name of the user delegated to represent the recipient for the mail message. Read-only.

ReceivedTime

Returns a Date indicating the date and time at which the item was received. Read-only.

RecipientReassignmentProhibited

Returns a Boolean that indicates True if the recipient cannot forward the mail message. Read/write.

Recipients

Returns a Recipients collection that represents all the recipients for the Outlook item. Read-only.

ReminderOverrideDefault

Returns or sets a Boolean value that is True if the reminder overrides the default reminder behavior for the item. Read/write.

ReminderPlaySound

Returns or sets a Boolean value that is True if the reminder should play a sound when it occurs for this item. Read/write.

ReminderSet

Returns or sets a Boolean value that is True if a reminder has been set for this item. Read/write.

ReminderSoundFile

Returns or sets a String indicating the path and file name of the sound file to play when the reminder occurs for the Outlook item. Read/write.

ReminderTime

Returns or sets a Date indicating the date and time at which the reminder should occur for the specified item. Read/write.

RemoteStatus

Returns or sets an OlRemoteStatus constant specifying the remote status of the mail message. Read/write.

ReplyRecipientNames

Returns a semicolon-delimited String list of reply recipients for the mail message. Read-only.

ReplyRecipients

Returns a Recipients collection that represents all the reply recipient objects for the Outlook item. Read-only.

RetentionExpirationDate

Returns a Date that specifies the date when the MailItem object expires, after which the Messaging Records Management (MRM) Assistant will delete the item. Read-only.

RetentionPolicyName

Returns a String that specifies the name of the retention policy. Read-only.

RTFBody

Returns or sets a Byte array that represents the body of the Microsoft Outlook item in Rich Text Format. Read/write.

Saved

Returns a Boolean value that is True if the Outlook item has not been modified since the last save. Read-only.

SaveSentMessageFolder

Returns or sets a Folder object that represents the folder in which a copy of the e-mail message will be saved after being sent. Read/write.

Sender

Returns or sets an AddressEntry object that corresponds to the user of the account from which the MailItem is sent. Read/write.

SenderEmailAddress

Returns a String that represents the e-mail address of the sender of the Outlook item. Read-only.

SenderEmailType

Returns a String that represents the type of entry for the e-mail address of the sender of the Outlook item, such as 'SMTP' for Internet address, 'EX' for a Microsoft Exchange server address, etc. Read-only.

SenderName

Returns a String indicating the display name of the sender for the Outlook item. Read-only.

SendUsingAccount

Returns or sets an Account object that represents the account under which the MailItem is to be sent. Read/write.

Sensitivity

Returns or sets a constant in the OlSensitivity enumeration indicating the sensitivity for the Outlook item. Read/write.

Sent

Returns a Boolean value that indicates if a message has been sent. Read-only.

SentOn

Returns a Date indicating the date and time on which the Outlook item was sent. Read-only.

SentOnBehalfOfName

Returns a String indicating the display name for the intended sender of the mail message. Read/write.

Session

Returns the NameSpace object for the current session. Read-only.

Size

Returns a Long indicating the size (in bytes) of the Outlook item. Read-only.

Subject

Returns or sets a String indicating the subject for the Outlook item. Read/write.

Submitted

Returns a Boolean value that is True if the item has been submitted. Read-only.

TaskCompletedDate

Returns or sets a Date value that represents the completion date of the task for this MailItem. Read/write.

TaskDueDate

Returns or sets a Date value that represents the due date of the task for this MailItem. Read/write.

TaskStartDate

Returns or sets a Date value that represents the start date of the task for this MailItem object. Read/write.

TaskSubject

Returns or sets a String value that represents the subject of the task for the MailItem object. Read/write.

To

Returns or sets a semicolon-delimited String list of display names for the To recipients for the Outlook item. Read/write.

ToDoTaskOrdinal

Returns or sets a Date value that represents the ordinal value of the task for the MailItem. Read/write.

UnRead

Returns or sets a Boolean value that is True if the Outlook item has not been opened (read). Read/write.

UserProperties

Returns the UserProperties collection that represents all the user properties for the Outlook item. Read-only.

VotingOptions

Returns or sets a String specifying a delimited string containing the voting options for the mail message. Read/write.

VotingResponse

Returns or sets a String specifying the voting response for the mail message. Read/write.