IdLE.Step.Mailbox.GetInfo

Generated file. Do not edit by hand. Source: tools/Generate-IdleStepReference.ps1

Summary

• Step Type: IdLE.Step.Mailbox.GetInfo
• Module: IdLE.Steps.Mailbox
• Implementation: Invoke-IdleStepMailboxGetInfo
• Idempotent: Unknown
• Required Capabilities: IdLE.Mailbox.Info.Read

Synopsis

Retrieves mailbox details and returns a structured report.

Description

The engine passes the provider resolved from With.Provider (default 'ExchangeOnline') as -Provider. The provider implements a GetMailbox method with the signature (IdentityKey, AuthSession) and return a mailbox object.

The step is read-only and returns Changed = $false.

Authentication is handled by the engine: without With.AuthSessionName the session is named after the provider alias (e.g. 'ExchangeOnline'); With.AuthSessionOptions is passed to the broker.

Inputs (With.*)

Validated at plan time against the step's WithSchema (see Step metadata contract).

Key	Type	Required	Default	Notes
IdentityKey	String	Yes
AuthSessionName	String	No	provider alias	Auth session routing key for the AuthSessionBroker.
AuthSessionOptions	Hashtable	No		Data-only options passed to the AuthSessionBroker.
Provider	String	No	ExchangeOnline	Provider alias in Providers.

Outputs (State.*)

Published under State.<StepName>.<Key> for later steps (Precondition and With templates); validated against the step's StateSchema (see Step State).

Key	Type	Always set	Notes
Mailbox	Any	Yes

Example

# In workflow definition:
@{
    Name = 'Get mailbox info'
    Type = 'IdLE.Step.Mailbox.GetInfo'
    With = @{
        Provider      = 'ExchangeOnline'
        IdentityKey   = 'user@contoso.com'
    }
}

See Also

• Capabilities Reference - Details on required capabilities
• Providers - Available provider implementations