foliolib.folio.api.email.Email

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

Bases: foliolib.folio.FolioApi

mod-email API

The module should provide possibility of sending email through REST API of module.

Parameters

• tenant (str) – Tenant id

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

Methods

get_emails(**kwargs)	Get emails
set_email()	POST /email

get_emails(**kwargs)

Get emails

GET /email

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

• query (str) –

  A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

  searchable using CQL

  Example

  • (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode

  • status==FAILURE

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of email records",
  "type": "object",
  "properties": {
    "emails": {
      "description": "The list of emails in this collection",
      "type": "array",
      "id": "emails",
      "items": {
        "type": "object",
        "$ref": "email.json"
      }
    },
    "totalRecords": {
      "description": "The number of email records returned in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "emails",
    "totalRecords"
  ]
}

set_email()

POST /email