PyIMAPIProp.md

PyIMAPIProp

PyIMAPIProp Object

An COM interface to MAPI

Derived from PyIUnknown

Methods

• GetProps

  Returns a list of property values. 

• DeleteProps

  Deletes a set of properties. 

• SetProps

  Sets a set of properties. 

• CopyTo

  Copies an object to another 

• CopyProps

  Copies a set of properties to another object 

• OpenProperty

  Returns an interface object to be used to access a property. 

• GetIDsFromNames

  Determines property IDs 

• GetNamesFromIDs

  Determines property names 

• GetLastError

  Returns the last error code for the object. 

• SaveChanges

  Saves pending changes to the object 

• GetPropList

  Gets a list of properties 

PyIMAPIProp.CopyProps

int, [problems, ] = CopyProps(propTags, uiFlags

, progress

, resultIID

, dest

, flags

) Copies a set of properties to another object

Parameters

• propTags : PySPropTagArray

  The property tags to copy

• uiFlags : int

  Flags for the progress object

• progress : None

  Reserved - must pass None

• resultIID : PyIID

  IID of the destination object

• dest : PyIMAPIProp

  The destination object

• flags : int

  flags

PyIMAPIProp.CopyTo

int, [problems, ] = CopyTo(IIDExcludeList, propTags

, uiFlags

, progress

, resultIID

, dest

, flags

) Copies an object to another

Parameters

• IIDExcludeList : [PyIID, ]

  A sequence of IIDs to exclude.

• propTags : PySPropTagArray

  The property tags to copy

• uiFlags : int

  Flags for the progress object

• progress : None

  Reserved - must pass None

• resultIID : PyIID

  IID of the destination object

• dest : PyIMAPIProp

  The destination object

• flags : int

  flags

PyIMAPIProp.DeleteProps

int, [problems, ] = DeleteProps(propList) Deletes a set of properties.

Parameters

• propList : PySPropTagArray

  The list of properties

PyIMAPIProp.GetIDsFromNames

PySPropTagArray = GetIDsFromNames(nameIds, flags

) Determines property IDs

Parameters

• nameIds : PyMAPINAMEIDArray

  Sequence of name ids

• flags=0 : int

PyIMAPIProp.GetLastError

MAPIERROR

= GetLastError(hr, flags

) Returns the last error code for the object.

Parameters

• hr : int

  Contains the error code generated in the previous method call.

• flags : int

  Indicates for format for the output.

PyIMAPIProp.GetNamesFromIDs

HRESULT, PySPropTagArray, PyMAPINAMEIDArray = GetNamesFromIDs(propTags, propSetGuid

, flags

) Determines property names

Parameters

• propTags : PySPropTagArray

  Sequence of property tags, or None

• propSetGuid=None : PyIID

  a globally unique identifier, identifying a property set, or None

• flags=0 : int

PyIMAPIProp.GetPropList

PySPropTagArray = GetPropList(flags) Gets a list of properties

Parameters

• flags : int

  flags

PyIMAPIProp.GetProps

int, [items, ] = GetProps(propList, flags

) Returns a list of property values.

Parameters

• propList : PySPropTagArray

  The list of properties

• flags=0 : int

PyIMAPIProp.OpenProperty

PyIUnknown = OpenProperty(propTag, iid

, interfaceOptions

, flags

) Returns an interface object to be used to access a property.

Parameters

• propTag : ULONG

  The property tag to open

• iid : PyIID

  The IID of the resulting interface.

• interfaceOptions : int

  Data that relates to the interface identified by the lpiid parameter.

• flags : int

  flags

PyIMAPIProp.SaveChanges

SaveChanges(flags) Saves pending changes to the object

Parameters

• flags : int

  flags

PyIMAPIProp.SetProps

int, [problems, ] = SetProps(propList) Sets a set of properties.

Parameters

• propList : [PySPropValue, ]

  The list of properties