Get Mailbox

Article
10/24/2013

Applies To: System Center 2012 R2 Orchestrator, System Center 2012 SP1 - Orchestrator

You can use the Get Mailbox activity to retrieve the attributes and objects for a mailbox in an on-premises or online environment. The Get Mailbox activity lets you filter against various mailbox attributes.

The following tables list the required properties, filters, optional properties, and published data for this activity.

Required properties for the Get Mailbox activity

This activity has no required properties.

Filters for the Get Mailbox activity

Element	Description	Valid values
Accept Messages Only From	Mailbox users and mail-enabled contacts that can send email messages to this distribution group.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Accept Messages Only From DL Members	Distribution lists that are allowed to send email messages to this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Accept Messages Only From Senders Or Members	Senders or members that are allowed to send email messages to this distribution group.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Address Book Policy	Address book policy for the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Address List Membership	Address list IDs.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Alias	Mail nickname of the user.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Admin Display Version	The version of the administrator's display.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Antispam Bypass Enabled	Indicates whether anti-spam processing is used on the mailbox.	Equals Does not equal
Arbitration Mailbox	ID of the arbitration mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Archive Database	ID of the archive database.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Archive Domain	Archive domain name.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Archive GUID	Unique archive identifier for the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Archive Name	Name of the archive mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Archive Quota	Maximum size of the archive mailbox. Can This property value can be either “unlimited” or a string with format <integer> <unit> where unit can be KB, MB, GB, or TB. Defaults to Byte when unit is not specified. Examples: 55 GB, unlimited, 77, 14 KB	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Archive Release	Archive release.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Archive Status	Indicates archive status (Active or None).	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Archive State	Indicates the state of the mailbox archive. This can be one of the following values: HostedPending HostedProvisioned Local None OnPremise	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Archive Warning Quota	Mailbox size at which a warning message is sent. This property can be either “unlimited” or a string with format <integer> <unit> where unit can be KB, MB, GB, or TB. Defaults to Byte when unit is not specified. Examples: 55 GB, unlimited, 77, 14 KB	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Audit Admin	List of admin operations that are logged. This can be one of the following values: Copy Create FolderBind HardDelete MessageBind Move MoveToDeletedItems None SendAs SendOnBehalf SoftDelete Update	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Audit Delegate	List of delegate options that are logged. This can be one of the following values: Copy Create FolderBind HardDelete MessageBind Move MoveToDeletedItems None SendAs SendOnBehalf SoftDelete Update	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Audit Enabled	Indicates whether audit logging is enabled or disabled for the mailbox.	Equals Does not equal
Audit Log Age Limit	Amount of time the audit log entries are retained in the mailbox. Format: d.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Audit Owner	List of owner operations that are logged. This can be one of the following values: Copy Create FolderBind HardDelete MessageBind Move MoveToDeletedItems None SendAs SendOnBehalf SoftDelete Update	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Bypass Moderation From Senders Or Members	List of senders for whom moderation is to be bypassed.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Calendar Repair Disabled	Indicates whether calendar items in this mailbox will be repaired by the Calendar Repair Assistant.	Equals Does not equal
Calendar Version Store Disabled	Indicates whether changes to calendar items are logged.	Equals Does not equal
Custom Attribute 1 - 15	Custom attribute values.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Database	Active Directory ID of the database that contains this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Default Public Folder Mailbox	Default public folder mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Deliver To Mailbox And Forward	Indicates whether messages sent to this mailbox are forwarded to another mailbox.	Equals Does not equal
Disabled Archive Database	ID of disabled archive database.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Disabled Archive GUID	GUID of disabled archive.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Display Name	Display name for the mailbox user.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Distinguished Name	Distinguished name for the object.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Downgrade High Priority Messages Enabled	Indicates whether high-priority messages that have been sent to an X.400 mail system are changed to normal priority.	Equals Does not equal
Email Addresses	The collection of email addresses for the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Email Address Policy Enabled	Indicates whether Email Address Policy is enabled.	Equals Does not equal
End Date For Retention Hold	Date and time that a retention hold on messages in this mailbox expires.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Exchange GUID	Unique identifier of the Microsoft Exchange installation.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Exchange User Account Control	A mask that is used to retrieve the user account control flags associated with this mailbox. This can be one of the following values: AccountDisabled CannotChangePassowrd DoNotExpirePassword DoNotRequirePreauthentication EncryptedTextPasswordAllowed HomeDirectoryRequired InterDomainTrustAccount Lockout MnsLogonAccount None NormalAccount NotDelegated PasswordExpired PasswordNotRequired Script ServerTrustAccount SmartCardRequired TemporaryDuplicateAccount TrustedForDelegation TrustedToAuthenticateForDelegation UseDesKeyOnly WorkstationTrustAccount	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Exchange Version	Version of Microsoft Exchange that this object is associated with.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Extensions	Extensions list.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
ExtensionCustomAttribute1- 5	Extension custom attribute.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
External Directory Object ID	External directory object ID.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
External OOF Options	Options for sending Out of Office (OOF) messages to external senders. This can be one of the following values: InternalOnly External	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Forwarding Address	Forwarding address for the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Forwarding SMTP Address	Forwarding SMTP address for the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Grant Send On Behalf To	List of users with “send on behalf” rights for this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
GUID	The globally unique identifier for this object.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Has Picture	Indicates whether a picture has been associated with this mailbox.	Equals Does not equal
Has Spoken Name	Indicates whether a spoken name has been associated with this mailbox.	Equals Does not equal
Hidden From Address Lists Enabled	Indicates whether mailbox information is hidden from address book display.	Equals Does not equal
Identity	Mailbox identity.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Immutable ID	Mailbox identifier that will never change.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Include In Garbage Collection	Include In Garbage Collection.	Equals Does not equal
Is Linked	Indicates whether the mailbox is linked.	Equals Does not equal
Is Machine To Person Text Messaging Enabled	Indicates whether the server can send text messages to this user.	Equals Does not equal
Is Mailbox Enabled	Indicates whether the mailbox is enabled to process messages.	Equals Does not equal
Is Person To Person Text Messaging Enabled	Indicates whether another mailbox user can send a text message to the owner of this mailbox.	Equals Does not equal
Is Resource	Indicates whether this mailbox represents a resource, such as a conference room.	Equals Does not equal
Is Shared	Indicates whether this mailbox is shared by more than one user.	Equals Does not equal
Is Soft Deleted By Disable	Indicates whether the mailbox has been soft deleted as a result of a disable operation.	Equals Does not equal
Is Soft Deleted By Remove	Indicates whether the mailbox has been soft deleted as a result of a remove operation.	Equals Does not equal
Issue Warning Quota	Mailbox size at which a warning message is sent to the user.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Is Valid	Indicates whether the object is configured correctly.	Equals Does not equal
Languages	Preferred languages for this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Last Exchange Changed Time	Last Exchange changed time.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Legacy Exchange DN	Legacy Exchange DN.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Linked Master Account	Master account for the linked mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Litigation Hold Date	Date and time when litigation hold was enabled.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Litigation Hold Enabled	Indicates whether the mailbox is under a litigation hold.	Equals Does not equal
Litigation Hold Owner	User who enabled the litigation hold.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mailbox Move Batch Name	Name of the move batch that contains this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mailbox Move Flags	Flags for a mailbox move. This can be one of the following values: CrossOrg IntraOrg MoveOnlyArchiveMailbox MoveOnlyPrimaryMailbox None Offline Protected Pull Push RemoteLegacy Suspend SuspendWhenReadyToComplete HighPriority	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mailbox Move Remote Host Name	Name of the remote host that is participating in the move.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mailbox Move Source MDB	Active Directory identifier of the source database.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mailbox Move Status	Indicates the status of a mailbox move. This can be one of the following values: AutoSuspended Completed CompletedWithWarning CompletionInProgress Failed InProgress None Queued Suspended	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mailbox Move Target MDB	Active Directory identifier of the database that the mailbox is being copied to.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mailbox Plan	Mailbox plan for the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mailbox Release	Mailbox release.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mail Tip	Mail tip.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Mail Tip Translations	Mail tip translation list.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Managed Folder Mailbox Policy	Messaging Records Management (MRM) policy for the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Max Blocked Senders	Maximum number of senders that can be included in a blocked senders list.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Max Receive Size	Received message size limit. Can be either “unlimited” or a string with format <integer> <unit> where unit can be KB, MB, GB, or TB. Defaults to Byte when unit is not specified. Examples: 55 GB, unlimited, 77, 14 KB	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Max Safe Senders	Maximum number of senders that can be included in a safe senders list.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Max Send Size	Sent message size limit. Can be either “unlimited” or a string with format <integer> <unit> where unit can be KB, MB, GB, or TB. Defaults to Byte when unit is not specified. Examples: 55 GB, unlimited, 77, 14 KB	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Message Tracking Read Status Enabled	Indicates whether detailed message tracking is enabled for the mailbox.	Equals Does not equal
Microsoft Online Services ID	Microsoft Online Services ID	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Moderated By	List of users responsible for moderating this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Moderation Enabled	Indicates whether moderation is enabled or not for this mailbox.	Equals Does not equal
Name	Name associated with this object.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Object Category	Active Directory object category for this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Object Class	List of Active Directory object classes that apply to this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Office	Microsoft Office attribute for the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Offline Address Book	Offline address book associated with the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Organizational Unit	Organizational unit for this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Organization ID	Organization for this mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Originating Server	Originating server.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Partner Object ID	GUID for partner object ID.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Persisted Capabilities	Persisted capability list.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Policies Excluded	List of policies that are excluded.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Policies Included	List of policies that are included.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Primary SMTP Address	Primary SMTP address for the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Prohibit Send Quota	Mailbox size at which the user is prohibited from sending email. Can be either “unlimited” or a string with format <integer> <unit> where unit can be KB, MB, GB, or TB. Defaults to Byte when unit is not specified. Examples: 55 GB, unlimited, 77, 14 KB	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Prohibit Send Receive Quota	Mailbox size at which the user is prohibited from sending or receiving email. Can be either “unlimited” or a string with format <integer> <unit> where unit can be KB, MB, GB, or TB. Defaults to Byte when unit is not specified. Examples: 55 GB, unlimited, 77, 14 KB	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Protocol Settings	Protocols used by the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Query Base DN	This property is used to control which address list a user has access to through Outlook Web App.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Query Base DN Restriction Enabled	Indicates whether the user can search and view other mailboxes in their organization.	Equals Does not equal
Recipient Limits	Maximum number of recipients per message that this mailbox can send to. Can be either “unlimited” or an integer.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Recipient Type	Recipient type. This can be one of the following values: Computer Contact DynamicDistributionGroup Group Invalid MailContact MailNonUniversalGroup MailUniversalDistributionGroup MailUniversalSecurityGroup MailUser MicrosoftExchange PublicDatabase PublicFolder SystemAttendantMailbox SystemMailbox User UserMailbox	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Recipient Type Details	Recipient type details. This can be one of the following values: AllUniqueRecipientTypes ArbitrationMailbox Computer Contact DisabledUser DiscoveryMailbox DynamicDistributionGroup EquipmentMailbox LegacyMailbox LinkedMailbox LinkedUser MailboxPlan MailContact MailForestContact MailNonUniversalGroup MailUniversalDistributionGroup MailUniversalSecurityGroup MailUser MicrosoftExchange None NonUniversalGroup PublicFolder RemoteEquipmentMailbox RemoteRoomMailbox RemoteSharedMailbox RemoteUserMailbox RoleGroup RoomList RoomMailbox SharedMailbox SystemAttendantMailbox SystemMailbox UniversalDistributionGroup UniversalSecurityGroup User UserMailbox	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Reconciliation Id	Reconciliation ID.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Recoverable Items Quota	Size limit for the Recovery Items folder. Can be either “unlimited” or a string with format <integer> <unit> where unit can be KB, MB, GB, or TB. Defaults to Byte when unit is not specified. Examples: 55 GB, unlimited, 77, 14 KB	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Recoverable Items Warning Quota	Size at which a warning is sent that the Recovery Items folder is reaching its limit. Can be either “unlimited” or a string with format <integer> <unit> where unit can be KB, MB, GB, or TB. Defaults to Byte when unit is not specified. Examples: 55 GB, unlimited, 77, 14 KB	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Reject Messages From	Rejected sender IDs list.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Reject Messages From DL Members	Rejected sender IDs list.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Reject Messages From Senders Or Members	Rejected sender IDs list.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Remote Account Policy	Remote account policy ID.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Remote Recipient Type	Remote recipient type. This can be one of the following values: DeprovisionArchive DeprovisionMailbox EquipmentMailbox Migrated None ProvisionArchive ProvisionMailbox RoomMailbox SharedMailbox	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Require Sender Authentication Enabled	Indicates whether sender authentication is required.	Equals Does not equal
Resource Capacity	Capacity of a resource mailbox.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Resource Custom	List containing additional information about a resource.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Resource Type	Type of a resource.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Retain Deleted Items For	Length of time to keep deleted items. Format: d.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Retain Deleted Items Until Backup	Indicates whether deleted items should be kept until the database is backed up.	Equals Does not equal
Retention Comment	The comment that is displayed regarding the user’s retention hold status.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Retention Hold Enabled	Indicates whether the contents of the mailbox are subject to retention.	Equals Does not equal
Retention Policy	Retention policy that is applied to the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Retention URL	URL for a webpage with details about the organization’s message retention policies.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Role Assignment Policy	Management role that was assigned to the mailbox when it was created or enabled.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Rules Quota	Size limit for rules. Can be either “unlimited” or a string with format <integer> <unit> where unit can be KB, MB, GB, or TB. Defaults to Byte when unit is not specified. Examples: 55 GB, unlimited, 77, 14 KB	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Sam Account Name	User name for use with earlier operating systems.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
SCL Delete Enabled	Indicates whether messages that meet the spam confidence level (SCL) are deleted.	Equals Does not equal
SCL Delete Threshold	Spam confidence level (SCL) at which messages are considered spam and are to be deleted.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than
SCL Junk Enabled	Indicates whether messages that meet the spam confidence level (SCL) are moved to the Junk E-Mail folder.	Equals Does not equal
SCL Junk Threshold	Spam confidence level (SCL) at which messages are considered spam and are to be moved to the Junk E-Mail folder.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
SCL Quarantine Enabled	Indicates whether messages that meet the spam confidence level (SCL) are quarantined.	Equals Does not equal
SCL Quarantine Threshold	Spam confidence level (SCL) at which messages are considered spam and are to be moved to the quarantine folder.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than
SCL Reject Enabled	Indicates whether messages that meet the spam confidence level (SCL) are rejected.	Equals Does not equal
SCL Reject Threshold	Spam confidence level (SCL) at which messages are considered spam and are to be rejected.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Send Moderation Notifications	Moderation notifications for this mailbox. This can be one of the following values: Always Internal Never	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Server Legacy DN	Legacy domain name for the server.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Server Name	Name of the server.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Sharing Policy	Sharing policy associated with the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Simple Display Name	Simple display name.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Single Item Recovery Enabled	Indicates whether the Recovery Items folder can be purged.	Equals Does not equal
SKU Assigned	SKU Assigned.	Equals Does not equal
Start Date For Retention Hold	Date and time that a retention hold on messages in this mailbox begins.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Throttling Policy	Identifier for the throttling policy applied to the mailbox.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
UM DTMF Map	UM DTMF Map.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
UM Enabled	Indicates whether Unified Messaging (UM) is enabled for this mailbox.	Equals Does not equal
Usage Location	Country name.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Use Database Quota Defaults	Indicates whether this mailbox uses the database defaults for quota properties	Equals Does not equal
Use Database Retention Defaults	Indicates whether this mailbox uses the mailbox retention policy specified for the mailbox database that contains the mailbox.	Equals Does not equal
User Principal Name	Principal name for the mailbox user.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
When Changed	Date and time when mailbox was changed.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
When Changed UTC	UTC date and time when mailbox was changed.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
When Created	Date and time when mailbox was created.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
When Created UTC	UTC date and time when mailbox was created.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
When Mailbox Created	Date and time when mailbox was created.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
When Soft Deleted	Date and time when mailbox was soft deleted.	Equals Does not equal Is less than or equal to Is greater than or equal to Is less than Is greater than
Windows Email Address	Email address.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Windows Live ID(Live@edu only)	Windows Live ID associated with the mailbox. Note This property is available only in the Live@edu environment.	Equals Does not equal Contains Does not contain Matches pattern Does not match pattern Starts with Ends with
Needs To Suppress PII	Needs to Suppress PII (Personally Identifiable Information).	Equals Does not equal

