API Reference
EmailStorePstMutationTransaction
Stages folder and item changes against an existing Unicode PST and commits them as a verified atomic rewrite. Disposing an uncommitted transaction leaves the source byte-for-byte unchanged.
Inheritance
- Object
- EmailStorePstMutationTransaction
Usage
Explore 1 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
Methods
public String AddItem(String folderId, EmailDocument document, Boolean isAssociated = false, CancellationToken cancellationToken = default) #StringAdds an item and returns its transaction-local identifier.
Parameters
- folderId System.String
- document OfficeIMO.Email.EmailDocument
- isAssociated System.Boolean = false
- cancellationToken System.Threading.CancellationToken = default
public EmailStorePstMutationReport Commit(CancellationToken cancellationToken = default) #EmailStorePstMutationReportWrites and verifies a staged Unicode PST, optionally commits a byte-for-byte backup, and atomically replaces the original. Any failure before the final commit leaves the original unchanged.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public async Task<EmailStorePstMutationReport> CommitAsync(CancellationToken cancellationToken = default) #Task<EmailStorePstMutationReport>Writes and verifies a staged Unicode PST, asynchronously flushes the staged artifact and optional byte-for-byte backup, then atomically replaces the original. Ordered PST serialization and semantic comparison remain synchronous stateful phases and are not hidden in a worker-thread wrapper.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public EmailStorePstFolderCopyResult CopyFolder(String folderId, String destinationParentFolderId, Boolean includeDescendants = true, EmailStorePstCopyConflictPolicy conflictPolicy = Fail, CancellationToken cancellationToken = default) #EmailStorePstFolderCopyResultCopies a source folder, optionally including its complete subtree and items.
Parameters
- folderId System.String
- destinationParentFolderId System.String
- includeDescendants System.Boolean = true
- conflictPolicy OfficeIMO.Email.Store.EmailStorePstCopyConflictPolicy = Fail
- cancellationToken System.Threading.CancellationToken = default
public String CopyItem(String itemId, String destinationFolderId, Boolean? isAssociated = null, CancellationToken cancellationToken = default) #StringCopies an existing source item into another folder and returns a transaction-local identifier.
Parameters
- itemId System.String
- destinationFolderId System.String
- isAssociated System.Boolean? = null
- cancellationToken System.Threading.CancellationToken = default
public String CreateFolder(String name, String? parentFolderId = null, String? containerClass = null) #StringCreates a folder and returns its transaction-local identifier.
Parameters
- name System.String
- parentFolderId System.String? = null
- containerClass System.String? = null
public Void DeleteFolder(String folderId, Boolean recursive = false, CancellationToken cancellationToken = default) #VoidDeletes a non-mandatory folder. A non-empty folder requires recursive. Recursive deletion includes active descendants and their items.
Parameters
- folderId System.String
- recursive System.Boolean = false
- cancellationToken System.Threading.CancellationToken = default
public Void DeleteItem(String itemId, CancellationToken cancellationToken = default) #VoidDeletes an existing or newly staged item.
Parameters
- itemId System.String
- cancellationToken System.Threading.CancellationToken = default
public Void Dispose() #VoidPerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public EmailStorePstMutationPlan DryRun(CancellationToken cancellationToken = default) #EmailStorePstMutationPlanReturns a value-free dry run of every effective staged operation without writing an artifact.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public IEnumerable<EmailStoreItemReference> EnumerateItems() #IEnumerable<EmailStoreItemReference>Enumerates active source item references after staged deletes.
public Void MoveFolder(String folderId, String newParentFolderId) #VoidMoves a non-mandatory folder below another active folder.
Parameters
- folderId System.String
- newParentFolderId System.String
public Void MoveItem(String itemId, String destinationFolderId, CancellationToken cancellationToken = default) #VoidMoves an existing or newly staged item to another active folder.
Parameters
- itemId System.String
- destinationFolderId System.String
- cancellationToken System.Threading.CancellationToken = default
public static EmailStorePstMutationTransaction Open(String path, EmailStorePstMutationOptions? options = null, CancellationToken cancellationToken = default) #EmailStorePstMutationTransactionOpens and locks an existing Unicode PST for one mutation transaction.
Parameters
- path System.String
- options OfficeIMO.Email.Store.EmailStorePstMutationOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public Void PatchItem(String itemId, EmailStoreItemPatch patch, CancellationToken cancellationToken = default) #VoidApplies one reusable typed patch to an item.
Parameters
- itemId System.String
- patch OfficeIMO.Email.Store.EmailStoreItemPatch
- cancellationToken System.Threading.CancellationToken = default
public Void PatchItemAttachments(String itemId, EmailAttachmentPatch patch, CancellationToken cancellationToken = default) #VoidApplies ordered, bounds-checked attachment changes to an item.
Parameters
- itemId System.String
- patch OfficeIMO.Email.EmailAttachmentPatch
- cancellationToken System.Threading.CancellationToken = default
public Void PatchItemProperties(String itemId, MapiPropertyPatch patch, CancellationToken cancellationToken = default) #VoidApplies exact typed MAPI property changes after normal semantic projection when the item is rewritten.
Parameters
- itemId System.String
- patch OfficeIMO.Email.MapiPropertyPatch
- cancellationToken System.Threading.CancellationToken = default
public EmailStorePstMutationSelectionReport PatchItems(EmailStoreTableQuery query, EmailStoreItemPatch patch, CancellationToken cancellationToken = default) #EmailStorePstMutationSelectionReportApplies one reusable typed patch to every row selected by a bounded table query. Selection completes before any item is changed, and a scan-limit result is rejected rather than partially mutating the transaction.
Parameters
- query OfficeIMO.Email.Store.EmailStoreTableQuery
- patch OfficeIMO.Email.Store.EmailStoreItemPatch
- cancellationToken System.Threading.CancellationToken = default
public EmailStoreItem ReadItem(String itemId, CancellationToken cancellationToken = default) #EmailStoreItemReads one source item by its stable source identifier.
Parameters
- itemId System.String
- cancellationToken System.Threading.CancellationToken = default
public Void RenameFolder(String folderId, String name) #VoidChanges a non-mandatory folder's display name.
Parameters
- folderId System.String
- name System.String
public Void ReplaceItem(String itemId, EmailDocument document, CancellationToken cancellationToken = default) #VoidReplaces the semantic document for an existing or newly staged item.
Parameters
- itemId System.String
- document OfficeIMO.Email.EmailDocument
- cancellationToken System.Threading.CancellationToken = default
public Void SetItemAssociated(String itemId, Boolean isAssociated, CancellationToken cancellationToken = default) #VoidMoves an item between normal contents and folder-associated contents.
Parameters
- itemId System.String
- isAssociated System.Boolean
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String SourcePath { get; } #Full path of the PST that will be replaced only after a successful commit.
public String RootFolderId { get; } #Source folder identifier used when a new folder omits its parent.
public IReadOnlyList<EmailStorePstMutationFolder> Folders { get; } #Current staged folder view. Transaction-local identifiers remain stable until commit.