Skip to content

Latest commit

 

History

History
155 lines (76 loc) · 3.52 KB

PyIMsgStore.md

File metadata and controls

155 lines (76 loc) · 3.52 KB

PyIMsgStore

PyIMsgStore Object

An COM interface to MAPI

Derived from PyIMAPIProp

Methods

  • OpenEntry

    Opens a folder or message and returns an interface object for further access. 

  • GetReceiveFolder

    Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store. 

  • GetReceiveFolderTable

    provides access to the receive folder table, a table that includes information about all of the receive folders for the message store. 

  • CompareEntryIDs

    Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object 

  • GetLastError

    Returns the last error associated with this object 

  • AbortSubmit

    Attempts to remove a message from the outgoing queue. 

PyIMsgStore.AbortSubmit

int = AbortSubmit(entryId, flags

) Attempts to remove a message from the outgoing queue.

Parameters

  • entryId : string

    The entry ID of the item to be aborted.

  • flags=0 : int

    Reserved - must be zero.

PyIMsgStore.CompareEntryIDs

int = CompareEntryIDs(entryId, entryId

, flags

) Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object

Parameters

  • entryId : string

    The first entry ID to be compared

  • entryId : string

    The second entry ID to be compared

  • flags=0 : int

    Reserved - must be zero.

Return Value

The result is set to TRUE if the two entry identifiers refer to the same object, and FALSE otherwise.

PyIMsgStore.GetLastError

PyMAPIError

= GetLastError(hr, flags

) Returns the last error associated with this object

Parameters

  • hr : int

    The HRESULT

  • flags : int

PyIMsgStore.GetReceiveFolder

PyIID, string = GetReceiveFolder(, flags

) Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store.

Parameters

  • : string
Message class that is associated with a receive folder\. If thid parameter is set to None or an empty string, GetReceiveFolder returns the default receive folder for the message store\.
  • flags : int

PyIMsgStore.GetReceiveFolderTable

PyIMAPITable = GetReceiveFolderTable(flags) provides access to the receive folder table, a table that includes information about all of the receive folders for the message store.

Parameters

  • flags : int

    Bitmask of flags that controls table access

PyIMsgStore.OpenEntry

PyIInterface

= OpenEntry(entryId, iid

, flags

) Opens a folder or message and returns an interface object for further access.

Parameters

  • entryId : string

    The entryID of the object

  • iid : PyIID

    The IID of the object to return, or None for the default IID

  • flags : int

    Bitmask of flags that controls how the object is opened.