Optional properties for the Get Mailbox activity

Element	Description	Valid values
Active Directory Password	The password to use in order to access Active Directory.	String
Active Directory User Name	Specifies the user name to use in order to access Active Directory.	String
ANR	A string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are as follows: CommonName (CN) DisplayName FirstName LastName Alias	String
Arbitration	Indicates whether the mailbox for which the command is executed is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval. Default is True, when selected.	True False
Archive	Indicates whether to return information about the recipient's archive mailbox. Default is True, when selected.	True False
Database	The database (GUID or database name) from which to get the mailbox. This property can't cannot be used in conjunction with activity filters.	String
Domain Controller	The fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.	String
Identity	Specifies the identity of the mailbox. This property can be one of the following value types: GUID Distinguished name (DN) Display name Domain\Account User principal name (UPN) LegacyExchangeDN SmtpAddress Alias	String
Ignore Default Scope	Indicates whether to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This setting allows the command to access Active Directory objects that aren't currently in the default scope. Using the Ignore Default Scope property introduces the following restrictions: Domain Controller property cannot be used. The command uses an appropriate global catalog server automatically. The DN for the Identity property cannot be used. Other forms of identification, such as alias or GUID, aren't accepted. The Organizational Unit and Identity properties cannot be used together. The Active Directory Name and Password properties cannot be used. Default is True, when selected.	True False
Mailbox Plan	Specifies the Get activity to return mailboxes associated with this mailbox plan. A mailbox plan specifies the permissions and features available to a mailbox user. The mailbox plan name you provide must be included in the service plan for the organization in which this mailbox belongs. This property is available for multi-tenant deployments. This property applies to objects in the cloud-based service. It isn't available for on-premises deployments.	String
Organization	Specifies the organization to retrieve mailboxes from. This property is available for multi-tenant deployments. It isn't available for on-premises deployments. This property does not accept wildcard characters. This property must be configured with the exact name of the organization.	String
Organizational Unit	This property specifies an organizational unit (OU) to which the Get results will be limited. When this property is used, only mailboxes in the specified container will be returned. Specification can be either the OU or the domain name. If the OU is used, the canonical name of the OU must not be specified.	String
Read From Domain Controller	Specifies that the user information is read from a domain controller in the user’s domain. When the recipient scope is set to include all recipients in the forest and this property is not configured, it is possible that the user information is read from a global catalog containing outdated information. If you use this property, multiple reads might be necessary to get the information. By default, the recipient scope is set to the domain that hosts your servers that run Exchange. Default is True, when selected.	True False
Recipient Type Details	This property specifies the type of recipients returned by the Get activity. Recipient types are divided into recipient types and subtypes. Each recipient type contains all common properties for all subtypes. For example, the type UserMailbox represents a user account in Active Directory that has an associated mailbox. Because there are several mailbox types, each mailbox type is identified by the RecipientTypeDetails property. For example, a conference room mailbox has RecipientTypeDetails set to RoomMailbox, whereas a user mailbox has RecipientTypeDetails set to UserMailbox. This property accepts the following values: RoomMailbox EquipmentMailbox LegacyMailbox LinkedMailbox UserMailbox DiscoveryMailbox SharedMailbox	String
Remote Archive	Specifies whether to disconnect the remote archive for this mailbox. A remote archive exists in a cloud-based service. When you use this property, you cannot also use the Archive property. Default is True, when selected.	True False
Result Size	Specifies the maximum number of results to return. To return all mailboxes that match the query, use “unlimited” for the value of this property. The default value is "unlimited".	String
Server	Specifies an individual server by which to limit the results. When you use this property, only mailboxes that reside on the specified server will be returned. Use the common name of the server that you want to specify.	String
Sort By	Specifies the attribute by which to sort the results. Results can only be sorted by one attribute at a time. The results are sorted in ascending order. Results can be sorted by the following attributes: Alias Display name Name	String

