API Reference
EmailStorePstWriter
Incrementally creates a new dependency-free Unicode PST. Source PST/OST files are never modified.
Inheritance
- Object
- EmailStorePstWriter
Usage
Explore 2 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 2
- Method EmailStorePstWriter.Create
- Method EmailStorePstWriter.Resume
Methods
public Void Abandon() #VoidMarks this incomplete writer for cleanup instead of checkpoint retention on disposal.
public String AddFolder(String name, String? parentFolderId = null, String? containerClass = null) #StringAdds a folder. A null parent places it under EmailStorePstWriter.RootFolderId.
Parameters
- name System.String
- parentFolderId System.String? = null
- containerClass System.String? = null
public String AddFolder(String name, EmailStoreSpecialFolderKind specialFolderKind, String? parentFolderId = null, String? containerClass = null) #StringAdds a folder with a supported standard Outlook default-folder identity.
Parameters
- name System.String
- specialFolderKind OfficeIMO.Email.Store.EmailStoreSpecialFolderKind
- parentFolderId System.String? = null
- containerClass System.String? = null
public String AddItem(String folderId, EmailDocument document, Boolean isAssociated = false, CancellationToken cancellationToken = default) #StringWrites one message or typed Outlook item into a folder.
Parameters
- folderId System.String
- document OfficeIMO.Email.EmailDocument
- isAssociated System.Boolean = false
- cancellationToken System.Threading.CancellationToken = default
public static Boolean CanAssignSpecialFolderKind(EmailStoreSpecialFolderKind specialFolderKind) #BooleanReturns whether a user-created folder can receive this standard EntryID-backed role.
Parameters
- specialFolderKind OfficeIMO.Email.Store.EmailStoreSpecialFolderKind
public Void Checkpoint() #VoidFlushes all working data and atomically commits a resumable integrity-checked checkpoint.
public Void Checkpoint(Byte[]? applicationState) #VoidFlushes writer data and atomically commits bounded caller state in the same integrity-checked checkpoint.
Parameters
- applicationState System.Byte[]?
public EmailStorePstWriteReport Complete(CancellationToken cancellationToken = default) #EmailStorePstWriteReportFinalizes indexes and allocation maps, then atomically commits the PST.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public static EmailStorePstWriter Create(String destinationPath, EmailStorePstWriterOptions? options = null) #EmailStorePstWriterCreates a writer targeting a new PST path.
Parameters
- destinationPath System.String
- options OfficeIMO.Email.Store.EmailStorePstWriterOptions? = null
public static Void DeleteCheckpoint(String checkpointPath) #VoidDeletes a checkpoint and its exact writer-owned working files. A missing checkpoint is a no-op.
Parameters
- checkpointPath System.String
public Void Dispose() #VoidPerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public static EmailStorePstWriter Resume(String checkpointPath, IProgress<EmailStorePstWriteProgress>? progress = null) #EmailStorePstWriterResumes a writer from its last integrity-checked durable checkpoint.
Parameters
- checkpointPath System.String
- progress System.IProgress<OfficeIMO.Email.Store.EmailStorePstWriteProgress>? = null
public static EmailStorePstWriter Resume(String checkpointPath, out Byte[]? applicationState, IProgress<EmailStorePstWriteProgress>? progress = null) #EmailStorePstWriterResumes a writer and returns caller state committed atomically with the writer checkpoint.
Parameters
- checkpointPath System.String
- applicationState System.Byte[]?
- progress System.IProgress<OfficeIMO.Email.Store.EmailStorePstWriteProgress>? = null
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?