PyIMAPIFolder.md

PyIMAPIFolder

PyIMAPIFolder Object

An COM interface to MAPI

Derived from PyIMAPIProp

Methods

• GetLastError

  Returns the last error associated with this object 

• CreateFolder

  Creates a folder object. 

• CreateMessage

  Creates a message in a folder 

• CopyMessages

  Copies the specified messages 

• DeleteFolder

  Deletes a subfolder. 

• DeleteMessages

  Deletes the specified messages. 

• EmptyFolder

  deletes all messages and subfolders from a folder without deleting the folder itself. 

PyIMAPIFolder.CopyMessages

CopyMessages(msgs, iid, folder, ulUIParam, progress, flags) Copies the specified messages

Parameters

• msgs : PySBinaryArray

• iid : PyIID

  IID representing the interface to be used to access the destination folder. Should usually be None.

• folder : PyIMAPIFolder

  The destination folder

• ulUIParam : long

  Handle of the parent window for any dialog boxes or windows this method displays.

• progress : PyIMAPIProgress

  A progress object, or None

• flags : int

  A bitmask of

PyIMAPIFolder.CreateFolder

PyIMAPIFolder = CreateFolder(folderType, folderName

, folderComment

, iid

, flags

) Creates a folder object.

Parameters

• folderType : int

  The type of folder to create

• folderName : string

  The name of the folder.

• folderComment : string

  A comment for the folder or None

• iid : PyIID

  The IID of the object to return. Should usually be None.

• flags : int

PyIMAPIFolder.CreateMessage

PyIMessage = CreateMessage(iid, flags

) Creates a message in a folder

Parameters

• iid : PyIID

  The IID of the object to return. Should usually be None.

• flags : int

PyIMAPIFolder.DeleteFolder

DeleteFolder(entryId, uiParam, progress) Deletes a subfolder.

Parameters

• entryId : string

  The EntryID of the subfolder to delete.

• uiParam : long

  Handle of the parent window of the progress indicator.

• progress : PyIMAPIProgress

  A progress object, or None

PyIMAPIFolder.DeleteMessages

DeleteMessages(msgs, uiParam, progress, flags) Deletes the specified messages.

Parameters

• msgs : PySBinaryArray

• uiParam : int

  A HWND for the progress

• progress : PyIMAPIProgress

  A progress object, or None

• flags : int

PyIMAPIFolder.EmptyFolder

EmptyFolder(uiParam, progress, flags) deletes all messages and subfolders from a folder without deleting the folder itself.

Parameters

• uiParam : int

  A HWND for the progress

• progress : PyIMAPIProgress

  A progress object, or None

• flags : int

PyIMAPIFolder.GetLastError

PyMAPIError

= GetLastError(hr, flags

) Returns the last error associated with this object

Parameters

• hr : int

  The HRESULT

• flags : int