Published data for the Get Mailbox activity

Element	Description	Valid values
Accept Messages Only From	Mailbox users and mail-enabled contacts that can send email messages to this distribution group.	String
Accept Messages Only From DL Members	Distribution lists that are allowed to send email messages to this mailbox.	String
Accept Messages Only From Senders Or Members	Senders or members that are allowed to send email messages to this distribution group.	String
Address Book Policy	Address book policy for the mailbox.	String
Address List Membership	Address list IDs.	String
Admin Display Version	The version of the administrator's display.	String
Alias	Mail nickname of the user.	String
Antispam Bypass Enabled	Indicates whether anti-spam processing is used on the mailbox.	String
Arbitration Mailbox	ID of the arbitration mailbox.	String
Archive Database	ID of the archive database.	String
Archive Domain	Archive domain name.	String
Archive GUID	Unique archive identifier for the mailbox.	String
Archive Name	Name of the archive mailbox.	String
Archive Quota	Maximum size of the archive mailbox.	String
Archive Release	Archive release.	String
Archive State	Indicates the state of the mailbox archive. This can be one of the following values: HostedPending HostedProvisioned Local None OnPremise	String
Archive Status	The archive status (Active or None).	String
Archive Warning Quota	Mailbox size at which a warning message is sent.	String
Audit Admin	List of admin operations which are logged. This can be one of the following values: Copy Create FolderBind HardDelete MessageBind Move MoveToDeletedItems None SendAs SendOnBehalf SoftDelete Update	String
Audit Delegate	List of delegate options which are logged. This can be one of the following values: Copy Create FolderBind HardDelete MessageBind Move MoveToDeletedItems None SendAs SendOnBehalf SoftDelete Update	String
Audit Enabled	Indicates whether audit logging is enabled or disabled for the mailbox.	String
Audit Log Age Limit	Amount of time that the audit log entries are retained in the mailbox.	String
Audit Owner	List of owner operations that are logged. This can be one of the following values: Copy Create FolderBind HardDelete MessageBind Move MoveToDeletedItems None SendAs SendOnBehalf SoftDelete Update	String
Bypass Moderation From Senders Or Members	List of senders for whom moderation is to be bypassed.	String
Calendar Repair Disabled	Indicates whether calendar items in this mailbox are repaired by the Calendar Repair Assistant.	String
Calendar Version Store Disabled	Indicates whether changes to calendar items are logged.	String
Custom Attribute 1	Custom attribute value 1.	String
Custom Attribute 10	Custom attribute value 10.	String
Custom Attribute 11	Custom attribute value 11.	String
Custom Attribute 12	Custom attribute value 12.	String
Custom Attribute 13	Custom attribute value 13.	String
Custom Attribute 14	Custom attribute value 14.	String
Custom Attribute 15	Custom attribute value 15.	String
Custom Attribute 2	Custom attribute value 2.	String
Custom Attribute 3	Custom attribute value 3.	String
Custom Attribute 4	Custom attribute value 4.	String
Custom Attribute 5	Custom attribute value 5.	String
Custom Attribute 6	Custom attribute value 6.	String
Custom Attribute 7	Custom attribute value 7.	String
Custom Attribute 8	Custom attribute value 8.	String
Custom Attribute 9	Custom attribute value 9.	String
Database	Active Directory ID of the database that contains this mailbox.	String
Default Public Folder Mailbox	Default public folder mailbox.	String
Deliver To Mailbox And Forward	Contains the forwarding address of the mailbox.	String
Disabled Archive Database	Indicates whether the use of an Archive Database is disabled.	String
Disabled Archive GUID	Indicates whether the use of Archive GUIDs is disabled.	String
Display Name	The display name for the mailbox user.	String
Distinguished Name	The distinguished name for the object.	String
Downgrade High Priority Messages Enabled	Indicates whether high-priority messages sent to an X.400 mail system are changed to normal priority.	String
Email Address Policy Enabled	Indicates whether Email Address Policy is enabled.	String
Email Addresses	Collection of email addresses for the mailbox.	String
End Date For Retention Hold	Date and time that retention hold on messages in this mailbox expires.	DateTime
Exchange Environment	Indicates the type of Exchange environment where this activity will be executed.	String
Exchange GUID	Unique identifier of the Microsoft Exchange installation.	String
Exchange PowerShell Application	The application name segment of the connection URI.	String
Exchange Server Host	The connected Exchange server host machine.	String
Exchange Server Port	The connected Exchange server port.	String
Exchange User Account Control	This is a mask that is used to retrieve the user account control flags associated with this mailbox. This can be one of the following values: AccountDisabled CannotChangePassword DoNotExpirePassword DoNotRequirePreauthentication EncryptedTextPasswordAllowed HomeDirectoryRequired InterDomainTrustAccount Lockout MnsLogonAccount None NormalAccount NotDelegated PasswordExpired PasswordNotRequired Script ServerTrustAccount SmartCardRequired TemporaryDuplicateAccount TrustedForDelegation TrustedToAuthenticateForDelegation UseDesKeyOnly WorkstationTrustAccount	String
Exchange User Name	Username used to log on to Exchange server.	String
Exchange Version	Version of Microsoft Exchange that this object is associated with.	String
ExtensionCustomAttribute1	Extension custom attribute 1.	String
ExtensionCustomAttribute2	Extension custom attribute 2.	String
ExtensionCustomAttribute3	Extension custom attribute 3.	String
ExtensionCustomAttribute4	Extension custom attribute 4.	String
ExtensionCustomAttribute5	Extension custom attribute 5.	String
Extensions	List of extensions.	String
External Directory Object Id	External directory object ID.	String
External OOF Options	Options for sending Out of Office (OOF) messages to external senders. This property can be one of the following values: InternalOnly External	String
Forwarding Address	Forwarding address for this mailbox.	String
Forwarding SMTP Address	Forwarding SMTP address for this mailbox.	String
Grant Send On Behalf To	List of users with “send on behalf” rights for this mailbox.	String
GUID	Globally unique identifier for this object.	String
Has Picture	Indicates whether a picture has been associated with this mailbox.	String
Has Spoken Name	Indicates whether a spoken name has been associated with this mailbox.	String
Hidden From Address Lists Enabled	Indicates whether mailbox information is hidden from address book display.	String
Identity	Mailbox identity.	String
Immutable Id	Mailbox identifier that will never change.	String
Include In Garbage Collection	Include In Garbage Collection.	String
Is Linked	Indicates whether a mailbox is linked.	String
Is Machine To Person Text Messaging Enabled	Indicates whether the server can send text messages to a user.	String
Is Mailbox Enabled	Indicates whether the mailbox is enabled to process messages.	String
Is Person To Person Text Messaging Enabled	Indicates whether another mailbox user can send a text message to the owner of this mailbox.	String
Is Resource	Indicates whether this mailbox represents a resource, such as a conference room.	String
Is Shared	Indicates whether this mailbox is shared by more than one user.	String
Is Soft Deleted By Disable	Indicates whether the mailbox is soft deleted as a result of a disable operation.	String
Is Soft Deleted By Remove	Indicates whether the mailbox is soft deleted as a result of a remove operation.	String
Issue Warning Quota	Mailbox size at which a warning message is sent to the user.	String
Is Valid	Indicates whether the object is configured correctly.	String
Languages	Preferred languages for this mailbox.	String
Last Exchange Changed Time	Last exchange changed time.	DateTime
Legacy Exchange DN	Legacy exchange DN.	String
Linked Master Account	Master account for the linked mailbox.	String
Litigation Hold Date	Date and time when litigation hold was enabled.	DateTime
Litigation Hold Enabled	Indicates whether the mailbox is under a litigation hold.	String
Litigation Hold Owner	User who enabled the litigation hold.	String
Mail Tip	Mail tip.	String
Mail Tip Translations	Mail tip translation list.	String
Mailbox Count	Number of mailboxes returned by the Get Mailbox activity.	Number
Mailbox Move Batch Name	Name of the move batch that contains this mailbox.	String
Mailbox Move Flags	Flags for a mailbox move. This can be any of the following values: CrossOrg IntraOrg MoveOnlyArchiveMailbox MoveOnlyPrimaryMailbox None Offline Protected Pull Push RemoteLegacy Suspend SuspendWhenReadyToComplete	String
Mailbox Move Remote Host Name	Name of the remote host that is participating in the move.	String
Mailbox Move Source MDB	Active Directory identifier of the source database.	String
Mailbox Move Status	Indicates the status of a mailbox move. This can be one of the following values: AutoSuspended Completed CompletedWithWarning CompletionInProgress Failed InProgress None Queued Suspended	String
Mailbox Move Target MDB	Active Directory identifier of the database that the mailbox is being copied to.	String
Mailbox Plan	Mailbox plan for a mailbox.	String
Mailbox Release	Mailbox release.	String
Managed Folder Mailbox Policy	Messaging Records Management (MRM) policy for the mailbox.	String
Max Blocked Senders	Maximum number of senders that can be included in a blocked senders list.	Number
Max Receive Size	Received message size limit.	String
Max Safe Senders	Maximum number of senders that can be included in a safe senders list.	Integer
Max Send Size	Sent message size limit.	String
Message Tracking Read Status Enabled	Indicates whether detailed message tracking is enabled for the mailbox.	String
Microsoft Online Services ID	ID allowing access to Microsoft Online Services.	String
Moderated By	List of users responsible for moderating this mailbox.	String
Moderation Enabled	Indicates whether moderation is enabled for this mailbox.	String
Name	Name associated with this object.	String
Needs To Suppress PII	Needs to Suppress PII (Personally Identifiable Information).	String
Object Category	Active Directory object category for this mailbox.	String
Object Class	List of Active Directory object classes that apply to this mailbox.	String
Office	Microsoft Office attribute for the mailbox.	String
Offline Address Book	Offline address book associated with the mailbox.	String
Organization ID	Organization for this mailbox.	String
Organizational Unit	Organizational unit for this mailbox.	String
Originating Server	Originating server.	String
Partner Object ID	GUID for partner object ID.	String
Persisted Capabilities	Persisted capability list.	String
Policies Excluded	List of policies that are excluded.	String
Policies Included	List of policies that are included.	String
Primary SMTP Address	Primary SMTP address for the mailbox.	String
Prohibit Send Quota	Mailbox size at which the user is prohibited from sending email.	String
Prohibit Send Receive Quota	Mailbox size at which the user is prohibited from sending or receiving email.	String
Protocol Settings	Protocols used by the mailbox.	String
Query Base DN	This property is used to control which address list a user can access through Outlook Web App.	String
Query Base DN Restriction Enabled	Indicates whether the user can search and view other mailboxes in their organization.	String
Recipient Limits	Maximum number of recipients per message that this mailbox can send to.	String
Recipient Type	Recipient type. This can be one of the following values: Computer Contact DynamicDistributionGroup Group Invalid MailContact MailNonUniversalGroup MailUniversalDistributionGroup MailUniversalSecurityGroup MailUser MicrosoftExchange PublicDatabase PublicFolder SystemAttendantMailbox SystemMailbox User UserMailbox	String
Recipient Type Details	Recipient type details. This can be one of the following values: AllUniqueRecipientTypes ArbitrationMailbox Computer Contact DisabledUser DiscoveryMailbox DynamicDistributionGroup EquipmentMailbox LegacyMailbox LinkedMailbox LinkedUser MailboxPlan MailContact MailForestContact MailNonUniversalGroup MailUniversalDistributionGroup MailUniversalSecurityGroup MailUser MicrosoftExchange None NonUniversalGroup PublicFolder RemoteEquipmentMailbox RemoteRoomMailbox RemoteSharedMailbox RemoteUserMailbox RoleGroup RoomList RoomMailbox SharedMailbox SystemAttendantMailbox SystemMailbox UniversalDistributionGroup UniversalSecurityGroup User UserMailbox	String
Reconciliation Id	Reconciliation ID.	String
Recoverable Items Quota	Size limit for the Recovery Items folder.	String
Recoverable Items Warning Quota	Size at which a warning is sent stating that the Recovery Items folder is reaching its limit.	String
Reject Messages From	Rejected sender IDs list.	String
Reject Messages From DL Members	Rejected sender IDs list.	String
Reject Messages From Senders Or Members	Rejected sender IDs list.	String
Remote Account Policy	Remote account policy ID.	String
Remote Recipient Type	Remote recipient type. This can be one of the following values: DeprovisionArchive DeprovisionMailbox EquipmentMailbox Migrated None ProvisionArchive ProvisionMailbox RoomMailbox SharedMailbox	String
Require Sender Authentication Enabled	Indicates whether sender authentication is required.	String
Resource Capacity	Capacity of a resource mailbox.	Number
Resource Custom	List containing additional information about a resource.	String
Resource Type	Type of a resource.	String
Retain Deleted Items For	Length of time to keep deleted items.	String
Retain Deleted Items Until Backup	Indicates whether deleted items should be kept until the database is backed up.	String
Retention Comment	Comment displayed regarding the user’s retention hold status.	String
Retention Hold Enabled	Indicates whether the contents of the mailbox are subject to retention.	String
Retention Policy	Retention policy that is applied to the mailbox.	String
Retention URL	URL for a webpage with details about the organization’s message retention policies.	String
Role Assignment Policy	Management role that was assigned to the mailbox when it was created or enabled.	String
Rules Quota	Size limit for rules.	String
Sam Account Name	User name for use with earlier operating systems.	String
SCL Delete Enabled	Indicates whether messages that meet the spam confidence level (SCL) are deleted.	String
SCL Delete Threshold	Spam confidence level (SCL) at which messages are considered spam and are to be deleted.	Number
SCL Junk Enabled	Indicates whether messages that meet the spam confidence level (SCL) are moved to the Junk E-Mail folder.	String
SCL Junk Threshold	Spam confidence level (SCL) at which messages are considered spam and are to be moved to the Junk E-Mail folder.	Number
SCL Quarantine Enabled	Indicates whether messages that meet the spam confidence level (SCL) are quarantined.	String
SCL Quarantine Threshold	Spam confidence level (SCL) at which messages are considered spam and are to be moved to the quarantine folder.	Number
SCL Reject Enabled	Indicates whether messages that meet the spam confidence level (SCL) are rejected.	String
SCL Reject Threshold	Spam confidence level (SCL) at which messages are considered spam and are to be rejected.	Number
SKU Assigned	This parameter is reserved for internal Microsoft use.	String
Send Moderation Notifications	Moderation notifications for this mailbox. This can be one of the following values: Always Internal Never	String
Server Legacy DN	Legacy domain name for the server.	String
Server Name	Name of the server.	String
Sharing Policy	Sharing policy applied to the mailbox.	String
Simple Display Name	Simple display name.	String
Single Item Recovery Enabled	Indicates whether the Recovery Items folder can be purged.	Boolean
Skip CA Check	Indicates whether the client skips validation that the server certificate is signed by a trusted certification authority (CA) when connecting over Hypertext Transfer Protocol (HTTP) over Secure Sockets Layer (SSL).	String
Skip CN Check	Indicates whether the client skips validation that the certificate common name (CN) of the server matches the hostname of the server.	String
Skip Revocation Check	Indicates whether the connection skips validation of the revocation status of the server certificate.	String
Start Date For Retention Hold	Date and time that a retention hold on messages in this mailbox begins.	DateTime
Throttling Policy	Identifier for the throttling policy applied to the mailbox.	String
UM DTMF Map	UM DTMF Map.	String
UM Enabled	Indicates whether Unified Messaging (UM) is enabled for this mailbox.	String
Usage Location	Country name.	String
Use Database Quota Defaults	Indicates whether this mailbox uses the database defaults for quota properties.	String
Use Database Retention Defaults	Indicates whether this mailbox uses the mailbox retention policy specified for the mailbox database that contains the mailbox.	String
Use SSL	Indicates whether SSL encryption is used.	String
User Principal Name	Principal name for the mailbox user.	String
When Changed	Date and time when mailbox was changed.	DateTime
When Changed UTC	UTC date and time when mailbox was changed.	DateTime
When Created	Date and time when mailbox was created.	DateTime
When Created UTC	UTC date and time when mailbox was created.	DateTime
When Mailbox Created	Date and time when mailbox was created.	DateTime
When Soft Deleted	Date and time when mailbox was soft deleted.	DateTime
Windows Email Address	Email address.	String
Windows Live ID(Live@edu only)	Windows Live ID associated with the mailbox. Note This property is available only in the Live@edu environment.	String

Get Mailbox

Required properties for the Get Mailbox activity

Filters for the Get Mailbox activity

Optional properties for the Get Mailbox activity

Published data for the Get Mailbox activity

See Also

Other Resources

Additional resources