foliolib.folio.api.email.DelayedTasks

class foliolib.folio.api.email.DelayedTasks(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

mod-email API

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

Parameters

  • tenant (str) – Tenant id

  • okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

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

OkapiFatalError – Server Error

set_retryFailedEmail()

Retry failed emails

POST /delayedTask/retryFailedEmails