Documentation

RetentionActionType extends Enumeration
in package

Defines the action performed on items with the retention tag.

Table of Contents

Constants

DELETE_AND_ALLOW_RECOVERY  = 'DeleteAndAllowRecovery'
The item is deleted and put into the Dumpster.
MARK_AS_PAST_RETENTION_LIMIT  = 'MarkAsPastRetentionLimit'
The item is marked as having exceeded the retention time limit.
MOVE_TO_ARCHIVE  = 'MoveToArchive'
The item is moved to the archive mailbox.
MOVE_TO_DELETED_ITEMS  = 'MoveToDeletedItems'
The item is moved to the default Deleted Items folder.
MOVE_TO_FOLDER  = 'MoveToFolder'
The item is moved to a specified folder.
NONE  = 'None'
No action is performed on the item.
PERMANENTLY_DELETE  = 'PermanentlyDelete'
The item is permanently deleted from the mailbox.

Properties

$_  : string
Element value.

Methods

__clone()  : mixed
Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.
__toString()  : string
Returns the value of this enumeration as a string.

Constants

DELETE_AND_ALLOW_RECOVERY

The item is deleted and put into the Dumpster.

public string DELETE_AND_ALLOW_RECOVERY = 'DeleteAndAllowRecovery'
Tags
since

Exchange 2013

MARK_AS_PAST_RETENTION_LIMIT

The item is marked as having exceeded the retention time limit.

public string MARK_AS_PAST_RETENTION_LIMIT = 'MarkAsPastRetentionLimit'
Tags
since

Exchange 2013

MOVE_TO_ARCHIVE

The item is moved to the archive mailbox.

public string MOVE_TO_ARCHIVE = 'MoveToArchive'
Tags
since

Exchange 2013

MOVE_TO_DELETED_ITEMS

The item is moved to the default Deleted Items folder.

public string MOVE_TO_DELETED_ITEMS = 'MoveToDeletedItems'
Tags
since

Exchange 2013

MOVE_TO_FOLDER

The item is moved to a specified folder.

public string MOVE_TO_FOLDER = 'MoveToFolder'
Tags
since

Exchange 2013

NONE

No action is performed on the item.

public string NONE = 'None'
Tags
since

Exchange 2013

PERMANENTLY_DELETE

The item is permanently deleted from the mailbox.

public string PERMANENTLY_DELETE = 'PermanentlyDelete'
Tags
since

Exchange 2013

Properties

$_

Element value.

public string $_
Tags
deprecated
1.0.0

This property will be removed in a future release and should not be used. Instead, you should reference the constants implemented in the class directly.

Methods

__clone()

Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.

public __clone() : mixed

__toString()

Returns the value of this enumeration as a string.

public __toString() : string

.

Tags
suppress

PhanDeprecatedProperty

Return values
string

        
On this page

Search results