foliolib.folio.api.email.DelayedTasks

class foliolib.folio.api.email.DelayedTasks(tenant: str)

Bases: foliolib.folio.FolioApi

mod-email API

The module should provide the ability to delete emails by status and date through the REST API

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_expiredMessages(**kwargs)	delete expired email messages
set_retryFailedEmail()	Retry failed emails

delete_expiredMessages(**kwargs)

delete expired email messages

DELETE /delayedTask/expiredMessages

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

• expirationDate (str) –

  Expiration Date

  Example

  • 2019-01-31

• emailStatus (str) –

  Email status

  Example

  • DELIVERED

Raises

OkapiRequestFatalError – Server Error

set_retryFailedEmail()

Retry failed emails

POST /delayedTask/retryFailedEmails