lib/Core/AdNoctem.Substrate.Interop.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>AdNoctem.Substrate.Interop</name> </assembly> <members> <member name="T:AdNoctem.Substrate.Interop.ComManager"> <summary>Creates and scopes COM objects with explicit lifetime and apartment requirements.</summary> </member> <member name="M:AdNoctem.Substrate.Interop.ComManager.ReleaseReference(System.Object)"> <summary>Releases one reference on an object the caller owns. Never final-releases a shared RCW. Returns null for null/non-COM objects. Call on the owning apartment; failures propagate.</summary> </member> <member name="M:AdNoctem.Substrate.Interop.ComManager.CollectAndWaitForFinalizers"> <summary>Explicit process-wide collection and finalizer wait. May block; never invoked implicitly by another library operation.</summary> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookManager"> <summary>Classic Outlook automation. COM calls remain synchronous and apartment-bound; cancellation is checked between provider calls.</summary> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.FindRepairTools(System.Collections.Generic.IEnumerable{AdNoctem.Substrate.IO.FileSystemPath},System.Threading.CancellationToken)"> <remarks>Inspects installed ScanPST and explicit search directories. Does not execute candidates or change process PATH.</remarks> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.GetStandardFolderIdentities(System.Object,System.Object,System.Threading.CancellationToken,System.Action{AdNoctem.Substrate.Interop.OutlookFolderIdentity})"> <summary>Reads standard-folder identities without creating folders. Individual provider failures remain identity records.</summary> <remarks>Non-resolved records are sent to diagnostic when supplied. A failed lookup is not proof of absence. Store access, invalid returned identities and cancellation still fail the operation. No COM references escape.</remarks> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.ParseAdditionalFolderEntryIds(System.Byte[])"> <summary>Parses bounded little-endian PersistData/PersistElement records without accessing Outlook.</summary> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.GetFolderPlan(System.Object,System.Object,System.String,System.Boolean,System.Collections.Generic.IEnumerable{AdNoctem.Substrate.Interop.OutlookFolderKind},System.Collections.Generic.IEnumerable{System.String},System.Action{System.String},System.Threading.CancellationToken,System.Action{System.String})"> <summary>Collects a read-only folder plan. Null requires Inbox by identity, empty selects the root, otherwise an exact relative path.</summary> <remarks>Uncertain excluded identities cause potentially matching branches to be skipped with an IncompleteIdentity reason and a diagnostic. Resolved identities and item types constrain classification; names are never used to guess standard kinds. No COM references escape. Cancellation and source inspection failures discard partial results. Plans do not authorize mutation.</remarks> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.GetStoreRoot(System.Object,System.String,System.Action{System.String},System.Threading.CancellationToken)"> <returns>A caller-owned root reference. The namespace is borrowed.</returns> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.AddStoreRoot(System.Object,AdNoctem.Substrate.IO.FileSystemPath,System.Threading.CancellationToken)"> <summary>Explicitly attaches or creates a Unicode PST. Use OpenPstStore when creation must be forbidden.</summary> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.GetSubFolder(System.Object,System.String,System.Boolean,System.Threading.CancellationToken)"> <returns>A caller-owned child reference, or null when absent and creation was not requested.</returns> </member> <member name="F:AdNoctem.Substrate.Interop.OutlookManager.DefaultInboxFolder"> <summary>olFolderInbox. The default Inbox belongs to the store new mail is delivered into.</summary> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.GetProfileInventory(System.Object,System.Threading.CancellationToken)"> <summary> Reads every account and data file of the connected profile without enumerating a folder or touching an item. The default Inbox is obtained to identify the profile's delivery store and is not read any further. Standard folder identity is unavailable for Exchange and OST stores below Outlook 2010; this stays readable where it is not. </summary> <returns>Plain records. No COM reference is retained and the namespace stays borrowed.</returns> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookManager.DeliveryFacts"> <summary>The store new mail is delivered into by default, used where an account cannot report its own.</summary> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.ReadDefaultDelivery(System.Object,System.Collections.Generic.List{AdNoctem.Substrate.Interop.OutlookManager.StoreFacts})"> <summary> Resolves the profile's default delivery store through the Inbox it owns. MAPIFolder.StoreID has been readable since Outlook 2000, so this answers on every client the fleet runs, including those with no Account.DeliveryStore. </summary> </member> <member name="M:AdNoctem.Substrate.Interop.OutlookManager.OpenPstStore(System.Object,AdNoctem.Substrate.IO.FileSystemPath,System.Boolean,System.Threading.CancellationToken)"> <summary>Returns an ownership-aware context for an existing writable local PST, or null if attachment is needed but disallowed.</summary> <remarks>Rechecks before attaching; Outlook has no atomic existing-only open. Callers must prevent concurrent file/profile changes. Rejects network/reparse paths; short names are expanded but hard-link aliases are not detected. Cancellation after attachment cleans up.</remarks> </member> <member name="F:AdNoctem.Substrate.Interop.OutlookFolderIdentityState.Absent"> <summary>The provider reports that the folder does not exist.</summary> </member> <member name="F:AdNoctem.Substrate.Interop.OutlookFolderIdentityState.Unavailable"> <summary>The provider does not support this lookup; absence is not established.</summary> </member> <member name="F:AdNoctem.Substrate.Interop.OutlookFolderIdentityState.Unresolved"> <summary>The lookup failed or lacks identity evidence; absence is not established.</summary> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookSession"> <summary>Owns acquired application/namespace references. Dispose on the creating thread; never quits Outlook or logs off a shared session.</summary> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookAccountKind"> <summary>OlAccountType. Unknown preserves an unrecognized provider value instead of inferring a behavior from it.</summary> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookDataFileFormat"> <summary>Backing file shape of a store. None describes a store with no local file, such as Exchange in online mode.</summary> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookDeliveryStoreSource"> <summary> Where an account's delivery store came from. Account.DeliveryStore was added in Outlook 2010; below it the profile default is the only documented answer, so a report has to say which of the two it is holding. </summary> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookAccountInfo"> <summary>One account in the current profile and the store it delivers new mail into.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookAccountInfo.AccountType"> <summary>Raw OlAccountType, retained so an unmapped provider value stays reportable.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookAccountInfo.KindName"> <summary>Provider label as Outlook's own account list names it, or the raw value when unmapped.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookAccountInfo.DeliveryStoreSource"> <summary>Which route established the delivery store: the account, the profile default, or neither.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookAccountInfo.IsDeliveryStoreInferred"> <summary> The store was not read from the account. It is the profile default, which is where an account delivers unless it carries an override, and a client that cannot report delivery cannot report the override either. </summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookAccountInfo.Evidence"> <summary>Provider errors met while reading this account. Empty when every property was readable.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookAccountInfo.IsServerSynchronized"> <summary>Folders mirror server state, so local removals can reach the server and other clients.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookAccountInfo.MayDeferItemBodies"> <summary> The provider can leave an item as a header-only stub. A file extension cannot establish this: Outlook 2007 backs an IMAP account with a PST, so the owning account is the only reliable signal that bodies may still be on the server. </summary> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookStoreInfo"> <summary>One data file or mailbox in the current profile, with the accounts that depend on it.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookStoreInfo.DataFileFormatName"> <summary>Backing file shape as the Outlook data file dialog names it: PST, OST, None, or Other.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookStoreInfo.ExchangeStoreType"> <summary>Raw OlExchangeStoreType, or -1 when the provider did not report one.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookStoreInfo.SizeBytes"> <summary>File length in bytes, or null when the file is absent or unreadable. Outlook holding it open does not prevent the read.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookStoreInfo.DeliveredFrom"> <summary>Display names of the accounts that deliver new mail here. Correlated by StoreID, because display names repeat.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookStoreInfo.IsExchangeBacked"> <summary>olNotExchange (3) is the only value that proves a store is not served by Exchange. An unreported type counts as Exchange-backed.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookStoreInfo.IsSynchronized"> <summary>Changes here can reach a server and other clients.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookStoreInfo.MayContainHeaderOnlyItems"> <summary>Items here can be header-only stubs, so a transfer must verify each body first.</summary> </member> <member name="P:AdNoctem.Substrate.Interop.OutlookStoreInfo.Evidence"> <summary>Why the store carries the classification above, including any provider error behind it.</summary> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookProfileInventory"> <summary>Accounts and stores of one profile, read together so each store can state what depends on it.</summary> </member> <member name="T:AdNoctem.Substrate.Interop.OutlookPstStore"> <summary>Owns one root reference and, when indicated, the attachment created by OpenPstStore. The namespace is borrowed.</summary> <remarks>Dispose on the creating thread after releasing all child references. Never serialize or share a lifetime across processes. Overlapping consumers are not reference-counted. Disposal never deletes a PST or quits Outlook.</remarks> </member> </members> </doc> |