openapi: 3.0.3
info:
title: E∘nvelope API
version: 0.7.0
description: API schema for the E∘nvelope server.
license:
name: Licensed under AGPL-3.0-or-later
url: https://gitlab.com/Dacid99/eonvelope/-/blob/master/LICENSE
paths:
/api/schema/:
get:
operationId: schema_retrieve
description: |-
OpenApi3 schema for this API. Format can be selected via content negotiation.
- YAML: application/vnd.oai.openapi
- JSON: application/vnd.oai.openapi+json
parameters:
- in: query
name: format
schema:
type: string
enum:
- json
- yaml
- in: query
name: lang
schema:
type: string
enum:
- ar
- az
- bg
- ca
- cs
- da
- de
- el
- en
- es
- et
- eu
- fa
- fi
- fr
- he
- hr
- hu
- id
- it
- ja
- ka
- ko
- ky
- lt
- lv
- mn
- nb
- nl
- pl
- pt-BR
- pt-PT
- ro
- ru
- sk
- sl
- sr
- sv
- th
- tr
- uk
- zh-hans
- zh-hant
tags:
- schema
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
- {}
responses:
'200':
content:
application/vnd.oai.openapi:
schema:
type: object
additionalProperties: {}
application/yaml:
schema:
type: object
additionalProperties: {}
application/vnd.oai.openapi+json:
schema:
type: object
additionalProperties: {}
application/json:
schema:
type: object
additionalProperties: {}
description: ''
/api/v1/accounts:
get:
operationId: v1_accounts_list
description: Lists all instances matching the filter.
parameters:
- in: query
name: mail_address__icontains
schema:
type: string
- in: query
name: mail_address__contains
schema:
type: string
- in: query
name: mail_address
schema:
type: string
- in: query
name: mail_address__iexact
schema:
type: string
- in: query
name: mail_address__startswith
schema:
type: string
- in: query
name: mail_address__istartswith
schema:
type: string
- in: query
name: mail_address__endswith
schema:
type: string
- in: query
name: mail_address__iendswith
schema:
type: string
- in: query
name: mail_address__regex
schema:
type: string
- in: query
name: mail_address__iregex
schema:
type: string
- in: query
name: mail_address__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mail_host__icontains
schema:
type: string
- in: query
name: mail_host__contains
schema:
type: string
- in: query
name: mail_host
schema:
type: string
- in: query
name: mail_host__iexact
schema:
type: string
- in: query
name: mail_host__startswith
schema:
type: string
- in: query
name: mail_host__istartswith
schema:
type: string
- in: query
name: mail_host__endswith
schema:
type: string
- in: query
name: mail_host__iendswith
schema:
type: string
- in: query
name: mail_host__regex
schema:
type: string
- in: query
name: mail_host__iregex
schema:
type: string
- in: query
name: mail_host__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mail_host_port__lte
schema:
type: integer
- in: query
name: mail_host_port__gte
schema:
type: integer
- in: query
name: mail_host_port__lt
schema:
type: integer
- in: query
name: mail_host_port__gt
schema:
type: integer
- in: query
name: mail_host_port
schema:
type: integer
- in: query
name: mail_host_port__in
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mail_host_port__range
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: protocol__icontains
schema:
type: string
- in: query
name: protocol__iexact
schema:
type: string
- in: query
name: protocol__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: timeout__lte
schema:
type: integer
- in: query
name: timeout__gte
schema:
type: integer
- in: query
name: timeout__range
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: allow_insecure_connection
schema:
type: boolean
- in: query
name: is_healthy
schema:
type: boolean
- in: query
name: last_error__icontains
schema:
type: string
- in: query
name: last_error__contains
schema:
type: string
- in: query
name: last_error
schema:
type: string
- in: query
name: last_error__iexact
schema:
type: string
- in: query
name: last_error__startswith
schema:
type: string
- in: query
name: last_error__istartswith
schema:
type: string
- in: query
name: last_error__endswith
schema:
type: string
- in: query
name: last_error__iendswith
schema:
type: string
- in: query
name: last_error__regex
schema:
type: string
- in: query
name: last_error__iregex
schema:
type: string
- in: query
name: last_error__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__date
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__gte
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__lte
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__gt
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__lt
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__time
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__gte
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__lte
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__gt
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__lt
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_year
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__gte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__lte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__gt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__lt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__month
schema:
type: number
- in: query
name: last_error_occurred_at__month__gte
schema:
type: number
- in: query
name: last_error_occurred_at__month__lte
schema:
type: number
- in: query
name: last_error_occurred_at__month__gt
schema:
type: number
- in: query
name: last_error_occurred_at__month__lt
schema:
type: number
- in: query
name: last_error_occurred_at__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__quarter
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__gte
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__lte
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__gt
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__lt
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__week
schema:
type: number
- in: query
name: last_error_occurred_at__week__gte
schema:
type: number
- in: query
name: last_error_occurred_at__week__lte
schema:
type: number
- in: query
name: last_error_occurred_at__week__gt
schema:
type: number
- in: query
name: last_error_occurred_at__week__lt
schema:
type: number
- in: query
name: last_error_occurred_at__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_week_day
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__gte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__lte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__gt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__lt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__day
schema:
type: number
- in: query
name: last_error_occurred_at__day__gte
schema:
type: number
- in: query
name: last_error_occurred_at__day__lte
schema:
type: number
- in: query
name: last_error_occurred_at__day__gt
schema:
type: number
- in: query
name: last_error_occurred_at__day__lt
schema:
type: number
- in: query
name: last_error_occurred_at__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__hour
schema:
type: number
- in: query
name: last_error_occurred_at__hour__gte
schema:
type: number
- in: query
name: last_error_occurred_at__hour__lte
schema:
type: number
- in: query
name: last_error_occurred_at__hour__gt
schema:
type: number
- in: query
name: last_error_occurred_at__hour__lt
schema:
type: number
- in: query
name: last_error_occurred_at__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__minute
schema:
type: number
- in: query
name: last_error_occurred_at__minute__gte
schema:
type: number
- in: query
name: last_error_occurred_at__minute__lte
schema:
type: number
- in: query
name: last_error_occurred_at__minute__gt
schema:
type: number
- in: query
name: last_error_occurred_at__minute__lt
schema:
type: number
- in: query
name: last_error_occurred_at__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__second
schema:
type: number
- in: query
name: last_error_occurred_at__second__gte
schema:
type: number
- in: query
name: last_error_occurred_at__second__lte
schema:
type: number
- in: query
name: last_error_occurred_at__second__gt
schema:
type: number
- in: query
name: last_error_occurred_at__second__lt
schema:
type: number
- in: query
name: last_error_occurred_at__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: is_favorite
schema:
type: boolean
- in: query
name: created__date
schema:
type: string
format: date
- in: query
name: created__date__gte
schema:
type: string
format: date
- in: query
name: created__date__lte
schema:
type: string
format: date
- in: query
name: created__date__gt
schema:
type: string
format: date
- in: query
name: created__date__lt
schema:
type: string
format: date
- in: query
name: created__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time
schema:
type: string
format: time
- in: query
name: created__time__gte
schema:
type: string
format: time
- in: query
name: created__time__lte
schema:
type: string
format: time
- in: query
name: created__time__gt
schema:
type: string
format: time
- in: query
name: created__time__lt
schema:
type: string
format: time
- in: query
name: created__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year
schema:
type: number
- in: query
name: created__iso_year__gte
schema:
type: number
- in: query
name: created__iso_year__lte
schema:
type: number
- in: query
name: created__iso_year__gt
schema:
type: number
- in: query
name: created__iso_year__lt
schema:
type: number
- in: query
name: created__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month
schema:
type: number
- in: query
name: created__month__gte
schema:
type: number
- in: query
name: created__month__lte
schema:
type: number
- in: query
name: created__month__gt
schema:
type: number
- in: query
name: created__month__lt
schema:
type: number
- in: query
name: created__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter
schema:
type: number
- in: query
name: created__quarter__gte
schema:
type: number
- in: query
name: created__quarter__lte
schema:
type: number
- in: query
name: created__quarter__gt
schema:
type: number
- in: query
name: created__quarter__lt
schema:
type: number
- in: query
name: created__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week
schema:
type: number
- in: query
name: created__week__gte
schema:
type: number
- in: query
name: created__week__lte
schema:
type: number
- in: query
name: created__week__gt
schema:
type: number
- in: query
name: created__week__lt
schema:
type: number
- in: query
name: created__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day
schema:
type: number
- in: query
name: created__iso_week_day__gte
schema:
type: number
- in: query
name: created__iso_week_day__lte
schema:
type: number
- in: query
name: created__iso_week_day__gt
schema:
type: number
- in: query
name: created__iso_week_day__lt
schema:
type: number
- in: query
name: created__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day
schema:
type: number
- in: query
name: created__day__gte
schema:
type: number
- in: query
name: created__day__lte
schema:
type: number
- in: query
name: created__day__gt
schema:
type: number
- in: query
name: created__day__lt
schema:
type: number
- in: query
name: created__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour
schema:
type: number
- in: query
name: created__hour__gte
schema:
type: number
- in: query
name: created__hour__lte
schema:
type: number
- in: query
name: created__hour__gt
schema:
type: number
- in: query
name: created__hour__lt
schema:
type: number
- in: query
name: created__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute
schema:
type: number
- in: query
name: created__minute__gte
schema:
type: number
- in: query
name: created__minute__lte
schema:
type: number
- in: query
name: created__minute__gt
schema:
type: number
- in: query
name: created__minute__lt
schema:
type: number
- in: query
name: created__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second
schema:
type: number
- in: query
name: created__second__gte
schema:
type: number
- in: query
name: created__second__lte
schema:
type: number
- in: query
name: created__second__gt
schema:
type: number
- in: query
name: created__second__lt
schema:
type: number
- in: query
name: created__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date
schema:
type: string
format: date
- in: query
name: updated__date__gte
schema:
type: string
format: date
- in: query
name: updated__date__lte
schema:
type: string
format: date
- in: query
name: updated__date__gt
schema:
type: string
format: date
- in: query
name: updated__date__lt
schema:
type: string
format: date
- in: query
name: updated__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time
schema:
type: string
format: time
- in: query
name: updated__time__gte
schema:
type: string
format: time
- in: query
name: updated__time__lte
schema:
type: string
format: time
- in: query
name: updated__time__gt
schema:
type: string
format: time
- in: query
name: updated__time__lt
schema:
type: string
format: time
- in: query
name: updated__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year
schema:
type: number
- in: query
name: updated__iso_year__gte
schema:
type: number
- in: query
name: updated__iso_year__lte
schema:
type: number
- in: query
name: updated__iso_year__gt
schema:
type: number
- in: query
name: updated__iso_year__lt
schema:
type: number
- in: query
name: updated__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month
schema:
type: number
- in: query
name: updated__month__gte
schema:
type: number
- in: query
name: updated__month__lte
schema:
type: number
- in: query
name: updated__month__gt
schema:
type: number
- in: query
name: updated__month__lt
schema:
type: number
- in: query
name: updated__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter
schema:
type: number
- in: query
name: updated__quarter__gte
schema:
type: number
- in: query
name: updated__quarter__lte
schema:
type: number
- in: query
name: updated__quarter__gt
schema:
type: number
- in: query
name: updated__quarter__lt
schema:
type: number
- in: query
name: updated__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week
schema:
type: number
- in: query
name: updated__week__gte
schema:
type: number
- in: query
name: updated__week__lte
schema:
type: number
- in: query
name: updated__week__gt
schema:
type: number
- in: query
name: updated__week__lt
schema:
type: number
- in: query
name: updated__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day
schema:
type: number
- in: query
name: updated__iso_week_day__gte
schema:
type: number
- in: query
name: updated__iso_week_day__lte
schema:
type: number
- in: query
name: updated__iso_week_day__gt
schema:
type: number
- in: query
name: updated__iso_week_day__lt
schema:
type: number
- in: query
name: updated__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day
schema:
type: number
- in: query
name: updated__day__gte
schema:
type: number
- in: query
name: updated__day__lte
schema:
type: number
- in: query
name: updated__day__gt
schema:
type: number
- in: query
name: updated__day__lt
schema:
type: number
- in: query
name: updated__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour
schema:
type: number
- in: query
name: updated__hour__gte
schema:
type: number
- in: query
name: updated__hour__lte
schema:
type: number
- in: query
name: updated__hour__gt
schema:
type: number
- in: query
name: updated__hour__lt
schema:
type: number
- in: query
name: updated__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute
schema:
type: number
- in: query
name: updated__minute__gte
schema:
type: number
- in: query
name: updated__minute__lte
schema:
type: number
- in: query
name: updated__minute__gt
schema:
type: number
- in: query
name: updated__minute__lt
schema:
type: number
- in: query
name: updated__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second
schema:
type: number
- in: query
name: updated__second__gte
schema:
type: number
- in: query
name: updated__second__lte
schema:
type: number
- in: query
name: updated__second__gt
schema:
type: number
- in: query
name: updated__second__lt
schema:
type: number
- in: query
name: updated__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: search
schema:
type: string
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAccountList'
description: ''
post:
operationId: v1_accounts_create
description: Creates a new instance.
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Account'
multipart/form-data:
schema:
$ref: '#/components/schemas/Account'
required: true
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
description: ''
/api/v1/accounts/{id}:
get:
operationId: v1_accounts_retrieve
description: Retrieves a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this account.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
description: ''
put:
operationId: v1_accounts_update
description: Updates a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this account.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Account'
multipart/form-data:
schema:
$ref: '#/components/schemas/Account'
required: true
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
description: ''
patch:
operationId: v1_accounts_partial_update
description: |-
Viewset for the :class:`core.models.Account`.
Provides all actions.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this account.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAccount'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedAccount'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedAccount'
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
description: ''
delete:
operationId: v1_accounts_destroy
description: Deletes a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this account.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/v1/accounts/{id}/add-routines:
post:
operationId: v1_accounts_add_routines_create
description: Adds a standard set of routines for archiving all traffic to an
account.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this account.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/add_daemons_response'
description: ''
/api/v1/accounts/{id}/download:
get:
operationId: v1_accounts_download_retrieve
description: Downloads all emails of an account.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this account.
required: true
- in: query
name: file_format
schema:
type: string
enum:
- babyl
- mbox
- mmdf
- zip[eml]
- zip[maildir]
- zip[mh]
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: string
format: binary
description: 'content-disposition: attachment'
/api/v1/accounts/{id}/test:
post:
operationId: v1_accounts_test_create
description: Tests an account.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this account.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/test_account_response'
description: ''
/api/v1/accounts/{id}/toggle-favorite:
post:
operationId: v1_accounts_toggle_favorite_create
description: Toggles the favorite status of an instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this account.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/toggle_favorite_serializer'
description: Message indicating status change.
/api/v1/accounts/{id}/update-mailboxes:
post:
operationId: v1_accounts_update_mailboxes_create
description: Updates the mailboxes of an account.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this account.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/update_mailboxes_account_response'
description: ''
/api/v1/attachments:
get:
operationId: v1_attachments_list
description: Lists all instances matching the filter.
parameters:
- in: query
name: file_name__icontains
schema:
type: string
- in: query
name: file_name__contains
schema:
type: string
- in: query
name: file_name
schema:
type: string
- in: query
name: file_name__iexact
schema:
type: string
- in: query
name: file_name__startswith
schema:
type: string
- in: query
name: file_name__istartswith
schema:
type: string
- in: query
name: file_name__endswith
schema:
type: string
- in: query
name: file_name__iendswith
schema:
type: string
- in: query
name: file_name__regex
schema:
type: string
- in: query
name: file_name__iregex
schema:
type: string
- in: query
name: file_name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: content_disposition__icontains
schema:
type: string
- in: query
name: content_disposition__contains
schema:
type: string
- in: query
name: content_disposition
schema:
type: string
- in: query
name: content_disposition__iexact
schema:
type: string
- in: query
name: content_disposition__startswith
schema:
type: string
- in: query
name: content_disposition__istartswith
schema:
type: string
- in: query
name: content_disposition__endswith
schema:
type: string
- in: query
name: content_disposition__iendswith
schema:
type: string
- in: query
name: content_disposition__regex
schema:
type: string
- in: query
name: content_disposition__iregex
schema:
type: string
- in: query
name: content_disposition__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: content_id__icontains
schema:
type: string
- in: query
name: content_id__contains
schema:
type: string
- in: query
name: content_id
schema:
type: string
- in: query
name: content_id__iexact
schema:
type: string
- in: query
name: content_id__startswith
schema:
type: string
- in: query
name: content_id__istartswith
schema:
type: string
- in: query
name: content_id__endswith
schema:
type: string
- in: query
name: content_id__iendswith
schema:
type: string
- in: query
name: content_id__regex
schema:
type: string
- in: query
name: content_id__iregex
schema:
type: string
- in: query
name: content_id__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: content_maintype__icontains
schema:
type: string
- in: query
name: content_maintype__contains
schema:
type: string
- in: query
name: content_maintype
schema:
type: string
- in: query
name: content_maintype__iexact
schema:
type: string
- in: query
name: content_maintype__startswith
schema:
type: string
- in: query
name: content_maintype__istartswith
schema:
type: string
- in: query
name: content_maintype__endswith
schema:
type: string
- in: query
name: content_maintype__iendswith
schema:
type: string
- in: query
name: content_maintype__regex
schema:
type: string
- in: query
name: content_maintype__iregex
schema:
type: string
- in: query
name: content_maintype__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: content_subtype__icontains
schema:
type: string
- in: query
name: content_subtype__contains
schema:
type: string
- in: query
name: content_subtype
schema:
type: string
- in: query
name: content_subtype__iexact
schema:
type: string
- in: query
name: content_subtype__startswith
schema:
type: string
- in: query
name: content_subtype__istartswith
schema:
type: string
- in: query
name: content_subtype__endswith
schema:
type: string
- in: query
name: content_subtype__iendswith
schema:
type: string
- in: query
name: content_subtype__regex
schema:
type: string
- in: query
name: content_subtype__iregex
schema:
type: string
- in: query
name: content_subtype__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datasize__lte
schema:
type: integer
- in: query
name: datasize__gte
schema:
type: integer
- in: query
name: datasize__lt
schema:
type: integer
- in: query
name: datasize__gt
schema:
type: integer
- in: query
name: datasize
schema:
type: integer
- in: query
name: datasize__in
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datasize__range
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: is_favorite
schema:
type: boolean
- in: query
name: created__date
schema:
type: string
format: date
- in: query
name: created__date__gte
schema:
type: string
format: date
- in: query
name: created__date__lte
schema:
type: string
format: date
- in: query
name: created__date__gt
schema:
type: string
format: date
- in: query
name: created__date__lt
schema:
type: string
format: date
- in: query
name: created__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time
schema:
type: string
format: time
- in: query
name: created__time__gte
schema:
type: string
format: time
- in: query
name: created__time__lte
schema:
type: string
format: time
- in: query
name: created__time__gt
schema:
type: string
format: time
- in: query
name: created__time__lt
schema:
type: string
format: time
- in: query
name: created__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year
schema:
type: number
- in: query
name: created__iso_year__gte
schema:
type: number
- in: query
name: created__iso_year__lte
schema:
type: number
- in: query
name: created__iso_year__gt
schema:
type: number
- in: query
name: created__iso_year__lt
schema:
type: number
- in: query
name: created__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month
schema:
type: number
- in: query
name: created__month__gte
schema:
type: number
- in: query
name: created__month__lte
schema:
type: number
- in: query
name: created__month__gt
schema:
type: number
- in: query
name: created__month__lt
schema:
type: number
- in: query
name: created__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter
schema:
type: number
- in: query
name: created__quarter__gte
schema:
type: number
- in: query
name: created__quarter__lte
schema:
type: number
- in: query
name: created__quarter__gt
schema:
type: number
- in: query
name: created__quarter__lt
schema:
type: number
- in: query
name: created__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week
schema:
type: number
- in: query
name: created__week__gte
schema:
type: number
- in: query
name: created__week__lte
schema:
type: number
- in: query
name: created__week__gt
schema:
type: number
- in: query
name: created__week__lt
schema:
type: number
- in: query
name: created__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day
schema:
type: number
- in: query
name: created__iso_week_day__gte
schema:
type: number
- in: query
name: created__iso_week_day__lte
schema:
type: number
- in: query
name: created__iso_week_day__gt
schema:
type: number
- in: query
name: created__iso_week_day__lt
schema:
type: number
- in: query
name: created__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day
schema:
type: number
- in: query
name: created__day__gte
schema:
type: number
- in: query
name: created__day__lte
schema:
type: number
- in: query
name: created__day__gt
schema:
type: number
- in: query
name: created__day__lt
schema:
type: number
- in: query
name: created__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour
schema:
type: number
- in: query
name: created__hour__gte
schema:
type: number
- in: query
name: created__hour__lte
schema:
type: number
- in: query
name: created__hour__gt
schema:
type: number
- in: query
name: created__hour__lt
schema:
type: number
- in: query
name: created__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute
schema:
type: number
- in: query
name: created__minute__gte
schema:
type: number
- in: query
name: created__minute__lte
schema:
type: number
- in: query
name: created__minute__gt
schema:
type: number
- in: query
name: created__minute__lt
schema:
type: number
- in: query
name: created__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second
schema:
type: number
- in: query
name: created__second__gte
schema:
type: number
- in: query
name: created__second__lte
schema:
type: number
- in: query
name: created__second__gt
schema:
type: number
- in: query
name: created__second__lt
schema:
type: number
- in: query
name: created__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date
schema:
type: string
format: date
- in: query
name: updated__date__gte
schema:
type: string
format: date
- in: query
name: updated__date__lte
schema:
type: string
format: date
- in: query
name: updated__date__gt
schema:
type: string
format: date
- in: query
name: updated__date__lt
schema:
type: string
format: date
- in: query
name: updated__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time
schema:
type: string
format: time
- in: query
name: updated__time__gte
schema:
type: string
format: time
- in: query
name: updated__time__lte
schema:
type: string
format: time
- in: query
name: updated__time__gt
schema:
type: string
format: time
- in: query
name: updated__time__lt
schema:
type: string
format: time
- in: query
name: updated__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year
schema:
type: number
- in: query
name: updated__iso_year__gte
schema:
type: number
- in: query
name: updated__iso_year__lte
schema:
type: number
- in: query
name: updated__iso_year__gt
schema:
type: number
- in: query
name: updated__iso_year__lt
schema:
type: number
- in: query
name: updated__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month
schema:
type: number
- in: query
name: updated__month__gte
schema:
type: number
- in: query
name: updated__month__lte
schema:
type: number
- in: query
name: updated__month__gt
schema:
type: number
- in: query
name: updated__month__lt
schema:
type: number
- in: query
name: updated__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter
schema:
type: number
- in: query
name: updated__quarter__gte
schema:
type: number
- in: query
name: updated__quarter__lte
schema:
type: number
- in: query
name: updated__quarter__gt
schema:
type: number
- in: query
name: updated__quarter__lt
schema:
type: number
- in: query
name: updated__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week
schema:
type: number
- in: query
name: updated__week__gte
schema:
type: number
- in: query
name: updated__week__lte
schema:
type: number
- in: query
name: updated__week__gt
schema:
type: number
- in: query
name: updated__week__lt
schema:
type: number
- in: query
name: updated__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day
schema:
type: number
- in: query
name: updated__iso_week_day__gte
schema:
type: number
- in: query
name: updated__iso_week_day__lte
schema:
type: number
- in: query
name: updated__iso_week_day__gt
schema:
type: number
- in: query
name: updated__iso_week_day__lt
schema:
type: number
- in: query
name: updated__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day
schema:
type: number
- in: query
name: updated__day__gte
schema:
type: number
- in: query
name: updated__day__lte
schema:
type: number
- in: query
name: updated__day__gt
schema:
type: number
- in: query
name: updated__day__lt
schema:
type: number
- in: query
name: updated__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour
schema:
type: number
- in: query
name: updated__hour__gte
schema:
type: number
- in: query
name: updated__hour__lte
schema:
type: number
- in: query
name: updated__hour__gt
schema:
type: number
- in: query
name: updated__hour__lt
schema:
type: number
- in: query
name: updated__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute
schema:
type: number
- in: query
name: updated__minute__gte
schema:
type: number
- in: query
name: updated__minute__lte
schema:
type: number
- in: query
name: updated__minute__gt
schema:
type: number
- in: query
name: updated__minute__lt
schema:
type: number
- in: query
name: updated__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second
schema:
type: number
- in: query
name: updated__second__gte
schema:
type: number
- in: query
name: updated__second__lte
schema:
type: number
- in: query
name: updated__second__gt
schema:
type: number
- in: query
name: updated__second__lt
schema:
type: number
- in: query
name: updated__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__date
schema:
type: string
format: date
- in: query
name: email__datetime__date__gte
schema:
type: string
format: date
- in: query
name: email__datetime__date__lte
schema:
type: string
format: date
- in: query
name: email__datetime__date__gt
schema:
type: string
format: date
- in: query
name: email__datetime__date__lt
schema:
type: string
format: date
- in: query
name: email__datetime__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__time
schema:
type: string
format: time
- in: query
name: email__datetime__time__gte
schema:
type: string
format: time
- in: query
name: email__datetime__time__lte
schema:
type: string
format: time
- in: query
name: email__datetime__time__gt
schema:
type: string
format: time
- in: query
name: email__datetime__time__lt
schema:
type: string
format: time
- in: query
name: email__datetime__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__iso_year
schema:
type: number
- in: query
name: email__datetime__iso_year__gte
schema:
type: number
- in: query
name: email__datetime__iso_year__lte
schema:
type: number
- in: query
name: email__datetime__iso_year__gt
schema:
type: number
- in: query
name: email__datetime__iso_year__lt
schema:
type: number
- in: query
name: email__datetime__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__month
schema:
type: number
- in: query
name: email__datetime__month__gte
schema:
type: number
- in: query
name: email__datetime__month__lte
schema:
type: number
- in: query
name: email__datetime__month__gt
schema:
type: number
- in: query
name: email__datetime__month__lt
schema:
type: number
- in: query
name: email__datetime__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__quarter
schema:
type: number
- in: query
name: email__datetime__quarter__gte
schema:
type: number
- in: query
name: email__datetime__quarter__lte
schema:
type: number
- in: query
name: email__datetime__quarter__gt
schema:
type: number
- in: query
name: email__datetime__quarter__lt
schema:
type: number
- in: query
name: email__datetime__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__week
schema:
type: number
- in: query
name: email__datetime__week__gte
schema:
type: number
- in: query
name: email__datetime__week__lte
schema:
type: number
- in: query
name: email__datetime__week__gt
schema:
type: number
- in: query
name: email__datetime__week__lt
schema:
type: number
- in: query
name: email__datetime__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__iso_week_day
schema:
type: number
- in: query
name: email__datetime__iso_week_day__gte
schema:
type: number
- in: query
name: email__datetime__iso_week_day__lte
schema:
type: number
- in: query
name: email__datetime__iso_week_day__gt
schema:
type: number
- in: query
name: email__datetime__iso_week_day__lt
schema:
type: number
- in: query
name: email__datetime__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__day
schema:
type: number
- in: query
name: email__datetime__day__gte
schema:
type: number
- in: query
name: email__datetime__day__lte
schema:
type: number
- in: query
name: email__datetime__day__gt
schema:
type: number
- in: query
name: email__datetime__day__lt
schema:
type: number
- in: query
name: email__datetime__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__hour
schema:
type: number
- in: query
name: email__datetime__hour__gte
schema:
type: number
- in: query
name: email__datetime__hour__lte
schema:
type: number
- in: query
name: email__datetime__hour__gt
schema:
type: number
- in: query
name: email__datetime__hour__lt
schema:
type: number
- in: query
name: email__datetime__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__minute
schema:
type: number
- in: query
name: email__datetime__minute__gte
schema:
type: number
- in: query
name: email__datetime__minute__lte
schema:
type: number
- in: query
name: email__datetime__minute__gt
schema:
type: number
- in: query
name: email__datetime__minute__lt
schema:
type: number
- in: query
name: email__datetime__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__second
schema:
type: number
- in: query
name: email__datetime__second__gte
schema:
type: number
- in: query
name: email__datetime__second__lte
schema:
type: number
- in: query
name: email__datetime__second__gt
schema:
type: number
- in: query
name: email__datetime__second__lt
schema:
type: number
- in: query
name: email__datetime__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email__datetime__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: search
schema:
type: string
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBaseAttachmentList'
description: ''
/api/v1/attachments/{id}:
get:
operationId: v1_attachments_retrieve
description: Retrieves a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this attachment.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BaseAttachment'
description: ''
delete:
operationId: v1_attachments_destroy
description: Deletes a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this attachment.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/v1/attachments/{id}/download:
get:
operationId: v1_attachments_download_retrieve
description: Downloads an attachment's file.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this attachment.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: string
format: binary
description: 'content-disposition: attachment'
/api/v1/attachments/{id}/share/immich:
post:
operationId: v1_attachments_share_immich_create
description: Sends the attachment's file to the user's Immich server.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this attachment.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/share_to_immich_serializer'
description: If the request to the Immich server succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/share_to_immich_failed_serializer'
description: If the request to the Immich server fails. The reason is given
as the response data.
/api/v1/attachments/{id}/share/paperless:
post:
operationId: v1_attachments_share_paperless_create
description: Sends a attachment's file to the user's Paperless server.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this attachment.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/share_to_paperless_serializer'
description: If the request to the Paperless server succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/share_to_paperless_failed_serializer'
description: If the request to the Paperless server fails. The reason is
given as the response data.
/api/v1/attachments/{id}/thumbnail:
get:
operationId: v1_attachments_thumbnail_retrieve
description: Downloads a attachment's thumbnail.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this attachment.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: string
format: binary
description: 'content-disposition: inline, x-frame-option: SAMEORIGIN, content-security-policy:
frame-ancestors ''self'''
/api/v1/attachments/{id}/toggle-favorite:
post:
operationId: v1_attachments_toggle_favorite_create
description: Toggles the favorite status of an instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this attachment.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/toggle_favorite_serializer'
description: Message indicating status change.
/api/v1/attachments/download:
get:
operationId: v1_attachments_batch_download_retrieve
description: Downloads multiple zipped attachment files.
parameters:
- in: query
name: id
schema:
type: array
items:
type: integer
description: A list of integer values identifying the accounts. Duplicates
are ignored. Accepts both id=1,2,3 and id=1&id=2&id=3 notation
required: true
explode: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/zip:
schema:
type: string
format: binary
description: 'content-disposition: attachment'
/api/v1/auth/profile:
get:
operationId: v1_auth_profile_retrieve
description: View for retrieving and updating the users :class:`eonvelope.models.UserProfile`.
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfile'
description: ''
put:
operationId: v1_auth_profile_update
description: View for retrieving and updating the users :class:`eonvelope.models.UserProfile`.
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfile'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UserProfile'
multipart/form-data:
schema:
$ref: '#/components/schemas/UserProfile'
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfile'
description: ''
patch:
operationId: v1_auth_profile_partial_update
description: View for retrieving and updating the users :class:`eonvelope.models.UserProfile`.
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedUserProfile'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedUserProfile'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedUserProfile'
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfile'
description: ''
/api/v1/correspondents:
get:
operationId: v1_correspondents_list
description: Lists all instances matching the filter.
parameters:
- in: query
name: email_name__icontains
schema:
type: string
- in: query
name: email_name__contains
schema:
type: string
- in: query
name: email_name
schema:
type: string
- in: query
name: email_name__iexact
schema:
type: string
- in: query
name: email_name__startswith
schema:
type: string
- in: query
name: email_name__istartswith
schema:
type: string
- in: query
name: email_name__endswith
schema:
type: string
- in: query
name: email_name__iendswith
schema:
type: string
- in: query
name: email_name__regex
schema:
type: string
- in: query
name: email_name__iregex
schema:
type: string
- in: query
name: email_name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: real_name__icontains
schema:
type: string
- in: query
name: real_name__contains
schema:
type: string
- in: query
name: real_name
schema:
type: string
- in: query
name: real_name__iexact
schema:
type: string
- in: query
name: real_name__startswith
schema:
type: string
- in: query
name: real_name__istartswith
schema:
type: string
- in: query
name: real_name__endswith
schema:
type: string
- in: query
name: real_name__iendswith
schema:
type: string
- in: query
name: real_name__regex
schema:
type: string
- in: query
name: real_name__iregex
schema:
type: string
- in: query
name: real_name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: email_address__icontains
schema:
type: string
- in: query
name: email_address__contains
schema:
type: string
- in: query
name: email_address
schema:
type: string
- in: query
name: email_address__iexact
schema:
type: string
- in: query
name: email_address__startswith
schema:
type: string
- in: query
name: email_address__istartswith
schema:
type: string
- in: query
name: email_address__endswith
schema:
type: string
- in: query
name: email_address__iendswith
schema:
type: string
- in: query
name: email_address__regex
schema:
type: string
- in: query
name: email_address__iregex
schema:
type: string
- in: query
name: email_address__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: list_id__icontains
schema:
type: string
- in: query
name: list_id__contains
schema:
type: string
- in: query
name: list_id
schema:
type: string
- in: query
name: list_id__iexact
schema:
type: string
- in: query
name: list_id__startswith
schema:
type: string
- in: query
name: list_id__istartswith
schema:
type: string
- in: query
name: list_id__endswith
schema:
type: string
- in: query
name: list_id__iendswith
schema:
type: string
- in: query
name: list_id__regex
schema:
type: string
- in: query
name: list_id__iregex
schema:
type: string
- in: query
name: list_id__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: list_owner__icontains
schema:
type: string
- in: query
name: list_owner__contains
schema:
type: string
- in: query
name: list_owner
schema:
type: string
- in: query
name: list_owner__iexact
schema:
type: string
- in: query
name: list_owner__startswith
schema:
type: string
- in: query
name: list_owner__istartswith
schema:
type: string
- in: query
name: list_owner__endswith
schema:
type: string
- in: query
name: list_owner__iendswith
schema:
type: string
- in: query
name: list_owner__regex
schema:
type: string
- in: query
name: list_owner__iregex
schema:
type: string
- in: query
name: list_owner__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: list_subscribe__icontains
schema:
type: string
- in: query
name: list_subscribe__contains
schema:
type: string
- in: query
name: list_subscribe
schema:
type: string
- in: query
name: list_subscribe__iexact
schema:
type: string
- in: query
name: list_subscribe__startswith
schema:
type: string
- in: query
name: list_subscribe__istartswith
schema:
type: string
- in: query
name: list_subscribe__endswith
schema:
type: string
- in: query
name: list_subscribe__iendswith
schema:
type: string
- in: query
name: list_subscribe__regex
schema:
type: string
- in: query
name: list_subscribe__iregex
schema:
type: string
- in: query
name: list_subscribe__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: list_unsubscribe__icontains
schema:
type: string
- in: query
name: list_unsubscribe__contains
schema:
type: string
- in: query
name: list_unsubscribe
schema:
type: string
- in: query
name: list_unsubscribe__iexact
schema:
type: string
- in: query
name: list_unsubscribe__startswith
schema:
type: string
- in: query
name: list_unsubscribe__istartswith
schema:
type: string
- in: query
name: list_unsubscribe__endswith
schema:
type: string
- in: query
name: list_unsubscribe__iendswith
schema:
type: string
- in: query
name: list_unsubscribe__regex
schema:
type: string
- in: query
name: list_unsubscribe__iregex
schema:
type: string
- in: query
name: list_unsubscribe__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: list_unsubscribe_post__icontains
schema:
type: string
- in: query
name: list_unsubscribe_post__contains
schema:
type: string
- in: query
name: list_unsubscribe_post
schema:
type: string
- in: query
name: list_unsubscribe_post__iexact
schema:
type: string
- in: query
name: list_unsubscribe_post__startswith
schema:
type: string
- in: query
name: list_unsubscribe_post__istartswith
schema:
type: string
- in: query
name: list_unsubscribe_post__endswith
schema:
type: string
- in: query
name: list_unsubscribe_post__iendswith
schema:
type: string
- in: query
name: list_unsubscribe_post__regex
schema:
type: string
- in: query
name: list_unsubscribe_post__iregex
schema:
type: string
- in: query
name: list_unsubscribe_post__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: list_post__icontains
schema:
type: string
- in: query
name: list_post__contains
schema:
type: string
- in: query
name: list_post
schema:
type: string
- in: query
name: list_post__iexact
schema:
type: string
- in: query
name: list_post__startswith
schema:
type: string
- in: query
name: list_post__istartswith
schema:
type: string
- in: query
name: list_post__endswith
schema:
type: string
- in: query
name: list_post__iendswith
schema:
type: string
- in: query
name: list_post__regex
schema:
type: string
- in: query
name: list_post__iregex
schema:
type: string
- in: query
name: list_post__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: list_help__icontains
schema:
type: string
- in: query
name: list_help__contains
schema:
type: string
- in: query
name: list_help
schema:
type: string
- in: query
name: list_help__iexact
schema:
type: string
- in: query
name: list_help__startswith
schema:
type: string
- in: query
name: list_help__istartswith
schema:
type: string
- in: query
name: list_help__endswith
schema:
type: string
- in: query
name: list_help__iendswith
schema:
type: string
- in: query
name: list_help__regex
schema:
type: string
- in: query
name: list_help__iregex
schema:
type: string
- in: query
name: list_help__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: list_archive__icontains
schema:
type: string
- in: query
name: list_archive__contains
schema:
type: string
- in: query
name: list_archive
schema:
type: string
- in: query
name: list_archive__iexact
schema:
type: string
- in: query
name: list_archive__startswith
schema:
type: string
- in: query
name: list_archive__istartswith
schema:
type: string
- in: query
name: list_archive__endswith
schema:
type: string
- in: query
name: list_archive__iendswith
schema:
type: string
- in: query
name: list_archive__regex
schema:
type: string
- in: query
name: list_archive__iregex
schema:
type: string
- in: query
name: list_archive__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: is_favorite
schema:
type: boolean
- in: query
name: created__date
schema:
type: string
format: date
- in: query
name: created__date__gte
schema:
type: string
format: date
- in: query
name: created__date__lte
schema:
type: string
format: date
- in: query
name: created__date__gt
schema:
type: string
format: date
- in: query
name: created__date__lt
schema:
type: string
format: date
- in: query
name: created__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time
schema:
type: string
format: time
- in: query
name: created__time__gte
schema:
type: string
format: time
- in: query
name: created__time__lte
schema:
type: string
format: time
- in: query
name: created__time__gt
schema:
type: string
format: time
- in: query
name: created__time__lt
schema:
type: string
format: time
- in: query
name: created__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year
schema:
type: number
- in: query
name: created__iso_year__gte
schema:
type: number
- in: query
name: created__iso_year__lte
schema:
type: number
- in: query
name: created__iso_year__gt
schema:
type: number
- in: query
name: created__iso_year__lt
schema:
type: number
- in: query
name: created__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month
schema:
type: number
- in: query
name: created__month__gte
schema:
type: number
- in: query
name: created__month__lte
schema:
type: number
- in: query
name: created__month__gt
schema:
type: number
- in: query
name: created__month__lt
schema:
type: number
- in: query
name: created__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter
schema:
type: number
- in: query
name: created__quarter__gte
schema:
type: number
- in: query
name: created__quarter__lte
schema:
type: number
- in: query
name: created__quarter__gt
schema:
type: number
- in: query
name: created__quarter__lt
schema:
type: number
- in: query
name: created__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week
schema:
type: number
- in: query
name: created__week__gte
schema:
type: number
- in: query
name: created__week__lte
schema:
type: number
- in: query
name: created__week__gt
schema:
type: number
- in: query
name: created__week__lt
schema:
type: number
- in: query
name: created__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day
schema:
type: number
- in: query
name: created__iso_week_day__gte
schema:
type: number
- in: query
name: created__iso_week_day__lte
schema:
type: number
- in: query
name: created__iso_week_day__gt
schema:
type: number
- in: query
name: created__iso_week_day__lt
schema:
type: number
- in: query
name: created__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day
schema:
type: number
- in: query
name: created__day__gte
schema:
type: number
- in: query
name: created__day__lte
schema:
type: number
- in: query
name: created__day__gt
schema:
type: number
- in: query
name: created__day__lt
schema:
type: number
- in: query
name: created__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour
schema:
type: number
- in: query
name: created__hour__gte
schema:
type: number
- in: query
name: created__hour__lte
schema:
type: number
- in: query
name: created__hour__gt
schema:
type: number
- in: query
name: created__hour__lt
schema:
type: number
- in: query
name: created__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute
schema:
type: number
- in: query
name: created__minute__gte
schema:
type: number
- in: query
name: created__minute__lte
schema:
type: number
- in: query
name: created__minute__gt
schema:
type: number
- in: query
name: created__minute__lt
schema:
type: number
- in: query
name: created__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second
schema:
type: number
- in: query
name: created__second__gte
schema:
type: number
- in: query
name: created__second__lte
schema:
type: number
- in: query
name: created__second__gt
schema:
type: number
- in: query
name: created__second__lt
schema:
type: number
- in: query
name: created__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date
schema:
type: string
format: date
- in: query
name: updated__date__gte
schema:
type: string
format: date
- in: query
name: updated__date__lte
schema:
type: string
format: date
- in: query
name: updated__date__gt
schema:
type: string
format: date
- in: query
name: updated__date__lt
schema:
type: string
format: date
- in: query
name: updated__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time
schema:
type: string
format: time
- in: query
name: updated__time__gte
schema:
type: string
format: time
- in: query
name: updated__time__lte
schema:
type: string
format: time
- in: query
name: updated__time__gt
schema:
type: string
format: time
- in: query
name: updated__time__lt
schema:
type: string
format: time
- in: query
name: updated__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year
schema:
type: number
- in: query
name: updated__iso_year__gte
schema:
type: number
- in: query
name: updated__iso_year__lte
schema:
type: number
- in: query
name: updated__iso_year__gt
schema:
type: number
- in: query
name: updated__iso_year__lt
schema:
type: number
- in: query
name: updated__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month
schema:
type: number
- in: query
name: updated__month__gte
schema:
type: number
- in: query
name: updated__month__lte
schema:
type: number
- in: query
name: updated__month__gt
schema:
type: number
- in: query
name: updated__month__lt
schema:
type: number
- in: query
name: updated__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter
schema:
type: number
- in: query
name: updated__quarter__gte
schema:
type: number
- in: query
name: updated__quarter__lte
schema:
type: number
- in: query
name: updated__quarter__gt
schema:
type: number
- in: query
name: updated__quarter__lt
schema:
type: number
- in: query
name: updated__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week
schema:
type: number
- in: query
name: updated__week__gte
schema:
type: number
- in: query
name: updated__week__lte
schema:
type: number
- in: query
name: updated__week__gt
schema:
type: number
- in: query
name: updated__week__lt
schema:
type: number
- in: query
name: updated__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day
schema:
type: number
- in: query
name: updated__iso_week_day__gte
schema:
type: number
- in: query
name: updated__iso_week_day__lte
schema:
type: number
- in: query
name: updated__iso_week_day__gt
schema:
type: number
- in: query
name: updated__iso_week_day__lt
schema:
type: number
- in: query
name: updated__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day
schema:
type: number
- in: query
name: updated__day__gte
schema:
type: number
- in: query
name: updated__day__lte
schema:
type: number
- in: query
name: updated__day__gt
schema:
type: number
- in: query
name: updated__day__lt
schema:
type: number
- in: query
name: updated__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour
schema:
type: number
- in: query
name: updated__hour__gte
schema:
type: number
- in: query
name: updated__hour__lte
schema:
type: number
- in: query
name: updated__hour__gt
schema:
type: number
- in: query
name: updated__hour__lt
schema:
type: number
- in: query
name: updated__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute
schema:
type: number
- in: query
name: updated__minute__gte
schema:
type: number
- in: query
name: updated__minute__lte
schema:
type: number
- in: query
name: updated__minute__gt
schema:
type: number
- in: query
name: updated__minute__lt
schema:
type: number
- in: query
name: updated__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second
schema:
type: number
- in: query
name: updated__second__gte
schema:
type: number
- in: query
name: updated__second__lte
schema:
type: number
- in: query
name: updated__second__gt
schema:
type: number
- in: query
name: updated__second__lt
schema:
type: number
- in: query
name: updated__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: search
schema:
type: string
- in: query
name: mention__iexact
schema:
type: string
- in: query
name: account_mail_address__icontains
schema:
type: string
- in: query
name: account_mail_address__contains
schema:
type: string
- in: query
name: account_mail_address
schema:
type: string
- in: query
name: account_mail_address__iexact
schema:
type: string
- in: query
name: account_mail_address__startswith
schema:
type: string
- in: query
name: account_mail_address__istartswith
schema:
type: string
- in: query
name: account_mail_address__endswith
schema:
type: string
- in: query
name: account_mail_address__iendswith
schema:
type: string
- in: query
name: account_mail_address__regex
schema:
type: string
- in: query
name: account_mail_address__iregex
schema:
type: string
- in: query
name: account_mail_address__in
schema:
type: array
items:
type: string
title: Username
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: account_mail_host__icontains
schema:
type: string
- in: query
name: account_mail_host__contains
schema:
type: string
- in: query
name: account_mail_host
schema:
type: string
- in: query
name: account_mail_host__iexact
schema:
type: string
- in: query
name: account_mail_host__startswith
schema:
type: string
- in: query
name: account_mail_host__istartswith
schema:
type: string
- in: query
name: account_mail_host__endswith
schema:
type: string
- in: query
name: account_mail_host__iendswith
schema:
type: string
- in: query
name: account_mail_host__regex
schema:
type: string
- in: query
name: account_mail_host__iregex
schema:
type: string
- in: query
name: account_mail_host__in
schema:
type: array
items:
type: string
title: Mailserver URL
description: Multiple values may be separated by commas.
explode: false
style: form
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBaseCorrespondentList'
description: ''
/api/v1/correspondents/{id}:
get:
operationId: v1_correspondents_retrieve
description: Retrieves a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this correspondent.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Correspondent'
description: ''
put:
operationId: v1_correspondents_update
description: Updates a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this correspondent.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Correspondent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Correspondent'
multipart/form-data:
schema:
$ref: '#/components/schemas/Correspondent'
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Correspondent'
description: ''
patch:
operationId: v1_correspondents_partial_update
description: |-
Viewset for the :class:`core.models.Correspondent.Correspondent`.
Provides every read-only and a destroy action.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this correspondent.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCorrespondent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedCorrespondent'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedCorrespondent'
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Correspondent'
description: ''
delete:
operationId: v1_correspondents_destroy
description: Deletes a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this correspondent.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/v1/correspondents/{id}/download:
get:
operationId: v1_correspondents_download_retrieve
description: Downloads a correspondent as vcard.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this correspondent.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
text/vcard:
schema:
type: string
format: binary
description: 'content-disposition: correspondent'
/api/v1/correspondents/{id}/share/nextcloud:
post:
operationId: v1_correspondents_share_nextcloud_create
description: Sends a correspondent's data to the user's Nextcloud addressbook.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this correspondent.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/share_to_nextcloud_serializer'
description: If the request to the Nextcloud server succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/share_to_nextcloud_failed_serializer'
description: If the request to the Nextcloud server fails. The reason is
given as the response data.
/api/v1/correspondents/{id}/toggle-favorite:
post:
operationId: v1_correspondents_toggle_favorite_create
description: Toggles the favorite status of an instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this correspondent.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/toggle_favorite_serializer'
description: Message indicating status change.
/api/v1/correspondents/download:
get:
operationId: v1_correspondents_batch_download_retrieve
description: Downloads multiple correspondents as one vcard.
parameters:
- in: query
name: id
schema:
type: array
items:
type: integer
description: A list of integer values identifying the correspondents. Duplicates
are ignored. Accepts both id=1,2,3 and id=1&id=2&id=3 notation
required: true
explode: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
text/vcard:
schema:
type: string
format: binary
description: 'content-disposition: correspondent'
/api/v1/emails:
get:
operationId: v1_emails_list
description: Lists all instances matching the filter.
parameters:
- in: query
name: message_id__icontains
schema:
type: string
- in: query
name: message_id__contains
schema:
type: string
- in: query
name: message_id
schema:
type: string
- in: query
name: message_id__iexact
schema:
type: string
- in: query
name: message_id__startswith
schema:
type: string
- in: query
name: message_id__istartswith
schema:
type: string
- in: query
name: message_id__endswith
schema:
type: string
- in: query
name: message_id__iendswith
schema:
type: string
- in: query
name: message_id__regex
schema:
type: string
- in: query
name: message_id__iregex
schema:
type: string
- in: query
name: message_id__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__date
schema:
type: string
format: date
- in: query
name: datetime__date__gte
schema:
type: string
format: date
- in: query
name: datetime__date__lte
schema:
type: string
format: date
- in: query
name: datetime__date__gt
schema:
type: string
format: date
- in: query
name: datetime__date__lt
schema:
type: string
format: date
- in: query
name: datetime__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__time
schema:
type: string
format: time
- in: query
name: datetime__time__gte
schema:
type: string
format: time
- in: query
name: datetime__time__lte
schema:
type: string
format: time
- in: query
name: datetime__time__gt
schema:
type: string
format: time
- in: query
name: datetime__time__lt
schema:
type: string
format: time
- in: query
name: datetime__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__iso_year
schema:
type: number
- in: query
name: datetime__iso_year__gte
schema:
type: number
- in: query
name: datetime__iso_year__lte
schema:
type: number
- in: query
name: datetime__iso_year__gt
schema:
type: number
- in: query
name: datetime__iso_year__lt
schema:
type: number
- in: query
name: datetime__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__month
schema:
type: number
- in: query
name: datetime__month__gte
schema:
type: number
- in: query
name: datetime__month__lte
schema:
type: number
- in: query
name: datetime__month__gt
schema:
type: number
- in: query
name: datetime__month__lt
schema:
type: number
- in: query
name: datetime__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__quarter
schema:
type: number
- in: query
name: datetime__quarter__gte
schema:
type: number
- in: query
name: datetime__quarter__lte
schema:
type: number
- in: query
name: datetime__quarter__gt
schema:
type: number
- in: query
name: datetime__quarter__lt
schema:
type: number
- in: query
name: datetime__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__week
schema:
type: number
- in: query
name: datetime__week__gte
schema:
type: number
- in: query
name: datetime__week__lte
schema:
type: number
- in: query
name: datetime__week__gt
schema:
type: number
- in: query
name: datetime__week__lt
schema:
type: number
- in: query
name: datetime__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__iso_week_day
schema:
type: number
- in: query
name: datetime__iso_week_day__gte
schema:
type: number
- in: query
name: datetime__iso_week_day__lte
schema:
type: number
- in: query
name: datetime__iso_week_day__gt
schema:
type: number
- in: query
name: datetime__iso_week_day__lt
schema:
type: number
- in: query
name: datetime__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__day
schema:
type: number
- in: query
name: datetime__day__gte
schema:
type: number
- in: query
name: datetime__day__lte
schema:
type: number
- in: query
name: datetime__day__gt
schema:
type: number
- in: query
name: datetime__day__lt
schema:
type: number
- in: query
name: datetime__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__hour
schema:
type: number
- in: query
name: datetime__hour__gte
schema:
type: number
- in: query
name: datetime__hour__lte
schema:
type: number
- in: query
name: datetime__hour__gt
schema:
type: number
- in: query
name: datetime__hour__lt
schema:
type: number
- in: query
name: datetime__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__minute
schema:
type: number
- in: query
name: datetime__minute__gte
schema:
type: number
- in: query
name: datetime__minute__lte
schema:
type: number
- in: query
name: datetime__minute__gt
schema:
type: number
- in: query
name: datetime__minute__lt
schema:
type: number
- in: query
name: datetime__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__second
schema:
type: number
- in: query
name: datetime__second__gte
schema:
type: number
- in: query
name: datetime__second__lte
schema:
type: number
- in: query
name: datetime__second__gt
schema:
type: number
- in: query
name: datetime__second__lt
schema:
type: number
- in: query
name: datetime__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: subject__icontains
schema:
type: string
- in: query
name: subject__contains
schema:
type: string
- in: query
name: subject
schema:
type: string
- in: query
name: subject__iexact
schema:
type: string
- in: query
name: subject__startswith
schema:
type: string
- in: query
name: subject__istartswith
schema:
type: string
- in: query
name: subject__endswith
schema:
type: string
- in: query
name: subject__iendswith
schema:
type: string
- in: query
name: subject__regex
schema:
type: string
- in: query
name: subject__iregex
schema:
type: string
- in: query
name: subject__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: plain_bodytext__icontains
schema:
type: string
- in: query
name: plain_bodytext__contains
schema:
type: string
- in: query
name: plain_bodytext
schema:
type: string
- in: query
name: plain_bodytext__iexact
schema:
type: string
- in: query
name: plain_bodytext__startswith
schema:
type: string
- in: query
name: plain_bodytext__istartswith
schema:
type: string
- in: query
name: plain_bodytext__endswith
schema:
type: string
- in: query
name: plain_bodytext__iendswith
schema:
type: string
- in: query
name: plain_bodytext__regex
schema:
type: string
- in: query
name: plain_bodytext__iregex
schema:
type: string
- in: query
name: plain_bodytext__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: html_bodytext__icontains
schema:
type: string
- in: query
name: html_bodytext__contains
schema:
type: string
- in: query
name: html_bodytext
schema:
type: string
- in: query
name: html_bodytext__iexact
schema:
type: string
- in: query
name: html_bodytext__startswith
schema:
type: string
- in: query
name: html_bodytext__istartswith
schema:
type: string
- in: query
name: html_bodytext__endswith
schema:
type: string
- in: query
name: html_bodytext__iendswith
schema:
type: string
- in: query
name: html_bodytext__regex
schema:
type: string
- in: query
name: html_bodytext__iregex
schema:
type: string
- in: query
name: html_bodytext__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datasize__lte
schema:
type: integer
- in: query
name: datasize__gte
schema:
type: integer
- in: query
name: datasize__lt
schema:
type: integer
- in: query
name: datasize__gt
schema:
type: integer
- in: query
name: datasize
schema:
type: integer
- in: query
name: datasize__in
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datasize__range
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: x_spam_flag
schema:
type: boolean
- in: query
name: is_favorite
schema:
type: boolean
- in: query
name: created__date
schema:
type: string
format: date
- in: query
name: created__date__gte
schema:
type: string
format: date
- in: query
name: created__date__lte
schema:
type: string
format: date
- in: query
name: created__date__gt
schema:
type: string
format: date
- in: query
name: created__date__lt
schema:
type: string
format: date
- in: query
name: created__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time
schema:
type: string
format: time
- in: query
name: created__time__gte
schema:
type: string
format: time
- in: query
name: created__time__lte
schema:
type: string
format: time
- in: query
name: created__time__gt
schema:
type: string
format: time
- in: query
name: created__time__lt
schema:
type: string
format: time
- in: query
name: created__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year
schema:
type: number
- in: query
name: created__iso_year__gte
schema:
type: number
- in: query
name: created__iso_year__lte
schema:
type: number
- in: query
name: created__iso_year__gt
schema:
type: number
- in: query
name: created__iso_year__lt
schema:
type: number
- in: query
name: created__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month
schema:
type: number
- in: query
name: created__month__gte
schema:
type: number
- in: query
name: created__month__lte
schema:
type: number
- in: query
name: created__month__gt
schema:
type: number
- in: query
name: created__month__lt
schema:
type: number
- in: query
name: created__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter
schema:
type: number
- in: query
name: created__quarter__gte
schema:
type: number
- in: query
name: created__quarter__lte
schema:
type: number
- in: query
name: created__quarter__gt
schema:
type: number
- in: query
name: created__quarter__lt
schema:
type: number
- in: query
name: created__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week
schema:
type: number
- in: query
name: created__week__gte
schema:
type: number
- in: query
name: created__week__lte
schema:
type: number
- in: query
name: created__week__gt
schema:
type: number
- in: query
name: created__week__lt
schema:
type: number
- in: query
name: created__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day
schema:
type: number
- in: query
name: created__iso_week_day__gte
schema:
type: number
- in: query
name: created__iso_week_day__lte
schema:
type: number
- in: query
name: created__iso_week_day__gt
schema:
type: number
- in: query
name: created__iso_week_day__lt
schema:
type: number
- in: query
name: created__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day
schema:
type: number
- in: query
name: created__day__gte
schema:
type: number
- in: query
name: created__day__lte
schema:
type: number
- in: query
name: created__day__gt
schema:
type: number
- in: query
name: created__day__lt
schema:
type: number
- in: query
name: created__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour
schema:
type: number
- in: query
name: created__hour__gte
schema:
type: number
- in: query
name: created__hour__lte
schema:
type: number
- in: query
name: created__hour__gt
schema:
type: number
- in: query
name: created__hour__lt
schema:
type: number
- in: query
name: created__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute
schema:
type: number
- in: query
name: created__minute__gte
schema:
type: number
- in: query
name: created__minute__lte
schema:
type: number
- in: query
name: created__minute__gt
schema:
type: number
- in: query
name: created__minute__lt
schema:
type: number
- in: query
name: created__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second
schema:
type: number
- in: query
name: created__second__gte
schema:
type: number
- in: query
name: created__second__lte
schema:
type: number
- in: query
name: created__second__gt
schema:
type: number
- in: query
name: created__second__lt
schema:
type: number
- in: query
name: created__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date
schema:
type: string
format: date
- in: query
name: updated__date__gte
schema:
type: string
format: date
- in: query
name: updated__date__lte
schema:
type: string
format: date
- in: query
name: updated__date__gt
schema:
type: string
format: date
- in: query
name: updated__date__lt
schema:
type: string
format: date
- in: query
name: updated__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time
schema:
type: string
format: time
- in: query
name: updated__time__gte
schema:
type: string
format: time
- in: query
name: updated__time__lte
schema:
type: string
format: time
- in: query
name: updated__time__gt
schema:
type: string
format: time
- in: query
name: updated__time__lt
schema:
type: string
format: time
- in: query
name: updated__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year
schema:
type: number
- in: query
name: updated__iso_year__gte
schema:
type: number
- in: query
name: updated__iso_year__lte
schema:
type: number
- in: query
name: updated__iso_year__gt
schema:
type: number
- in: query
name: updated__iso_year__lt
schema:
type: number
- in: query
name: updated__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month
schema:
type: number
- in: query
name: updated__month__gte
schema:
type: number
- in: query
name: updated__month__lte
schema:
type: number
- in: query
name: updated__month__gt
schema:
type: number
- in: query
name: updated__month__lt
schema:
type: number
- in: query
name: updated__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter
schema:
type: number
- in: query
name: updated__quarter__gte
schema:
type: number
- in: query
name: updated__quarter__lte
schema:
type: number
- in: query
name: updated__quarter__gt
schema:
type: number
- in: query
name: updated__quarter__lt
schema:
type: number
- in: query
name: updated__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week
schema:
type: number
- in: query
name: updated__week__gte
schema:
type: number
- in: query
name: updated__week__lte
schema:
type: number
- in: query
name: updated__week__gt
schema:
type: number
- in: query
name: updated__week__lt
schema:
type: number
- in: query
name: updated__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day
schema:
type: number
- in: query
name: updated__iso_week_day__gte
schema:
type: number
- in: query
name: updated__iso_week_day__lte
schema:
type: number
- in: query
name: updated__iso_week_day__gt
schema:
type: number
- in: query
name: updated__iso_week_day__lt
schema:
type: number
- in: query
name: updated__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day
schema:
type: number
- in: query
name: updated__day__gte
schema:
type: number
- in: query
name: updated__day__lte
schema:
type: number
- in: query
name: updated__day__gt
schema:
type: number
- in: query
name: updated__day__lt
schema:
type: number
- in: query
name: updated__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour
schema:
type: number
- in: query
name: updated__hour__gte
schema:
type: number
- in: query
name: updated__hour__lte
schema:
type: number
- in: query
name: updated__hour__gt
schema:
type: number
- in: query
name: updated__hour__lt
schema:
type: number
- in: query
name: updated__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute
schema:
type: number
- in: query
name: updated__minute__gte
schema:
type: number
- in: query
name: updated__minute__lte
schema:
type: number
- in: query
name: updated__minute__gt
schema:
type: number
- in: query
name: updated__minute__lt
schema:
type: number
- in: query
name: updated__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second
schema:
type: number
- in: query
name: updated__second__gte
schema:
type: number
- in: query
name: updated__second__lte
schema:
type: number
- in: query
name: updated__second__gt
schema:
type: number
- in: query
name: updated__second__lt
schema:
type: number
- in: query
name: updated__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: attachments__file_name__icontains
schema:
type: string
- in: query
name: attachments__file_name__contains
schema:
type: string
- in: query
name: attachments__file_name
schema:
type: string
- in: query
name: attachments__file_name__iexact
schema:
type: string
- in: query
name: attachments__file_name__startswith
schema:
type: string
- in: query
name: attachments__file_name__istartswith
schema:
type: string
- in: query
name: attachments__file_name__endswith
schema:
type: string
- in: query
name: attachments__file_name__iendswith
schema:
type: string
- in: query
name: attachments__file_name__regex
schema:
type: string
- in: query
name: attachments__file_name__iregex
schema:
type: string
- in: query
name: attachments__file_name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: correspondents__email_name__icontains
schema:
type: string
- in: query
name: correspondents__email_name__contains
schema:
type: string
- in: query
name: correspondents__email_name
schema:
type: string
- in: query
name: correspondents__email_name__iexact
schema:
type: string
- in: query
name: correspondents__email_name__startswith
schema:
type: string
- in: query
name: correspondents__email_name__istartswith
schema:
type: string
- in: query
name: correspondents__email_name__endswith
schema:
type: string
- in: query
name: correspondents__email_name__iendswith
schema:
type: string
- in: query
name: correspondents__email_name__regex
schema:
type: string
- in: query
name: correspondents__email_name__iregex
schema:
type: string
- in: query
name: correspondents__email_name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: correspondents__email_address__icontains
schema:
type: string
- in: query
name: correspondents__email_address__contains
schema:
type: string
- in: query
name: correspondents__email_address
schema:
type: string
- in: query
name: correspondents__email_address__iexact
schema:
type: string
- in: query
name: correspondents__email_address__startswith
schema:
type: string
- in: query
name: correspondents__email_address__istartswith
schema:
type: string
- in: query
name: correspondents__email_address__endswith
schema:
type: string
- in: query
name: correspondents__email_address__iendswith
schema:
type: string
- in: query
name: correspondents__email_address__regex
schema:
type: string
- in: query
name: correspondents__email_address__iregex
schema:
type: string
- in: query
name: correspondents__email_address__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mailbox__name__icontains
schema:
type: string
- in: query
name: mailbox__name__contains
schema:
type: string
- in: query
name: mailbox__name
schema:
type: string
- in: query
name: mailbox__name__iexact
schema:
type: string
- in: query
name: mailbox__name__startswith
schema:
type: string
- in: query
name: mailbox__name__istartswith
schema:
type: string
- in: query
name: mailbox__name__endswith
schema:
type: string
- in: query
name: mailbox__name__iendswith
schema:
type: string
- in: query
name: mailbox__name__regex
schema:
type: string
- in: query
name: mailbox__name__iregex
schema:
type: string
- in: query
name: mailbox__name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mailbox__account__mail_address__icontains
schema:
type: string
- in: query
name: mailbox__account__mail_address__contains
schema:
type: string
- in: query
name: mailbox__account__mail_address
schema:
type: string
- in: query
name: mailbox__account__mail_address__iexact
schema:
type: string
- in: query
name: mailbox__account__mail_address__startswith
schema:
type: string
- in: query
name: mailbox__account__mail_address__istartswith
schema:
type: string
- in: query
name: mailbox__account__mail_address__endswith
schema:
type: string
- in: query
name: mailbox__account__mail_address__iendswith
schema:
type: string
- in: query
name: mailbox__account__mail_address__regex
schema:
type: string
- in: query
name: mailbox__account__mail_address__iregex
schema:
type: string
- in: query
name: mailbox__account__mail_address__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mailbox__account__mail_host__icontains
schema:
type: string
- in: query
name: mailbox__account__mail_host__contains
schema:
type: string
- in: query
name: mailbox__account__mail_host
schema:
type: string
- in: query
name: mailbox__account__mail_host__iexact
schema:
type: string
- in: query
name: mailbox__account__mail_host__startswith
schema:
type: string
- in: query
name: mailbox__account__mail_host__istartswith
schema:
type: string
- in: query
name: mailbox__account__mail_host__endswith
schema:
type: string
- in: query
name: mailbox__account__mail_host__iendswith
schema:
type: string
- in: query
name: mailbox__account__mail_host__regex
schema:
type: string
- in: query
name: mailbox__account__mail_host__iregex
schema:
type: string
- in: query
name: mailbox__account__mail_host__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: search
schema:
type: string
- in: query
name: correspondent_mention
schema:
type: string
- in: query
name: correspondent_mention__icontains
schema:
type: string
- in: query
name: correspondent_mention__in
schema:
type: array
items:
type: string
enum:
- bcc
- cc
- delivered-to
- disposition-notification-to
- envelope-to
- from
- reply-To
- resent-bcc
- resent-cc
- resent-from
- resent-reply-to
- resent-sender
- resent-to
- return-path
- return-receipt-to
- sender
- to
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: headers__regex
schema:
type: string
- in: query
name: headers__has_key
schema:
type: string
- in: query
name: headers__has_keys
schema:
type: array
items:
nullable: true
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: headers__has_any_keys
schema:
type: array
items:
nullable: true
description: Multiple values may be separated by commas.
explode: false
style: form
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBaseEmailList'
description: ''
/api/v1/emails/{id}:
get:
operationId: v1_emails_retrieve
description: Retrieves a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this email.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FullEmail'
description: ''
delete:
operationId: v1_emails_destroy
description: Deletes a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this email.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/v1/emails/{id}/download:
get:
operationId: v1_emails_download_retrieve
description: Downloads an email's eml file.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this email.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
message/rfc822:
schema:
type: string
format: binary
description: 'content-disposition: attachment'
/api/v1/emails/{id}/full-conversation:
get:
operationId: v1_emails_full_conversation_list
description: Lists the conversation involving an email.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this email.
required: true
- in: query
name: message_id__icontains
schema:
type: string
- in: query
name: message_id__contains
schema:
type: string
- in: query
name: message_id
schema:
type: string
- in: query
name: message_id__iexact
schema:
type: string
- in: query
name: message_id__startswith
schema:
type: string
- in: query
name: message_id__istartswith
schema:
type: string
- in: query
name: message_id__endswith
schema:
type: string
- in: query
name: message_id__iendswith
schema:
type: string
- in: query
name: message_id__regex
schema:
type: string
- in: query
name: message_id__iregex
schema:
type: string
- in: query
name: message_id__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__date
schema:
type: string
format: date
- in: query
name: datetime__date__gte
schema:
type: string
format: date
- in: query
name: datetime__date__lte
schema:
type: string
format: date
- in: query
name: datetime__date__gt
schema:
type: string
format: date
- in: query
name: datetime__date__lt
schema:
type: string
format: date
- in: query
name: datetime__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__time
schema:
type: string
format: time
- in: query
name: datetime__time__gte
schema:
type: string
format: time
- in: query
name: datetime__time__lte
schema:
type: string
format: time
- in: query
name: datetime__time__gt
schema:
type: string
format: time
- in: query
name: datetime__time__lt
schema:
type: string
format: time
- in: query
name: datetime__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__iso_year
schema:
type: number
- in: query
name: datetime__iso_year__gte
schema:
type: number
- in: query
name: datetime__iso_year__lte
schema:
type: number
- in: query
name: datetime__iso_year__gt
schema:
type: number
- in: query
name: datetime__iso_year__lt
schema:
type: number
- in: query
name: datetime__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__month
schema:
type: number
- in: query
name: datetime__month__gte
schema:
type: number
- in: query
name: datetime__month__lte
schema:
type: number
- in: query
name: datetime__month__gt
schema:
type: number
- in: query
name: datetime__month__lt
schema:
type: number
- in: query
name: datetime__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__quarter
schema:
type: number
- in: query
name: datetime__quarter__gte
schema:
type: number
- in: query
name: datetime__quarter__lte
schema:
type: number
- in: query
name: datetime__quarter__gt
schema:
type: number
- in: query
name: datetime__quarter__lt
schema:
type: number
- in: query
name: datetime__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__week
schema:
type: number
- in: query
name: datetime__week__gte
schema:
type: number
- in: query
name: datetime__week__lte
schema:
type: number
- in: query
name: datetime__week__gt
schema:
type: number
- in: query
name: datetime__week__lt
schema:
type: number
- in: query
name: datetime__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__iso_week_day
schema:
type: number
- in: query
name: datetime__iso_week_day__gte
schema:
type: number
- in: query
name: datetime__iso_week_day__lte
schema:
type: number
- in: query
name: datetime__iso_week_day__gt
schema:
type: number
- in: query
name: datetime__iso_week_day__lt
schema:
type: number
- in: query
name: datetime__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__day
schema:
type: number
- in: query
name: datetime__day__gte
schema:
type: number
- in: query
name: datetime__day__lte
schema:
type: number
- in: query
name: datetime__day__gt
schema:
type: number
- in: query
name: datetime__day__lt
schema:
type: number
- in: query
name: datetime__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__hour
schema:
type: number
- in: query
name: datetime__hour__gte
schema:
type: number
- in: query
name: datetime__hour__lte
schema:
type: number
- in: query
name: datetime__hour__gt
schema:
type: number
- in: query
name: datetime__hour__lt
schema:
type: number
- in: query
name: datetime__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__minute
schema:
type: number
- in: query
name: datetime__minute__gte
schema:
type: number
- in: query
name: datetime__minute__lte
schema:
type: number
- in: query
name: datetime__minute__gt
schema:
type: number
- in: query
name: datetime__minute__lt
schema:
type: number
- in: query
name: datetime__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__second
schema:
type: number
- in: query
name: datetime__second__gte
schema:
type: number
- in: query
name: datetime__second__lte
schema:
type: number
- in: query
name: datetime__second__gt
schema:
type: number
- in: query
name: datetime__second__lt
schema:
type: number
- in: query
name: datetime__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datetime__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: subject__icontains
schema:
type: string
- in: query
name: subject__contains
schema:
type: string
- in: query
name: subject
schema:
type: string
- in: query
name: subject__iexact
schema:
type: string
- in: query
name: subject__startswith
schema:
type: string
- in: query
name: subject__istartswith
schema:
type: string
- in: query
name: subject__endswith
schema:
type: string
- in: query
name: subject__iendswith
schema:
type: string
- in: query
name: subject__regex
schema:
type: string
- in: query
name: subject__iregex
schema:
type: string
- in: query
name: subject__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: plain_bodytext__icontains
schema:
type: string
- in: query
name: plain_bodytext__contains
schema:
type: string
- in: query
name: plain_bodytext
schema:
type: string
- in: query
name: plain_bodytext__iexact
schema:
type: string
- in: query
name: plain_bodytext__startswith
schema:
type: string
- in: query
name: plain_bodytext__istartswith
schema:
type: string
- in: query
name: plain_bodytext__endswith
schema:
type: string
- in: query
name: plain_bodytext__iendswith
schema:
type: string
- in: query
name: plain_bodytext__regex
schema:
type: string
- in: query
name: plain_bodytext__iregex
schema:
type: string
- in: query
name: plain_bodytext__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: html_bodytext__icontains
schema:
type: string
- in: query
name: html_bodytext__contains
schema:
type: string
- in: query
name: html_bodytext
schema:
type: string
- in: query
name: html_bodytext__iexact
schema:
type: string
- in: query
name: html_bodytext__startswith
schema:
type: string
- in: query
name: html_bodytext__istartswith
schema:
type: string
- in: query
name: html_bodytext__endswith
schema:
type: string
- in: query
name: html_bodytext__iendswith
schema:
type: string
- in: query
name: html_bodytext__regex
schema:
type: string
- in: query
name: html_bodytext__iregex
schema:
type: string
- in: query
name: html_bodytext__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datasize__lte
schema:
type: integer
- in: query
name: datasize__gte
schema:
type: integer
- in: query
name: datasize__lt
schema:
type: integer
- in: query
name: datasize__gt
schema:
type: integer
- in: query
name: datasize
schema:
type: integer
- in: query
name: datasize__in
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: datasize__range
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: x_spam_flag
schema:
type: boolean
- in: query
name: is_favorite
schema:
type: boolean
- in: query
name: created__date
schema:
type: string
format: date
- in: query
name: created__date__gte
schema:
type: string
format: date
- in: query
name: created__date__lte
schema:
type: string
format: date
- in: query
name: created__date__gt
schema:
type: string
format: date
- in: query
name: created__date__lt
schema:
type: string
format: date
- in: query
name: created__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time
schema:
type: string
format: time
- in: query
name: created__time__gte
schema:
type: string
format: time
- in: query
name: created__time__lte
schema:
type: string
format: time
- in: query
name: created__time__gt
schema:
type: string
format: time
- in: query
name: created__time__lt
schema:
type: string
format: time
- in: query
name: created__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year
schema:
type: number
- in: query
name: created__iso_year__gte
schema:
type: number
- in: query
name: created__iso_year__lte
schema:
type: number
- in: query
name: created__iso_year__gt
schema:
type: number
- in: query
name: created__iso_year__lt
schema:
type: number
- in: query
name: created__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month
schema:
type: number
- in: query
name: created__month__gte
schema:
type: number
- in: query
name: created__month__lte
schema:
type: number
- in: query
name: created__month__gt
schema:
type: number
- in: query
name: created__month__lt
schema:
type: number
- in: query
name: created__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter
schema:
type: number
- in: query
name: created__quarter__gte
schema:
type: number
- in: query
name: created__quarter__lte
schema:
type: number
- in: query
name: created__quarter__gt
schema:
type: number
- in: query
name: created__quarter__lt
schema:
type: number
- in: query
name: created__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week
schema:
type: number
- in: query
name: created__week__gte
schema:
type: number
- in: query
name: created__week__lte
schema:
type: number
- in: query
name: created__week__gt
schema:
type: number
- in: query
name: created__week__lt
schema:
type: number
- in: query
name: created__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day
schema:
type: number
- in: query
name: created__iso_week_day__gte
schema:
type: number
- in: query
name: created__iso_week_day__lte
schema:
type: number
- in: query
name: created__iso_week_day__gt
schema:
type: number
- in: query
name: created__iso_week_day__lt
schema:
type: number
- in: query
name: created__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day
schema:
type: number
- in: query
name: created__day__gte
schema:
type: number
- in: query
name: created__day__lte
schema:
type: number
- in: query
name: created__day__gt
schema:
type: number
- in: query
name: created__day__lt
schema:
type: number
- in: query
name: created__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour
schema:
type: number
- in: query
name: created__hour__gte
schema:
type: number
- in: query
name: created__hour__lte
schema:
type: number
- in: query
name: created__hour__gt
schema:
type: number
- in: query
name: created__hour__lt
schema:
type: number
- in: query
name: created__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute
schema:
type: number
- in: query
name: created__minute__gte
schema:
type: number
- in: query
name: created__minute__lte
schema:
type: number
- in: query
name: created__minute__gt
schema:
type: number
- in: query
name: created__minute__lt
schema:
type: number
- in: query
name: created__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second
schema:
type: number
- in: query
name: created__second__gte
schema:
type: number
- in: query
name: created__second__lte
schema:
type: number
- in: query
name: created__second__gt
schema:
type: number
- in: query
name: created__second__lt
schema:
type: number
- in: query
name: created__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date
schema:
type: string
format: date
- in: query
name: updated__date__gte
schema:
type: string
format: date
- in: query
name: updated__date__lte
schema:
type: string
format: date
- in: query
name: updated__date__gt
schema:
type: string
format: date
- in: query
name: updated__date__lt
schema:
type: string
format: date
- in: query
name: updated__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time
schema:
type: string
format: time
- in: query
name: updated__time__gte
schema:
type: string
format: time
- in: query
name: updated__time__lte
schema:
type: string
format: time
- in: query
name: updated__time__gt
schema:
type: string
format: time
- in: query
name: updated__time__lt
schema:
type: string
format: time
- in: query
name: updated__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year
schema:
type: number
- in: query
name: updated__iso_year__gte
schema:
type: number
- in: query
name: updated__iso_year__lte
schema:
type: number
- in: query
name: updated__iso_year__gt
schema:
type: number
- in: query
name: updated__iso_year__lt
schema:
type: number
- in: query
name: updated__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month
schema:
type: number
- in: query
name: updated__month__gte
schema:
type: number
- in: query
name: updated__month__lte
schema:
type: number
- in: query
name: updated__month__gt
schema:
type: number
- in: query
name: updated__month__lt
schema:
type: number
- in: query
name: updated__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter
schema:
type: number
- in: query
name: updated__quarter__gte
schema:
type: number
- in: query
name: updated__quarter__lte
schema:
type: number
- in: query
name: updated__quarter__gt
schema:
type: number
- in: query
name: updated__quarter__lt
schema:
type: number
- in: query
name: updated__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week
schema:
type: number
- in: query
name: updated__week__gte
schema:
type: number
- in: query
name: updated__week__lte
schema:
type: number
- in: query
name: updated__week__gt
schema:
type: number
- in: query
name: updated__week__lt
schema:
type: number
- in: query
name: updated__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day
schema:
type: number
- in: query
name: updated__iso_week_day__gte
schema:
type: number
- in: query
name: updated__iso_week_day__lte
schema:
type: number
- in: query
name: updated__iso_week_day__gt
schema:
type: number
- in: query
name: updated__iso_week_day__lt
schema:
type: number
- in: query
name: updated__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day
schema:
type: number
- in: query
name: updated__day__gte
schema:
type: number
- in: query
name: updated__day__lte
schema:
type: number
- in: query
name: updated__day__gt
schema:
type: number
- in: query
name: updated__day__lt
schema:
type: number
- in: query
name: updated__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour
schema:
type: number
- in: query
name: updated__hour__gte
schema:
type: number
- in: query
name: updated__hour__lte
schema:
type: number
- in: query
name: updated__hour__gt
schema:
type: number
- in: query
name: updated__hour__lt
schema:
type: number
- in: query
name: updated__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute
schema:
type: number
- in: query
name: updated__minute__gte
schema:
type: number
- in: query
name: updated__minute__lte
schema:
type: number
- in: query
name: updated__minute__gt
schema:
type: number
- in: query
name: updated__minute__lt
schema:
type: number
- in: query
name: updated__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second
schema:
type: number
- in: query
name: updated__second__gte
schema:
type: number
- in: query
name: updated__second__lte
schema:
type: number
- in: query
name: updated__second__gt
schema:
type: number
- in: query
name: updated__second__lt
schema:
type: number
- in: query
name: updated__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: attachments__file_name__icontains
schema:
type: string
- in: query
name: attachments__file_name__contains
schema:
type: string
- in: query
name: attachments__file_name
schema:
type: string
- in: query
name: attachments__file_name__iexact
schema:
type: string
- in: query
name: attachments__file_name__startswith
schema:
type: string
- in: query
name: attachments__file_name__istartswith
schema:
type: string
- in: query
name: attachments__file_name__endswith
schema:
type: string
- in: query
name: attachments__file_name__iendswith
schema:
type: string
- in: query
name: attachments__file_name__regex
schema:
type: string
- in: query
name: attachments__file_name__iregex
schema:
type: string
- in: query
name: attachments__file_name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: correspondents__email_name__icontains
schema:
type: string
- in: query
name: correspondents__email_name__contains
schema:
type: string
- in: query
name: correspondents__email_name
schema:
type: string
- in: query
name: correspondents__email_name__iexact
schema:
type: string
- in: query
name: correspondents__email_name__startswith
schema:
type: string
- in: query
name: correspondents__email_name__istartswith
schema:
type: string
- in: query
name: correspondents__email_name__endswith
schema:
type: string
- in: query
name: correspondents__email_name__iendswith
schema:
type: string
- in: query
name: correspondents__email_name__regex
schema:
type: string
- in: query
name: correspondents__email_name__iregex
schema:
type: string
- in: query
name: correspondents__email_name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: correspondents__email_address__icontains
schema:
type: string
- in: query
name: correspondents__email_address__contains
schema:
type: string
- in: query
name: correspondents__email_address
schema:
type: string
- in: query
name: correspondents__email_address__iexact
schema:
type: string
- in: query
name: correspondents__email_address__startswith
schema:
type: string
- in: query
name: correspondents__email_address__istartswith
schema:
type: string
- in: query
name: correspondents__email_address__endswith
schema:
type: string
- in: query
name: correspondents__email_address__iendswith
schema:
type: string
- in: query
name: correspondents__email_address__regex
schema:
type: string
- in: query
name: correspondents__email_address__iregex
schema:
type: string
- in: query
name: correspondents__email_address__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mailbox__name__icontains
schema:
type: string
- in: query
name: mailbox__name__contains
schema:
type: string
- in: query
name: mailbox__name
schema:
type: string
- in: query
name: mailbox__name__iexact
schema:
type: string
- in: query
name: mailbox__name__startswith
schema:
type: string
- in: query
name: mailbox__name__istartswith
schema:
type: string
- in: query
name: mailbox__name__endswith
schema:
type: string
- in: query
name: mailbox__name__iendswith
schema:
type: string
- in: query
name: mailbox__name__regex
schema:
type: string
- in: query
name: mailbox__name__iregex
schema:
type: string
- in: query
name: mailbox__name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mailbox__account__mail_address__icontains
schema:
type: string
- in: query
name: mailbox__account__mail_address__contains
schema:
type: string
- in: query
name: mailbox__account__mail_address
schema:
type: string
- in: query
name: mailbox__account__mail_address__iexact
schema:
type: string
- in: query
name: mailbox__account__mail_address__startswith
schema:
type: string
- in: query
name: mailbox__account__mail_address__istartswith
schema:
type: string
- in: query
name: mailbox__account__mail_address__endswith
schema:
type: string
- in: query
name: mailbox__account__mail_address__iendswith
schema:
type: string
- in: query
name: mailbox__account__mail_address__regex
schema:
type: string
- in: query
name: mailbox__account__mail_address__iregex
schema:
type: string
- in: query
name: mailbox__account__mail_address__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mailbox__account__mail_host__icontains
schema:
type: string
- in: query
name: mailbox__account__mail_host__contains
schema:
type: string
- in: query
name: mailbox__account__mail_host
schema:
type: string
- in: query
name: mailbox__account__mail_host__iexact
schema:
type: string
- in: query
name: mailbox__account__mail_host__startswith
schema:
type: string
- in: query
name: mailbox__account__mail_host__istartswith
schema:
type: string
- in: query
name: mailbox__account__mail_host__endswith
schema:
type: string
- in: query
name: mailbox__account__mail_host__iendswith
schema:
type: string
- in: query
name: mailbox__account__mail_host__regex
schema:
type: string
- in: query
name: mailbox__account__mail_host__iregex
schema:
type: string
- in: query
name: mailbox__account__mail_host__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: search
schema:
type: string
- in: query
name: correspondent_mention
schema:
type: string
- in: query
name: correspondent_mention__icontains
schema:
type: string
- in: query
name: correspondent_mention__in
schema:
type: array
items:
type: string
enum:
- bcc
- cc
- delivered-to
- disposition-notification-to
- envelope-to
- from
- reply-To
- resent-bcc
- resent-cc
- resent-from
- resent-reply-to
- resent-sender
- resent-to
- return-path
- return-receipt-to
- sender
- to
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: headers__regex
schema:
type: string
- in: query
name: headers__has_key
schema:
type: string
- in: query
name: headers__has_keys
schema:
type: array
items:
nullable: true
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: headers__has_any_keys
schema:
type: array
items:
nullable: true
description: Multiple values may be separated by commas.
explode: false
style: form
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBaseEmailList'
description: ''
/api/v1/emails/{id}/reprocess:
post:
operationId: v1_emails_reprocess_create
description: Reprocesses an email using the stored data.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this email.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reprocess_email_response'
description: ''
/api/v1/emails/{id}/restore:
post:
operationId: v1_emails_restore_create
description: Restores an email to its mailbox on the server.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this email.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: string
description: Restoring was successful
'400':
content:
application/json:
schema:
type: string
description: Restoring failed
'404':
content:
application/json:
schema:
type: string
description: The eml file was not found
/api/v1/emails/{id}/thumbnail:
get:
operationId: v1_emails_thumbnail_retrieve
description: Downloads a single emails thumbnail.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this email.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
text/html:
schema:
type: string
format: binary
description: 'content-disposition: inline, x-frame-options: SAMEORIGIN,
content-security-policy: frame-ancestors ''self'''
/api/v1/emails/{id}/toggle-favorite:
post:
operationId: v1_emails_toggle_favorite_create
description: Toggles the favorite status of an instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this email.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/toggle_favorite_serializer'
description: Message indicating status change.
/api/v1/emails/download:
get:
operationId: v1_emails_batch_download_retrieve
description: Downloads multiple email's eml files.
parameters:
- in: query
name: id
schema:
type: array
items:
type: integer
description: A list of integer values identifying the emails. Duplicates are
ignored. Accepts both id=1,2,3 and id=1&id=2&id=3 notation
required: true
explode: true
- in: query
name: file_format
schema:
type: string
enum:
- babyl
- mbox
- mmdf
- zip[eml]
- zip[maildir]
- zip[mh]
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: string
format: binary
description: 'content-disposition: attachment'
/api/v1/mailboxes:
get:
operationId: v1_mailboxes_list
description: Lists all instances matching the filter.
parameters:
- in: query
name: name__icontains
schema:
type: string
- in: query
name: name__contains
schema:
type: string
- in: query
name: name
schema:
type: string
- in: query
name: name__iexact
schema:
type: string
- in: query
name: name__startswith
schema:
type: string
- in: query
name: name__istartswith
schema:
type: string
- in: query
name: name__endswith
schema:
type: string
- in: query
name: name__iendswith
schema:
type: string
- in: query
name: name__regex
schema:
type: string
- in: query
name: name__iregex
schema:
type: string
- in: query
name: name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: type__icontains
schema:
type: string
- in: query
name: type__iexact
schema:
type: string
- in: query
name: type__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: save_to_eml
schema:
type: boolean
- in: query
name: save_attachments
schema:
type: boolean
- in: query
name: is_healthy
schema:
type: boolean
- in: query
name: last_error__icontains
schema:
type: string
- in: query
name: last_error__contains
schema:
type: string
- in: query
name: last_error
schema:
type: string
- in: query
name: last_error__iexact
schema:
type: string
- in: query
name: last_error__startswith
schema:
type: string
- in: query
name: last_error__istartswith
schema:
type: string
- in: query
name: last_error__endswith
schema:
type: string
- in: query
name: last_error__iendswith
schema:
type: string
- in: query
name: last_error__regex
schema:
type: string
- in: query
name: last_error__iregex
schema:
type: string
- in: query
name: last_error__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__date
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__gte
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__lte
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__gt
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__lt
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__time
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__gte
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__lte
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__gt
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__lt
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_year
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__gte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__lte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__gt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__lt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__month
schema:
type: number
- in: query
name: last_error_occurred_at__month__gte
schema:
type: number
- in: query
name: last_error_occurred_at__month__lte
schema:
type: number
- in: query
name: last_error_occurred_at__month__gt
schema:
type: number
- in: query
name: last_error_occurred_at__month__lt
schema:
type: number
- in: query
name: last_error_occurred_at__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__quarter
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__gte
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__lte
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__gt
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__lt
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__week
schema:
type: number
- in: query
name: last_error_occurred_at__week__gte
schema:
type: number
- in: query
name: last_error_occurred_at__week__lte
schema:
type: number
- in: query
name: last_error_occurred_at__week__gt
schema:
type: number
- in: query
name: last_error_occurred_at__week__lt
schema:
type: number
- in: query
name: last_error_occurred_at__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_week_day
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__gte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__lte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__gt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__lt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__day
schema:
type: number
- in: query
name: last_error_occurred_at__day__gte
schema:
type: number
- in: query
name: last_error_occurred_at__day__lte
schema:
type: number
- in: query
name: last_error_occurred_at__day__gt
schema:
type: number
- in: query
name: last_error_occurred_at__day__lt
schema:
type: number
- in: query
name: last_error_occurred_at__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__hour
schema:
type: number
- in: query
name: last_error_occurred_at__hour__gte
schema:
type: number
- in: query
name: last_error_occurred_at__hour__lte
schema:
type: number
- in: query
name: last_error_occurred_at__hour__gt
schema:
type: number
- in: query
name: last_error_occurred_at__hour__lt
schema:
type: number
- in: query
name: last_error_occurred_at__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__minute
schema:
type: number
- in: query
name: last_error_occurred_at__minute__gte
schema:
type: number
- in: query
name: last_error_occurred_at__minute__lte
schema:
type: number
- in: query
name: last_error_occurred_at__minute__gt
schema:
type: number
- in: query
name: last_error_occurred_at__minute__lt
schema:
type: number
- in: query
name: last_error_occurred_at__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__second
schema:
type: number
- in: query
name: last_error_occurred_at__second__gte
schema:
type: number
- in: query
name: last_error_occurred_at__second__lte
schema:
type: number
- in: query
name: last_error_occurred_at__second__gt
schema:
type: number
- in: query
name: last_error_occurred_at__second__lt
schema:
type: number
- in: query
name: last_error_occurred_at__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: is_favorite
schema:
type: boolean
- in: query
name: created__date
schema:
type: string
format: date
- in: query
name: created__date__gte
schema:
type: string
format: date
- in: query
name: created__date__lte
schema:
type: string
format: date
- in: query
name: created__date__gt
schema:
type: string
format: date
- in: query
name: created__date__lt
schema:
type: string
format: date
- in: query
name: created__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time
schema:
type: string
format: time
- in: query
name: created__time__gte
schema:
type: string
format: time
- in: query
name: created__time__lte
schema:
type: string
format: time
- in: query
name: created__time__gt
schema:
type: string
format: time
- in: query
name: created__time__lt
schema:
type: string
format: time
- in: query
name: created__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year
schema:
type: number
- in: query
name: created__iso_year__gte
schema:
type: number
- in: query
name: created__iso_year__lte
schema:
type: number
- in: query
name: created__iso_year__gt
schema:
type: number
- in: query
name: created__iso_year__lt
schema:
type: number
- in: query
name: created__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month
schema:
type: number
- in: query
name: created__month__gte
schema:
type: number
- in: query
name: created__month__lte
schema:
type: number
- in: query
name: created__month__gt
schema:
type: number
- in: query
name: created__month__lt
schema:
type: number
- in: query
name: created__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter
schema:
type: number
- in: query
name: created__quarter__gte
schema:
type: number
- in: query
name: created__quarter__lte
schema:
type: number
- in: query
name: created__quarter__gt
schema:
type: number
- in: query
name: created__quarter__lt
schema:
type: number
- in: query
name: created__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week
schema:
type: number
- in: query
name: created__week__gte
schema:
type: number
- in: query
name: created__week__lte
schema:
type: number
- in: query
name: created__week__gt
schema:
type: number
- in: query
name: created__week__lt
schema:
type: number
- in: query
name: created__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day
schema:
type: number
- in: query
name: created__iso_week_day__gte
schema:
type: number
- in: query
name: created__iso_week_day__lte
schema:
type: number
- in: query
name: created__iso_week_day__gt
schema:
type: number
- in: query
name: created__iso_week_day__lt
schema:
type: number
- in: query
name: created__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day
schema:
type: number
- in: query
name: created__day__gte
schema:
type: number
- in: query
name: created__day__lte
schema:
type: number
- in: query
name: created__day__gt
schema:
type: number
- in: query
name: created__day__lt
schema:
type: number
- in: query
name: created__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour
schema:
type: number
- in: query
name: created__hour__gte
schema:
type: number
- in: query
name: created__hour__lte
schema:
type: number
- in: query
name: created__hour__gt
schema:
type: number
- in: query
name: created__hour__lt
schema:
type: number
- in: query
name: created__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute
schema:
type: number
- in: query
name: created__minute__gte
schema:
type: number
- in: query
name: created__minute__lte
schema:
type: number
- in: query
name: created__minute__gt
schema:
type: number
- in: query
name: created__minute__lt
schema:
type: number
- in: query
name: created__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second
schema:
type: number
- in: query
name: created__second__gte
schema:
type: number
- in: query
name: created__second__lte
schema:
type: number
- in: query
name: created__second__gt
schema:
type: number
- in: query
name: created__second__lt
schema:
type: number
- in: query
name: created__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date
schema:
type: string
format: date
- in: query
name: updated__date__gte
schema:
type: string
format: date
- in: query
name: updated__date__lte
schema:
type: string
format: date
- in: query
name: updated__date__gt
schema:
type: string
format: date
- in: query
name: updated__date__lt
schema:
type: string
format: date
- in: query
name: updated__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time
schema:
type: string
format: time
- in: query
name: updated__time__gte
schema:
type: string
format: time
- in: query
name: updated__time__lte
schema:
type: string
format: time
- in: query
name: updated__time__gt
schema:
type: string
format: time
- in: query
name: updated__time__lt
schema:
type: string
format: time
- in: query
name: updated__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year
schema:
type: number
- in: query
name: updated__iso_year__gte
schema:
type: number
- in: query
name: updated__iso_year__lte
schema:
type: number
- in: query
name: updated__iso_year__gt
schema:
type: number
- in: query
name: updated__iso_year__lt
schema:
type: number
- in: query
name: updated__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month
schema:
type: number
- in: query
name: updated__month__gte
schema:
type: number
- in: query
name: updated__month__lte
schema:
type: number
- in: query
name: updated__month__gt
schema:
type: number
- in: query
name: updated__month__lt
schema:
type: number
- in: query
name: updated__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter
schema:
type: number
- in: query
name: updated__quarter__gte
schema:
type: number
- in: query
name: updated__quarter__lte
schema:
type: number
- in: query
name: updated__quarter__gt
schema:
type: number
- in: query
name: updated__quarter__lt
schema:
type: number
- in: query
name: updated__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week
schema:
type: number
- in: query
name: updated__week__gte
schema:
type: number
- in: query
name: updated__week__lte
schema:
type: number
- in: query
name: updated__week__gt
schema:
type: number
- in: query
name: updated__week__lt
schema:
type: number
- in: query
name: updated__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day
schema:
type: number
- in: query
name: updated__iso_week_day__gte
schema:
type: number
- in: query
name: updated__iso_week_day__lte
schema:
type: number
- in: query
name: updated__iso_week_day__gt
schema:
type: number
- in: query
name: updated__iso_week_day__lt
schema:
type: number
- in: query
name: updated__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day
schema:
type: number
- in: query
name: updated__day__gte
schema:
type: number
- in: query
name: updated__day__lte
schema:
type: number
- in: query
name: updated__day__gt
schema:
type: number
- in: query
name: updated__day__lt
schema:
type: number
- in: query
name: updated__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour
schema:
type: number
- in: query
name: updated__hour__gte
schema:
type: number
- in: query
name: updated__hour__lte
schema:
type: number
- in: query
name: updated__hour__gt
schema:
type: number
- in: query
name: updated__hour__lt
schema:
type: number
- in: query
name: updated__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute
schema:
type: number
- in: query
name: updated__minute__gte
schema:
type: number
- in: query
name: updated__minute__lte
schema:
type: number
- in: query
name: updated__minute__gt
schema:
type: number
- in: query
name: updated__minute__lt
schema:
type: number
- in: query
name: updated__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second
schema:
type: number
- in: query
name: updated__second__gte
schema:
type: number
- in: query
name: updated__second__lte
schema:
type: number
- in: query
name: updated__second__gt
schema:
type: number
- in: query
name: updated__second__lt
schema:
type: number
- in: query
name: updated__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: account__mail_address__icontains
schema:
type: string
- in: query
name: account__mail_address__contains
schema:
type: string
- in: query
name: account__mail_address
schema:
type: string
- in: query
name: account__mail_address__iexact
schema:
type: string
- in: query
name: account__mail_address__startswith
schema:
type: string
- in: query
name: account__mail_address__istartswith
schema:
type: string
- in: query
name: account__mail_address__endswith
schema:
type: string
- in: query
name: account__mail_address__iendswith
schema:
type: string
- in: query
name: account__mail_address__regex
schema:
type: string
- in: query
name: account__mail_address__iregex
schema:
type: string
- in: query
name: account__mail_address__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: account__mail_host__icontains
schema:
type: string
- in: query
name: account__mail_host__contains
schema:
type: string
- in: query
name: account__mail_host
schema:
type: string
- in: query
name: account__mail_host__iexact
schema:
type: string
- in: query
name: account__mail_host__startswith
schema:
type: string
- in: query
name: account__mail_host__istartswith
schema:
type: string
- in: query
name: account__mail_host__endswith
schema:
type: string
- in: query
name: account__mail_host__iendswith
schema:
type: string
- in: query
name: account__mail_host__regex
schema:
type: string
- in: query
name: account__mail_host__iregex
schema:
type: string
- in: query
name: account__mail_host__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: account__protocol__icontains
schema:
type: string
- in: query
name: account__protocol__iexact
schema:
type: string
- in: query
name: account__protocol__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: account__is_healthy
schema:
type: boolean
- in: query
name: search
schema:
type: string
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedMailboxWithDaemonList'
description: ''
/api/v1/mailboxes/{id}:
get:
operationId: v1_mailboxes_retrieve
description: Retrieves a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MailboxWithDaemon'
description: ''
put:
operationId: v1_mailboxes_update
description: Updates a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MailboxWithDaemon'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MailboxWithDaemon'
multipart/form-data:
schema:
$ref: '#/components/schemas/MailboxWithDaemon'
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MailboxWithDaemon'
description: ''
patch:
operationId: v1_mailboxes_partial_update
description: |-
Viewset for the :class:`core.models.Mailbox.Mailbox`.
Provides all but the create action.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedMailboxWithDaemon'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedMailboxWithDaemon'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedMailboxWithDaemon'
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MailboxWithDaemon'
description: ''
delete:
operationId: v1_mailboxes_destroy
description: Deletes a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/v1/mailboxes/{id}/download:
get:
operationId: v1_mailboxes_download_retrieve
description: Downloads all emails of a mailbox.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
- in: query
name: file_format
schema:
type: string
enum:
- babyl
- mbox
- mmdf
- zip[eml]
- zip[maildir]
- zip[mh]
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: string
format: binary
description: 'content-disposition: attachment'
/api/v1/mailboxes/{id}/fetch:
post:
operationId: v1_mailboxes_fetch_create
description: Fetches the emails from a mailbox based on the given criterion.
Only criteria available for that mailbox are accepted.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/fetch_criterion_data'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/fetch_criterion_data'
multipart/form-data:
schema:
$ref: '#/components/schemas/fetch_criterion_data'
required: true
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/fetch_mailbox_response'
description: ''
/api/v1/mailboxes/{id}/fetching-options:
get:
operationId: v1_mailboxes_fetching_options_retrieve
description: Lists all available fetching criteria for a mailbox.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: string
format: json-pointer
description: ''
/api/v1/mailboxes/{id}/test:
post:
operationId: v1_mailboxes_test_create
description: Tests a mailbox.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/test_mailbox_response'
description: ''
/api/v1/mailboxes/{id}/toggle-favorite:
post:
operationId: v1_mailboxes_toggle_favorite_create
description: Toggles the favorite status of an instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/toggle_favorite_serializer'
description: Message indicating status change.
/api/v1/mailboxes/{id}/upload:
post:
operationId: v1_mailboxes_upload_create
description: Upload emails in a file to a mailbox instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this mailbox.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UploadEmail'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UploadEmail'
multipart/form-data:
schema:
$ref: '#/components/schemas/UploadEmail'
required: true
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/upload_emails_mailbox_response'
description: ''
/api/v1/mailboxes/download:
get:
operationId: v1_mailboxes_batch_download_retrieve
description: Downloads all emails of multiple mailbox instances.
parameters:
- in: query
name: id
schema:
type: array
items:
type: integer
description: A list of integer values identifying the mailboxes. Duplicates
are ignored. Accepts both id=1,2,3 and id=1&id=2&id=3 notation
required: true
explode: true
- in: query
name: file_format
schema:
type: string
enum:
- babyl
- mbox
- mmdf
- zip[eml]
- zip[maildir]
- zip[mh]
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: string
format: binary
description: 'content-disposition: attachment'
/api/v1/routines:
get:
operationId: v1_routines_list
description: Lists all instances matching the filter.
parameters:
- in: query
name: uuid
schema:
type: string
format: uuid
- in: query
name: uuid__contains
schema:
type: string
format: uuid
- in: query
name: fetching_criterion__icontains
schema:
type: string
- in: query
name: fetching_criterion__iexact
schema:
type: string
- in: query
name: fetching_criterion__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: fetching_criterion_arg__icontains
schema:
type: string
- in: query
name: fetching_criterion_arg__contains
schema:
type: string
- in: query
name: fetching_criterion_arg
schema:
type: string
- in: query
name: fetching_criterion_arg__iexact
schema:
type: string
- in: query
name: fetching_criterion_arg__startswith
schema:
type: string
- in: query
name: fetching_criterion_arg__istartswith
schema:
type: string
- in: query
name: fetching_criterion_arg__endswith
schema:
type: string
- in: query
name: fetching_criterion_arg__iendswith
schema:
type: string
- in: query
name: fetching_criterion_arg__regex
schema:
type: string
- in: query
name: fetching_criterion_arg__iregex
schema:
type: string
- in: query
name: fetching_criterion_arg__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: interval__every__lte
schema:
type: integer
- in: query
name: interval__every__gte
schema:
type: integer
- in: query
name: interval__every__lt
schema:
type: integer
- in: query
name: interval__every__gt
schema:
type: integer
- in: query
name: interval__every
schema:
type: integer
- in: query
name: interval__every__in
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: interval__every__range
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: interval__period__icontains
schema:
type: string
- in: query
name: interval__period__contains
schema:
type: string
- in: query
name: interval__period
schema:
type: string
title: Interval Period
enum:
- days
- hours
- microseconds
- minutes
- seconds
description: |-
The type of period between task runs (Example: days)
* `days` - Days
* `hours` - Hours
* `minutes` - Minutes
* `seconds` - Seconds
* `microseconds` - Microseconds
- in: query
name: interval__period__iexact
schema:
type: string
- in: query
name: interval__period__startswith
schema:
type: string
- in: query
name: interval__period__istartswith
schema:
type: string
- in: query
name: interval__period__endswith
schema:
type: string
- in: query
name: interval__period__iendswith
schema:
type: string
- in: query
name: interval__period__regex
schema:
type: string
- in: query
name: interval__period__iregex
schema:
type: string
- in: query
name: interval__period__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__date
schema:
type: string
format: date
- in: query
name: celery_task__last_run_at__date__gte
schema:
type: string
format: date
- in: query
name: celery_task__last_run_at__date__lte
schema:
type: string
format: date
- in: query
name: celery_task__last_run_at__date__gt
schema:
type: string
format: date
- in: query
name: celery_task__last_run_at__date__lt
schema:
type: string
format: date
- in: query
name: celery_task__last_run_at__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__time
schema:
type: string
format: time
- in: query
name: celery_task__last_run_at__time__gte
schema:
type: string
format: time
- in: query
name: celery_task__last_run_at__time__lte
schema:
type: string
format: time
- in: query
name: celery_task__last_run_at__time__gt
schema:
type: string
format: time
- in: query
name: celery_task__last_run_at__time__lt
schema:
type: string
format: time
- in: query
name: celery_task__last_run_at__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__iso_year
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_year__gte
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_year__lte
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_year__gt
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_year__lt
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__month
schema:
type: number
- in: query
name: celery_task__last_run_at__month__gte
schema:
type: number
- in: query
name: celery_task__last_run_at__month__lte
schema:
type: number
- in: query
name: celery_task__last_run_at__month__gt
schema:
type: number
- in: query
name: celery_task__last_run_at__month__lt
schema:
type: number
- in: query
name: celery_task__last_run_at__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__quarter
schema:
type: number
- in: query
name: celery_task__last_run_at__quarter__gte
schema:
type: number
- in: query
name: celery_task__last_run_at__quarter__lte
schema:
type: number
- in: query
name: celery_task__last_run_at__quarter__gt
schema:
type: number
- in: query
name: celery_task__last_run_at__quarter__lt
schema:
type: number
- in: query
name: celery_task__last_run_at__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__week
schema:
type: number
- in: query
name: celery_task__last_run_at__week__gte
schema:
type: number
- in: query
name: celery_task__last_run_at__week__lte
schema:
type: number
- in: query
name: celery_task__last_run_at__week__gt
schema:
type: number
- in: query
name: celery_task__last_run_at__week__lt
schema:
type: number
- in: query
name: celery_task__last_run_at__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__iso_week_day
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_week_day__gte
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_week_day__lte
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_week_day__gt
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_week_day__lt
schema:
type: number
- in: query
name: celery_task__last_run_at__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__day
schema:
type: number
- in: query
name: celery_task__last_run_at__day__gte
schema:
type: number
- in: query
name: celery_task__last_run_at__day__lte
schema:
type: number
- in: query
name: celery_task__last_run_at__day__gt
schema:
type: number
- in: query
name: celery_task__last_run_at__day__lt
schema:
type: number
- in: query
name: celery_task__last_run_at__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__hour
schema:
type: number
- in: query
name: celery_task__last_run_at__hour__gte
schema:
type: number
- in: query
name: celery_task__last_run_at__hour__lte
schema:
type: number
- in: query
name: celery_task__last_run_at__hour__gt
schema:
type: number
- in: query
name: celery_task__last_run_at__hour__lt
schema:
type: number
- in: query
name: celery_task__last_run_at__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__minute
schema:
type: number
- in: query
name: celery_task__last_run_at__minute__gte
schema:
type: number
- in: query
name: celery_task__last_run_at__minute__lte
schema:
type: number
- in: query
name: celery_task__last_run_at__minute__gt
schema:
type: number
- in: query
name: celery_task__last_run_at__minute__lt
schema:
type: number
- in: query
name: celery_task__last_run_at__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__second
schema:
type: number
- in: query
name: celery_task__last_run_at__second__gte
schema:
type: number
- in: query
name: celery_task__last_run_at__second__lte
schema:
type: number
- in: query
name: celery_task__last_run_at__second__gt
schema:
type: number
- in: query
name: celery_task__last_run_at__second__lt
schema:
type: number
- in: query
name: celery_task__last_run_at__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__last_run_at__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__total_run_count__lte
schema:
type: integer
- in: query
name: celery_task__total_run_count__gte
schema:
type: integer
- in: query
name: celery_task__total_run_count__lt
schema:
type: integer
- in: query
name: celery_task__total_run_count__gt
schema:
type: integer
- in: query
name: celery_task__total_run_count
schema:
type: integer
- in: query
name: celery_task__total_run_count__in
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: celery_task__total_run_count__range
schema:
type: array
items:
type: integer
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: is_healthy
schema:
type: boolean
- in: query
name: last_error__icontains
schema:
type: string
- in: query
name: last_error__contains
schema:
type: string
- in: query
name: last_error
schema:
type: string
- in: query
name: last_error__iexact
schema:
type: string
- in: query
name: last_error__startswith
schema:
type: string
- in: query
name: last_error__istartswith
schema:
type: string
- in: query
name: last_error__endswith
schema:
type: string
- in: query
name: last_error__iendswith
schema:
type: string
- in: query
name: last_error__regex
schema:
type: string
- in: query
name: last_error__iregex
schema:
type: string
- in: query
name: last_error__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__date
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__gte
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__lte
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__gt
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__lt
schema:
type: string
format: date
- in: query
name: last_error_occurred_at__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__time
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__gte
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__lte
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__gt
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__lt
schema:
type: string
format: time
- in: query
name: last_error_occurred_at__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_year
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__gte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__lte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__gt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__lt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__month
schema:
type: number
- in: query
name: last_error_occurred_at__month__gte
schema:
type: number
- in: query
name: last_error_occurred_at__month__lte
schema:
type: number
- in: query
name: last_error_occurred_at__month__gt
schema:
type: number
- in: query
name: last_error_occurred_at__month__lt
schema:
type: number
- in: query
name: last_error_occurred_at__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__quarter
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__gte
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__lte
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__gt
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__lt
schema:
type: number
- in: query
name: last_error_occurred_at__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__week
schema:
type: number
- in: query
name: last_error_occurred_at__week__gte
schema:
type: number
- in: query
name: last_error_occurred_at__week__lte
schema:
type: number
- in: query
name: last_error_occurred_at__week__gt
schema:
type: number
- in: query
name: last_error_occurred_at__week__lt
schema:
type: number
- in: query
name: last_error_occurred_at__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_week_day
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__gte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__lte
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__gt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__lt
schema:
type: number
- in: query
name: last_error_occurred_at__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__day
schema:
type: number
- in: query
name: last_error_occurred_at__day__gte
schema:
type: number
- in: query
name: last_error_occurred_at__day__lte
schema:
type: number
- in: query
name: last_error_occurred_at__day__gt
schema:
type: number
- in: query
name: last_error_occurred_at__day__lt
schema:
type: number
- in: query
name: last_error_occurred_at__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__hour
schema:
type: number
- in: query
name: last_error_occurred_at__hour__gte
schema:
type: number
- in: query
name: last_error_occurred_at__hour__lte
schema:
type: number
- in: query
name: last_error_occurred_at__hour__gt
schema:
type: number
- in: query
name: last_error_occurred_at__hour__lt
schema:
type: number
- in: query
name: last_error_occurred_at__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__minute
schema:
type: number
- in: query
name: last_error_occurred_at__minute__gte
schema:
type: number
- in: query
name: last_error_occurred_at__minute__lte
schema:
type: number
- in: query
name: last_error_occurred_at__minute__gt
schema:
type: number
- in: query
name: last_error_occurred_at__minute__lt
schema:
type: number
- in: query
name: last_error_occurred_at__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__second
schema:
type: number
- in: query
name: last_error_occurred_at__second__gte
schema:
type: number
- in: query
name: last_error_occurred_at__second__lte
schema:
type: number
- in: query
name: last_error_occurred_at__second__gt
schema:
type: number
- in: query
name: last_error_occurred_at__second__lt
schema:
type: number
- in: query
name: last_error_occurred_at__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: last_error_occurred_at__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__date
schema:
type: string
format: date
- in: query
name: created__date__gte
schema:
type: string
format: date
- in: query
name: created__date__lte
schema:
type: string
format: date
- in: query
name: created__date__gt
schema:
type: string
format: date
- in: query
name: created__date__lt
schema:
type: string
format: date
- in: query
name: created__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time
schema:
type: string
format: time
- in: query
name: created__time__gte
schema:
type: string
format: time
- in: query
name: created__time__lte
schema:
type: string
format: time
- in: query
name: created__time__gt
schema:
type: string
format: time
- in: query
name: created__time__lt
schema:
type: string
format: time
- in: query
name: created__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year
schema:
type: number
- in: query
name: created__iso_year__gte
schema:
type: number
- in: query
name: created__iso_year__lte
schema:
type: number
- in: query
name: created__iso_year__gt
schema:
type: number
- in: query
name: created__iso_year__lt
schema:
type: number
- in: query
name: created__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month
schema:
type: number
- in: query
name: created__month__gte
schema:
type: number
- in: query
name: created__month__lte
schema:
type: number
- in: query
name: created__month__gt
schema:
type: number
- in: query
name: created__month__lt
schema:
type: number
- in: query
name: created__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter
schema:
type: number
- in: query
name: created__quarter__gte
schema:
type: number
- in: query
name: created__quarter__lte
schema:
type: number
- in: query
name: created__quarter__gt
schema:
type: number
- in: query
name: created__quarter__lt
schema:
type: number
- in: query
name: created__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week
schema:
type: number
- in: query
name: created__week__gte
schema:
type: number
- in: query
name: created__week__lte
schema:
type: number
- in: query
name: created__week__gt
schema:
type: number
- in: query
name: created__week__lt
schema:
type: number
- in: query
name: created__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day
schema:
type: number
- in: query
name: created__iso_week_day__gte
schema:
type: number
- in: query
name: created__iso_week_day__lte
schema:
type: number
- in: query
name: created__iso_week_day__gt
schema:
type: number
- in: query
name: created__iso_week_day__lt
schema:
type: number
- in: query
name: created__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day
schema:
type: number
- in: query
name: created__day__gte
schema:
type: number
- in: query
name: created__day__lte
schema:
type: number
- in: query
name: created__day__gt
schema:
type: number
- in: query
name: created__day__lt
schema:
type: number
- in: query
name: created__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour
schema:
type: number
- in: query
name: created__hour__gte
schema:
type: number
- in: query
name: created__hour__lte
schema:
type: number
- in: query
name: created__hour__gt
schema:
type: number
- in: query
name: created__hour__lt
schema:
type: number
- in: query
name: created__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute
schema:
type: number
- in: query
name: created__minute__gte
schema:
type: number
- in: query
name: created__minute__lte
schema:
type: number
- in: query
name: created__minute__gt
schema:
type: number
- in: query
name: created__minute__lt
schema:
type: number
- in: query
name: created__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second
schema:
type: number
- in: query
name: created__second__gte
schema:
type: number
- in: query
name: created__second__lte
schema:
type: number
- in: query
name: created__second__gt
schema:
type: number
- in: query
name: created__second__lt
schema:
type: number
- in: query
name: created__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: created__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date
schema:
type: string
format: date
- in: query
name: updated__date__gte
schema:
type: string
format: date
- in: query
name: updated__date__lte
schema:
type: string
format: date
- in: query
name: updated__date__gt
schema:
type: string
format: date
- in: query
name: updated__date__lt
schema:
type: string
format: date
- in: query
name: updated__date__in
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__date__range
schema:
type: array
items:
type: string
format: date
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time
schema:
type: string
format: time
- in: query
name: updated__time__gte
schema:
type: string
format: time
- in: query
name: updated__time__lte
schema:
type: string
format: time
- in: query
name: updated__time__gt
schema:
type: string
format: time
- in: query
name: updated__time__lt
schema:
type: string
format: time
- in: query
name: updated__time__in
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__time__range
schema:
type: array
items:
type: string
format: time
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year
schema:
type: number
- in: query
name: updated__iso_year__gte
schema:
type: number
- in: query
name: updated__iso_year__lte
schema:
type: number
- in: query
name: updated__iso_year__gt
schema:
type: number
- in: query
name: updated__iso_year__lt
schema:
type: number
- in: query
name: updated__iso_year__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_year__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month
schema:
type: number
- in: query
name: updated__month__gte
schema:
type: number
- in: query
name: updated__month__lte
schema:
type: number
- in: query
name: updated__month__gt
schema:
type: number
- in: query
name: updated__month__lt
schema:
type: number
- in: query
name: updated__month__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__month__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter
schema:
type: number
- in: query
name: updated__quarter__gte
schema:
type: number
- in: query
name: updated__quarter__lte
schema:
type: number
- in: query
name: updated__quarter__gt
schema:
type: number
- in: query
name: updated__quarter__lt
schema:
type: number
- in: query
name: updated__quarter__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__quarter__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week
schema:
type: number
- in: query
name: updated__week__gte
schema:
type: number
- in: query
name: updated__week__lte
schema:
type: number
- in: query
name: updated__week__gt
schema:
type: number
- in: query
name: updated__week__lt
schema:
type: number
- in: query
name: updated__week__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__week__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day
schema:
type: number
- in: query
name: updated__iso_week_day__gte
schema:
type: number
- in: query
name: updated__iso_week_day__lte
schema:
type: number
- in: query
name: updated__iso_week_day__gt
schema:
type: number
- in: query
name: updated__iso_week_day__lt
schema:
type: number
- in: query
name: updated__iso_week_day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__iso_week_day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day
schema:
type: number
- in: query
name: updated__day__gte
schema:
type: number
- in: query
name: updated__day__lte
schema:
type: number
- in: query
name: updated__day__gt
schema:
type: number
- in: query
name: updated__day__lt
schema:
type: number
- in: query
name: updated__day__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__day__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour
schema:
type: number
- in: query
name: updated__hour__gte
schema:
type: number
- in: query
name: updated__hour__lte
schema:
type: number
- in: query
name: updated__hour__gt
schema:
type: number
- in: query
name: updated__hour__lt
schema:
type: number
- in: query
name: updated__hour__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__hour__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute
schema:
type: number
- in: query
name: updated__minute__gte
schema:
type: number
- in: query
name: updated__minute__lte
schema:
type: number
- in: query
name: updated__minute__gt
schema:
type: number
- in: query
name: updated__minute__lt
schema:
type: number
- in: query
name: updated__minute__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__minute__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second
schema:
type: number
- in: query
name: updated__second__gte
schema:
type: number
- in: query
name: updated__second__lte
schema:
type: number
- in: query
name: updated__second__gt
schema:
type: number
- in: query
name: updated__second__lt
schema:
type: number
- in: query
name: updated__second__in
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: updated__second__range
schema:
type: array
items:
type: number
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mailbox__name__icontains
schema:
type: string
- in: query
name: mailbox__name__contains
schema:
type: string
- in: query
name: mailbox__name
schema:
type: string
- in: query
name: mailbox__name__iexact
schema:
type: string
- in: query
name: mailbox__name__startswith
schema:
type: string
- in: query
name: mailbox__name__istartswith
schema:
type: string
- in: query
name: mailbox__name__endswith
schema:
type: string
- in: query
name: mailbox__name__iendswith
schema:
type: string
- in: query
name: mailbox__name__regex
schema:
type: string
- in: query
name: mailbox__name__iregex
schema:
type: string
- in: query
name: mailbox__name__in
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mailbox__is_healthy
schema:
type: boolean
- in: query
name: search
schema:
type: string
- in: query
name: mail_address__icontains
schema:
type: string
- in: query
name: mail_address__contains
schema:
type: string
- in: query
name: mail_address
schema:
type: string
- in: query
name: mail_address__iexact
schema:
type: string
- in: query
name: mail_address__startswith
schema:
type: string
- in: query
name: mail_address__istartswith
schema:
type: string
- in: query
name: mail_address__endswith
schema:
type: string
- in: query
name: mail_address__iendswith
schema:
type: string
- in: query
name: mail_address__regex
schema:
type: string
- in: query
name: mail_address__iregex
schema:
type: string
- in: query
name: mail_address__in
schema:
type: array
items:
type: string
title: Username
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: mail_host__icontains
schema:
type: string
- in: query
name: mail_host__contains
schema:
type: string
- in: query
name: mail_host
schema:
type: string
- in: query
name: mail_host__iexact
schema:
type: string
- in: query
name: mail_host__startswith
schema:
type: string
- in: query
name: mail_host__istartswith
schema:
type: string
- in: query
name: mail_host__endswith
schema:
type: string
- in: query
name: mail_host__iendswith
schema:
type: string
- in: query
name: mail_host__regex
schema:
type: string
- in: query
name: mail_host__iregex
schema:
type: string
- in: query
name: mail_host__in
schema:
type: array
items:
type: string
title: Mailserver URL
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: protocol__iexact
schema:
type: string
- in: query
name: protocol__icontains
schema:
type: string
- in: query
name: protocol__in
schema:
type: array
items:
type: string
title: Email protocol
enum:
- EXCHANGE
- IMAP
- IMAP4_SSL
- JMAP
- POP3
- POP3_SSL
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: account__is_healthy
schema:
type: boolean
- in: query
name: enabled
schema:
type: boolean
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBaseDaemonList'
description: ''
post:
operationId: v1_routines_create
description: 'Creates a new instance You must set header ''Accept: application/json''.'
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseDaemon'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BaseDaemon'
multipart/form-data:
schema:
$ref: '#/components/schemas/BaseDaemon'
required: true
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/BaseDaemon'
description: ''
/api/v1/routines/{id}:
get:
operationId: v1_routines_retrieve
description: Retrieves a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this routine.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BaseDaemon'
description: ''
put:
operationId: v1_routines_update
description: 'Updates a single instance. You must set header ''Accept: application/json''.'
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this routine.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaseDaemon'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BaseDaemon'
multipart/form-data:
schema:
$ref: '#/components/schemas/BaseDaemon'
required: true
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BaseDaemon'
description: ''
patch:
operationId: v1_routines_partial_update
description: |-
Viewset for the :class:`core.models.Daemon`.
Provides all CRUD actions.
Note:
To update instances the user must specify format "json" with the request.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this routine.
required: true
tags:
- v1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedBaseDaemon'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedBaseDaemon'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedBaseDaemon'
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BaseDaemon'
description: ''
delete:
operationId: v1_routines_destroy
description: Deletes a single instance.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this routine.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/v1/routines/{id}/start:
post:
operationId: v1_routines_start_create
description: Starts a routine's periodic task.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this routine.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BaseDaemon'
description: ''
/api/v1/routines/{id}/stop:
post:
operationId: v1_routines_stop_create
description: Stops a routine's periodic task.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this routine.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BaseDaemon'
description: ''
/api/v1/routines/{id}/test:
post:
operationId: v1_routines_test_create
description: Tests a routine.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this routine.
required: true
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/test_daemon_response'
description: ''
/api/v1/stats:
get:
operationId: v1_stats_retrieve
description: Gets all the entry counts in the tables of the database.
tags:
- v1
security:
- XSessionTokenAuth: []
- cookieAuth: []
- basicAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseStats'
description: ''
components:
schemas:
Account:
type: object
description: |-
The standard serializer for a :class:`core.models.Account`.
Includes a nested serializer for the related field `mailboxes`.
properties:
id:
type: integer
readOnly: true
mailboxes:
type: array
items:
$ref: '#/components/schemas/BaseMailbox'
readOnly: true
is_favorite:
type: boolean
title: Favorite status
is_healthy:
type: boolean
readOnly: true
nullable: true
title: Health status
last_error:
type: string
readOnly: true
last_error_occurred_at:
type: string
format: date-time
readOnly: true
nullable: true
title: Time of last error occurrence
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
mail_address:
type: string
default: ''
title: Username
description: The username of the account. Typically the mail address.
maxLength: 255
password:
type: string
writeOnly: true
description: The password to the account.
maxLength: 255
mail_host:
type: string
title: Mailserver URL
description: The URL of the mailserver for the chosen protocol.
maxLength: 255
mail_host_port:
type: integer
maximum: 65535
minimum: 0
nullable: true
title: Mailserver portnumber
description: The port of the mailserver for the chosen protocol.
protocol:
allOf:
- $ref: '#/components/schemas/ProtocolEnum'
title: Email protocol
description: |-
The email protocol implemented by the server.
* `IMAP4_SSL` - IMAP4
* `IMAP` - IMAP4 (unencrypted)
* `POP3_SSL` - POP3
* `POP3` - POP3 (unencrypted)
* `EXCHANGE` - Microsoft Exchange
* `JMAP` - JMAP
timeout:
type: integer
maximum: 4294967295
minimum: 0.1
format: int64
title: Connection timeout
description: Timeout for the connection to the mailserver.
allow_insecure_connection:
type: boolean
description: Whether to allow insecure connections to the host, e.g. with
a self-signed certificate.
required:
- created
- id
- is_healthy
- last_error
- last_error_occurred_at
- mail_host
- mailboxes
- password
- protocol
- updated
BaseAttachment:
type: object
description: |-
The base serializer for :class:`core.models.Attachment`.
Includes all viable fields from the model.
Sets all constraints that must be implemented in all serializers.
Other serializers for :class:`core.models.Attachment` should inherit from this.
properties:
id:
type: integer
readOnly: true
is_favorite:
type: boolean
title: Favorite status
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
file_name:
type: string
readOnly: true
title: Filename
content_disposition:
type: string
readOnly: true
content_id:
type: string
readOnly: true
content_maintype:
type: string
readOnly: true
content_subtype:
type: string
readOnly: true
datasize:
type: integer
readOnly: true
email:
type: integer
readOnly: true
required:
- content_disposition
- content_id
- content_maintype
- content_subtype
- created
- datasize
- email
- file_name
- id
- updated
BaseCorrespondent:
type: object
description: |-
The base serializer for :class:`core.models.Correspondent`.
Includes all viable fields from the model.
Sets all constraints that must be implemented in all serializers.
Other serializers for :class:`core.models.Correspondent` should inherit from this.
properties:
id:
type: integer
readOnly: true
is_favorite:
type: boolean
title: Favorite status
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
email_address:
type: string
readOnly: true
email_name:
type: string
readOnly: true
title: Mailer name
description: The mailer name of the correspondent.
real_name:
type: string
description: The real name of the correspondent.
maxLength: 255
list_id:
type: string
readOnly: true
list_owner:
type: string
readOnly: true
list_subscribe:
type: string
readOnly: true
list_unsubscribe:
type: string
readOnly: true
list_unsubscribe_post:
type: string
readOnly: true
title: List-unsubscribe method
list_post:
type: string
readOnly: true
list_help:
type: string
readOnly: true
list_archive:
type: string
readOnly: true
required:
- created
- email_address
- email_name
- id
- list_archive
- list_help
- list_id
- list_owner
- list_post
- list_subscribe
- list_unsubscribe
- list_unsubscribe_post
- updated
BaseDaemon:
type: object
description: |-
The base serializer for :class:`core.models.Daemon`.
Includes all viable fields from the model.
Sets all constraints that must be implemented in all serializers.
Other serializers for :class:`core.models.Daemon` should inherit from this.
properties:
id:
type: integer
readOnly: true
interval:
$ref: '#/components/schemas/IntervalSchedule'
celery_task:
allOf:
- $ref: '#/components/schemas/PeriodicTask'
readOnly: true
is_healthy:
type: boolean
readOnly: true
nullable: true
title: Health status
last_error:
type: string
readOnly: true
last_error_occurred_at:
type: string
format: date-time
readOnly: true
nullable: true
title: Time of last error occurrence
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
uuid:
type: string
format: uuid
readOnly: true
fetching_criterion:
allOf:
- $ref: '#/components/schemas/FetchingCriterionEnum'
default: ALL
description: |-
The selection criterion for emails to archive.
* `DAILY` - All emails received the last DAY
* `WEEKLY` - All emails received the last WEEK
* `MONTHLY` - All emails received the last MONTH
* `ANNUALLY` - All emails received the last YEAR
* `RECENT` - All RECENT emails
* `UNSEEN` - All UNSEEN emails
* `SEEN` - All SEEN emails
* `ALL` - All emails
* `NEW` - All RECENT and UNSEEN emails
* `OLD` - All emails that are not RECENT
* `FLAGGED` - FLAGGED emails
* `UNFLAGGED` - All emails that are not FLAGGED
* `DRAFT` - All email DRAFTs
* `UNDRAFT` - All emails that are not DRAFTs
* `ANSWERED` - All ANSWERED emails
* `UNANSWERED` - All UNANSWERED emails
* `DELETED` - All DELETED emails
* `UNDELETED` - All UNDELETED emails
* `KEYWORD {}` - All emails with the given KEYWORD
* `UNKEYWORD {}` - All emails without the given KEYWORD
* `LARGER {}` - All emails LARGER than the given size
* `SMALLER {}` - All emails SMALLER than the given size
* `SUBJECT {}` - All emails with SUBJECT containing the given text
* `BODY {}` - All emails with BODY containing the given text
* `FROM {}` - All emails sent FROM the given address
* `SENTSINCE {}` - All emails SENT SINCE the given date
fetching_criterion_arg:
type: string
title: Filter value
description: Additional value for the selection criterion.
maxLength: 255
mailbox:
type: integer
required:
- celery_task
- created
- id
- interval
- is_healthy
- last_error
- last_error_occurred_at
- mailbox
- updated
- uuid
BaseEmail:
type: object
description: |-
The base serializer for :class:`core.models.Email`.
Includes all viable fields from the model.
Sets all constraints that must be implemented in all serializers.
Other serializers for :class:`core.models.Email` should inherit from this.
properties:
id:
type: integer
readOnly: true
is_favorite:
type: boolean
title: Favorite status
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
message_id:
type: string
readOnly: true
datetime:
type: string
format: date-time
readOnly: true
title: Time received
subject:
type: string
readOnly: true
plain_bodytext:
type: string
readOnly: true
html_bodytext:
type: string
readOnly: true
datasize:
type: integer
readOnly: true
headers:
readOnly: true
nullable: true
x_spam_flag:
type: boolean
readOnly: true
nullable: true
mailbox:
type: integer
readOnly: true
in_reply_to:
type: array
items:
type: integer
title: In reply to email
readOnly: true
title: In reply to email
references:
type: array
items:
type: integer
title: Referencing emails
readOnly: true
title: Referencing emails
correspondents:
type: array
items:
type: integer
readOnly: true
required:
- correspondents
- created
- datasize
- datetime
- headers
- html_bodytext
- id
- in_reply_to
- mailbox
- message_id
- plain_bodytext
- references
- subject
- updated
- x_spam_flag
BaseMailbox:
type: object
description: |-
The base serializer for :class:`core.models.Mailbox`.
Includes all viable fields from the model.
Sets all constraints that must be implemented in all serializers.
Other serializers for :class:`core.models.Mailbox` should inherit from this.
properties:
id:
type: integer
readOnly: true
is_favorite:
type: boolean
title: Favorite status
is_healthy:
type: boolean
readOnly: true
nullable: true
title: Health status
last_error:
type: string
readOnly: true
last_error_occurred_at:
type: string
format: date-time
readOnly: true
nullable: true
title: Time of last error occurrence
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
name:
type: string
readOnly: true
type:
readOnly: true
oneOf:
- $ref: '#/components/schemas/TypeEnum'
- $ref: '#/components/schemas/BlankEnum'
save_attachments:
type: boolean
description: Whether the attachments from the emails in this mailbox will
be saved.
save_to_eml:
type: boolean
title: Save as .eml
description: Whether the emails in this mailbox will be stored in .eml files.
account:
type: integer
readOnly: true
required:
- account
- created
- id
- is_healthy
- last_error
- last_error_occurred_at
- name
- type
- updated
BlankEnum:
enum:
- ''
Correspondent:
type: object
description: |-
The standard serializer for a :class:`core.models.Correspondent.Correspondent`.
Includes a nested serializer for
the :attr:`core.models.Correspondent.Correspondent.emails` field.
properties:
id:
type: integer
readOnly: true
emails:
type: array
items:
$ref: '#/components/schemas/CorrespondentEmail'
readOnly: true
is_favorite:
type: boolean
title: Favorite status
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
email_address:
type: string
readOnly: true
email_name:
type: string
readOnly: true
title: Mailer name
description: The mailer name of the correspondent.
real_name:
type: string
description: The real name of the correspondent.
maxLength: 255
list_id:
type: string
readOnly: true
list_owner:
type: string
readOnly: true
list_subscribe:
type: string
readOnly: true
list_unsubscribe:
type: string
readOnly: true
list_unsubscribe_post:
type: string
readOnly: true
title: List-unsubscribe method
list_post:
type: string
readOnly: true
list_help:
type: string
readOnly: true
list_archive:
type: string
readOnly: true
required:
- created
- email_address
- email_name
- emails
- id
- list_archive
- list_help
- list_id
- list_owner
- list_post
- list_subscribe
- list_unsubscribe
- list_unsubscribe_post
- updated
CorrespondentEmail:
type: object
description: |-
The serializer for emails from :class:`core.models.EmailCorrespondent`.
Used to serialize the emails belonging to a correspondent. Does not include this correspondent.
properties:
email:
allOf:
- $ref: '#/components/schemas/BaseEmail'
readOnly: true
mention:
allOf:
- $ref: '#/components/schemas/MentionEnum'
readOnly: true
required:
- email
- mention
CriterionEnum:
enum:
- DAILY
- WEEKLY
- MONTHLY
- ANNUALLY
- RECENT
- UNSEEN
- SEEN
- ALL
- NEW
- OLD
- FLAGGED
- UNFLAGGED
- DRAFT
- UNDRAFT
- ANSWERED
- UNANSWERED
- DELETED
- UNDELETED
- KEYWORD {}
- UNKEYWORD {}
- LARGER {}
- SMALLER {}
- SUBJECT {}
- BODY {}
- FROM {}
- SENTSINCE {}
type: string
description: |-
* `DAILY` - DAILY
* `WEEKLY` - WEEKLY
* `MONTHLY` - MONTHLY
* `ANNUALLY` - ANNUALLY
* `RECENT` - RECENT
* `UNSEEN` - UNSEEN
* `SEEN` - SEEN
* `ALL` - ALL
* `NEW` - NEW
* `OLD` - OLD
* `FLAGGED` - FLAGGED
* `UNFLAGGED` - UNFLAGGED
* `DRAFT` - DRAFT
* `UNDRAFT` - UNDRAFT
* `ANSWERED` - ANSWERED
* `UNANSWERED` - UNANSWERED
* `DELETED` - DELETED
* `UNDELETED` - UNDELETED
* `KEYWORD {}` - KEYWORD {}
* `UNKEYWORD {}` - UNKEYWORD {}
* `LARGER {}` - LARGER {}
* `SMALLER {}` - SMALLER {}
* `SUBJECT {}` - SUBJECT {}
* `BODY {}` - BODY {}
* `FROM {}` - FROM {}
* `SENTSINCE {}` - SENTSINCE {}
DatabaseStats:
type: object
description: Serializer for the stats of the database.
properties:
email_count:
type: integer
description: |-
Gets the count of emails for the user.
Returns:
The number of emails belonging to the user.
readOnly: true
correspondent_count:
type: integer
description: |-
Gets the count of correspondents for the user.
Returns:
The number of correspondents belonging to the user.
readOnly: true
attachment_count:
type: integer
description: |-
Gets the count of attachments for the user.
Returns:
The number of attachments belonging to the user.
readOnly: true
account_count:
type: integer
description: |-
Gets the count of accounts for the user.
Returns:
The number of accounts belonging to the user.
readOnly: true
mailbox_count:
type: integer
description: |-
Gets the count of mailboxes for the user.
Returns:
The number of mailboxes belonging to the user.
readOnly: true
daemon_count:
type: integer
description: |-
Gets the count of daemons for the user.
Returns:
The number of daemons belonging to the user.
readOnly: true
required:
- account_count
- attachment_count
- correspondent_count
- daemon_count
- email_count
- mailbox_count
EmailCorrespondent:
type: object
description: |-
The serializer for correspondents from :class:`core.models.EmailCorrespondent`.
Used to serialize the correspondent belonging to an email. Does not include that email.
properties:
correspondent:
allOf:
- $ref: '#/components/schemas/BaseCorrespondent'
readOnly: true
mention:
allOf:
- $ref: '#/components/schemas/MentionEnum'
readOnly: true
required:
- correspondent
- mention
FetchingCriterionEnum:
enum:
- DAILY
- WEEKLY
- MONTHLY
- ANNUALLY
- RECENT
- UNSEEN
- SEEN
- ALL
- NEW
- OLD
- FLAGGED
- UNFLAGGED
- DRAFT
- UNDRAFT
- ANSWERED
- UNANSWERED
- DELETED
- UNDELETED
- KEYWORD {}
- UNKEYWORD {}
- LARGER {}
- SMALLER {}
- SUBJECT {}
- BODY {}
- FROM {}
- SENTSINCE {}
type: string
description: |-
* `DAILY` - All emails received the last DAY
* `WEEKLY` - All emails received the last WEEK
* `MONTHLY` - All emails received the last MONTH
* `ANNUALLY` - All emails received the last YEAR
* `RECENT` - All RECENT emails
* `UNSEEN` - All UNSEEN emails
* `SEEN` - All SEEN emails
* `ALL` - All emails
* `NEW` - All RECENT and UNSEEN emails
* `OLD` - All emails that are not RECENT
* `FLAGGED` - FLAGGED emails
* `UNFLAGGED` - All emails that are not FLAGGED
* `DRAFT` - All email DRAFTs
* `UNDRAFT` - All emails that are not DRAFTs
* `ANSWERED` - All ANSWERED emails
* `UNANSWERED` - All UNANSWERED emails
* `DELETED` - All DELETED emails
* `UNDELETED` - All UNDELETED emails
* `KEYWORD {}` - All emails with the given KEYWORD
* `UNKEYWORD {}` - All emails without the given KEYWORD
* `LARGER {}` - All emails LARGER than the given size
* `SMALLER {}` - All emails SMALLER than the given size
* `SUBJECT {}` - All emails with SUBJECT containing the given text
* `BODY {}` - All emails with BODY containing the given text
* `FROM {}` - All emails sent FROM the given address
* `SENTSINCE {}` - All emails SENT SINCE the given date
FileFormatEnum:
enum:
- eml
- zip[eml]
- mbox
- babyl
- mmdf
- zip[mh]
- zip[maildir]
type: string
description: |-
* `eml` - eml
* `zip[eml]` - zip[eml]
* `mbox` - mbox
* `babyl` - babyl
* `mmdf` - mmdf
* `zip[mh]` - zip[mh]
* `zip[maildir]` - zip[maildir]
FullEmail:
type: object
description: |-
A complete serializer for a :class:`core.models.Email`.
Includes nested serializers for the :attr:`core.models.Email.Email.replies`,
:attr:`core.models.Email.Email.attachments` and
:attr:`core.models.Email.Email.correspondents` foreign key and related fields.
properties:
id:
type: integer
readOnly: true
replies:
type: array
items:
type: integer
readOnly: true
referenced_by:
type: array
items:
type: integer
readOnly: true
attachments:
type: array
items:
$ref: '#/components/schemas/BaseAttachment'
readOnly: true
correspondents:
type: array
items:
$ref: '#/components/schemas/EmailCorrespondent'
readOnly: true
is_favorite:
type: boolean
title: Favorite status
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
message_id:
type: string
readOnly: true
datetime:
type: string
format: date-time
readOnly: true
title: Time received
subject:
type: string
readOnly: true
plain_bodytext:
type: string
readOnly: true
html_bodytext:
type: string
readOnly: true
datasize:
type: integer
readOnly: true
headers:
readOnly: true
nullable: true
x_spam_flag:
type: boolean
readOnly: true
nullable: true
mailbox:
type: integer
readOnly: true
in_reply_to:
type: array
items:
type: integer
title: In reply to email
readOnly: true
title: In reply to email
references:
type: array
items:
type: integer
title: Referencing emails
readOnly: true
title: Referencing emails
required:
- attachments
- correspondents
- created
- datasize
- datetime
- headers
- html_bodytext
- id
- in_reply_to
- mailbox
- message_id
- plain_bodytext
- referenced_by
- references
- replies
- subject
- updated
- x_spam_flag
IntervalSchedule:
type: object
description: |-
The base serializer for :class:`django_celery_beat.models.IntervalSchedule`.
Includes all viable fields from the model.
Sets all constraints that must be implemented in all serializers.
Other serializers for :class:`django_celery_beat.models.IntervalSchedule` should inherit from this.
properties:
id:
type: integer
readOnly: true
every:
type: integer
maximum: 2147483647
minimum: 1
title: Number of Periods
description: Number of interval periods to wait before running the task
again
period:
allOf:
- $ref: '#/components/schemas/PeriodEnum'
title: Interval Period
description: |-
The type of period between task runs (Example: days)
* `days` - Days
* `hours` - Hours
* `minutes` - Minutes
* `seconds` - Seconds
* `microseconds` - Microseconds
required:
- every
- id
- period
MailboxWithDaemon:
type: object
description: |-
The standard serializer for a :class:`core.models.Daemon`.
Includes a nested serializer for the :attr:`core.models.Daemon.Daemon.daemons` related field.
properties:
id:
type: integer
readOnly: true
daemons:
type: array
items:
$ref: '#/components/schemas/BaseDaemon'
readOnly: true
is_favorite:
type: boolean
title: Favorite status
is_healthy:
type: boolean
readOnly: true
nullable: true
title: Health status
last_error:
type: string
readOnly: true
last_error_occurred_at:
type: string
format: date-time
readOnly: true
nullable: true
title: Time of last error occurrence
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
name:
type: string
readOnly: true
type:
readOnly: true
oneOf:
- $ref: '#/components/schemas/TypeEnum'
- $ref: '#/components/schemas/BlankEnum'
save_attachments:
type: boolean
description: Whether the attachments from the emails in this mailbox will
be saved.
save_to_eml:
type: boolean
title: Save as .eml
description: Whether the emails in this mailbox will be stored in .eml files.
account:
type: integer
readOnly: true
required:
- account
- created
- daemons
- id
- is_healthy
- last_error
- last_error_occurred_at
- name
- type
- updated
MentionEnum:
enum:
- from
- to
- cc
- bcc
- sender
- reply-To
- resent-from
- resent-to
- resent-cc
- resent-bcc
- resent-sender
- resent-reply-to
- envelope-to
- delivered-to
- return-path
- return-receipt-to
- disposition-notification-to
type: string
description: |-
* `from` - From
* `to` - To
* `cc` - CC
* `bcc` - BCC
* `sender` - Sender
* `reply-To` - Reply-To
* `resent-from` - Resent-From
* `resent-to` - Resent-To
* `resent-cc` - Resent-Cc
* `resent-bcc` - Resent-Bcc
* `resent-sender` - Resent-Sender
* `resent-reply-to` - Resent-Reply-To
* `envelope-to` - Envelope-To
* `delivered-to` - Delivered-To
* `return-path` - Return-Path
* `return-receipt-to` - Return-Receipt-To
* `disposition-notification-to` - Disposition-Notification-To
PaginatedAccountList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Account'
PaginatedBaseAttachmentList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/BaseAttachment'
PaginatedBaseCorrespondentList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/BaseCorrespondent'
PaginatedBaseDaemonList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/BaseDaemon'
PaginatedBaseEmailList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/BaseEmail'
PaginatedMailboxWithDaemonList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/MailboxWithDaemon'
PatchedAccount:
type: object
description: |-
The standard serializer for a :class:`core.models.Account`.
Includes a nested serializer for the related field `mailboxes`.
properties:
id:
type: integer
readOnly: true
mailboxes:
type: array
items:
$ref: '#/components/schemas/BaseMailbox'
readOnly: true
is_favorite:
type: boolean
title: Favorite status
is_healthy:
type: boolean
readOnly: true
nullable: true
title: Health status
last_error:
type: string
readOnly: true
last_error_occurred_at:
type: string
format: date-time
readOnly: true
nullable: true
title: Time of last error occurrence
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
mail_address:
type: string
default: ''
title: Username
description: The username of the account. Typically the mail address.
maxLength: 255
password:
type: string
writeOnly: true
description: The password to the account.
maxLength: 255
mail_host:
type: string
title: Mailserver URL
description: The URL of the mailserver for the chosen protocol.
maxLength: 255
mail_host_port:
type: integer
maximum: 65535
minimum: 0
nullable: true
title: Mailserver portnumber
description: The port of the mailserver for the chosen protocol.
protocol:
allOf:
- $ref: '#/components/schemas/ProtocolEnum'
title: Email protocol
description: |-
The email protocol implemented by the server.
* `IMAP4_SSL` - IMAP4
* `IMAP` - IMAP4 (unencrypted)
* `POP3_SSL` - POP3
* `POP3` - POP3 (unencrypted)
* `EXCHANGE` - Microsoft Exchange
* `JMAP` - JMAP
timeout:
type: integer
maximum: 4294967295
minimum: 0.1
format: int64
title: Connection timeout
description: Timeout for the connection to the mailserver.
allow_insecure_connection:
type: boolean
description: Whether to allow insecure connections to the host, e.g. with
a self-signed certificate.
PatchedBaseDaemon:
type: object
description: |-
The base serializer for :class:`core.models.Daemon`.
Includes all viable fields from the model.
Sets all constraints that must be implemented in all serializers.
Other serializers for :class:`core.models.Daemon` should inherit from this.
properties:
id:
type: integer
readOnly: true
interval:
$ref: '#/components/schemas/IntervalSchedule'
celery_task:
allOf:
- $ref: '#/components/schemas/PeriodicTask'
readOnly: true
is_healthy:
type: boolean
readOnly: true
nullable: true
title: Health status
last_error:
type: string
readOnly: true
last_error_occurred_at:
type: string
format: date-time
readOnly: true
nullable: true
title: Time of last error occurrence
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
uuid:
type: string
format: uuid
readOnly: true
fetching_criterion:
allOf:
- $ref: '#/components/schemas/FetchingCriterionEnum'
default: ALL
description: |-
The selection criterion for emails to archive.
* `DAILY` - All emails received the last DAY
* `WEEKLY` - All emails received the last WEEK
* `MONTHLY` - All emails received the last MONTH
* `ANNUALLY` - All emails received the last YEAR
* `RECENT` - All RECENT emails
* `UNSEEN` - All UNSEEN emails
* `SEEN` - All SEEN emails
* `ALL` - All emails
* `NEW` - All RECENT and UNSEEN emails
* `OLD` - All emails that are not RECENT
* `FLAGGED` - FLAGGED emails
* `UNFLAGGED` - All emails that are not FLAGGED
* `DRAFT` - All email DRAFTs
* `UNDRAFT` - All emails that are not DRAFTs
* `ANSWERED` - All ANSWERED emails
* `UNANSWERED` - All UNANSWERED emails
* `DELETED` - All DELETED emails
* `UNDELETED` - All UNDELETED emails
* `KEYWORD {}` - All emails with the given KEYWORD
* `UNKEYWORD {}` - All emails without the given KEYWORD
* `LARGER {}` - All emails LARGER than the given size
* `SMALLER {}` - All emails SMALLER than the given size
* `SUBJECT {}` - All emails with SUBJECT containing the given text
* `BODY {}` - All emails with BODY containing the given text
* `FROM {}` - All emails sent FROM the given address
* `SENTSINCE {}` - All emails SENT SINCE the given date
fetching_criterion_arg:
type: string
title: Filter value
description: Additional value for the selection criterion.
maxLength: 255
mailbox:
type: integer
PatchedCorrespondent:
type: object
description: |-
The standard serializer for a :class:`core.models.Correspondent.Correspondent`.
Includes a nested serializer for
the :attr:`core.models.Correspondent.Correspondent.emails` field.
properties:
id:
type: integer
readOnly: true
emails:
type: array
items:
$ref: '#/components/schemas/CorrespondentEmail'
readOnly: true
is_favorite:
type: boolean
title: Favorite status
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
email_address:
type: string
readOnly: true
email_name:
type: string
readOnly: true
title: Mailer name
description: The mailer name of the correspondent.
real_name:
type: string
description: The real name of the correspondent.
maxLength: 255
list_id:
type: string
readOnly: true
list_owner:
type: string
readOnly: true
list_subscribe:
type: string
readOnly: true
list_unsubscribe:
type: string
readOnly: true
list_unsubscribe_post:
type: string
readOnly: true
title: List-unsubscribe method
list_post:
type: string
readOnly: true
list_help:
type: string
readOnly: true
list_archive:
type: string
readOnly: true
PatchedMailboxWithDaemon:
type: object
description: |-
The standard serializer for a :class:`core.models.Daemon`.
Includes a nested serializer for the :attr:`core.models.Daemon.Daemon.daemons` related field.
properties:
id:
type: integer
readOnly: true
daemons:
type: array
items:
$ref: '#/components/schemas/BaseDaemon'
readOnly: true
is_favorite:
type: boolean
title: Favorite status
is_healthy:
type: boolean
readOnly: true
nullable: true
title: Health status
last_error:
type: string
readOnly: true
last_error_occurred_at:
type: string
format: date-time
readOnly: true
nullable: true
title: Time of last error occurrence
created:
type: string
format: date-time
readOnly: true
title: Time of creation
updated:
type: string
format: date-time
readOnly: true
title: Time of last update
name:
type: string
readOnly: true
type:
readOnly: true
oneOf:
- $ref: '#/components/schemas/TypeEnum'
- $ref: '#/components/schemas/BlankEnum'
save_attachments:
type: boolean
description: Whether the attachments from the emails in this mailbox will
be saved.
save_to_eml:
type: boolean
title: Save as .eml
description: Whether the emails in this mailbox will be stored in .eml files.
account:
type: integer
readOnly: true
PatchedUserProfile:
type: object
description: The serializer for :class:`eonvelope.models.UserProfile`.
properties:
paperless_url:
type: string
format: uri
title: Paperless server URL
description: URL of your Paperless server.
maxLength: 255
paperless_api_key:
type: string
writeOnly: true
title: Paperless server API key
description: API key for your Paperless server.
maxLength: 255
paperless_tika_enabled:
type: boolean
title: Paperless Tika support enabled
description: Whether Tika support is enabled on your Paperless server.
immich_url:
type: string
format: uri
title: Immich server URL
description: URL of your Immich server.
maxLength: 255
immich_api_key:
type: string
writeOnly: true
title: Immich server API key
description: API key for your Immich server.
maxLength: 255
nextcloud_url:
type: string
format: uri
title: Nextcloud server URL
description: URL of your Nextcloud server.
maxLength: 255
nextcloud_username:
type: string
title: Nextcloud server username
description: Username for your Nextcloud account.
maxLength: 255
nextcloud_password:
type: string
writeOnly: true
title: Nextcloud server password
description: Password for your Nextcloud account.
maxLength: 255
nextcloud_addressbook:
type: string
title: Nextcloud server addressbook
description: Main addressbook of your Nextcloud account.
maxLength: 255
PeriodEnum:
enum:
- days
- hours
- minutes
- seconds
- microseconds
type: string
description: |-
* `days` - Days
* `hours` - Hours
* `minutes` - Minutes
* `seconds` - Seconds
* `microseconds` - Microseconds
PeriodicTask:
type: object
description: |-
The base serializer for :class:`django_celery_beat.models.PeriodicTask`.
Includes all viable fields from the model.
Sets all constraints that must be implemented in all serializers.
Other serializers for :class:`django_celery_beat.models.PeriodicTask` should inherit from this.
properties:
enabled:
type: boolean
readOnly: true
description: Set to False to disable the schedule
last_run_at:
type: string
format: date-time
readOnly: true
nullable: true
title: Last Run Datetime
description: Datetime that the schedule last triggered the task to run.
Reset to None if enabled is set to False.
total_run_count:
type: integer
readOnly: true
description: Running count of how many times the schedule has triggered
the task
required:
- enabled
- last_run_at
- total_run_count
ProtocolEnum:
enum:
- IMAP4_SSL
- IMAP
- POP3_SSL
- POP3
- EXCHANGE
- JMAP
type: string
description: |-
* `IMAP4_SSL` - IMAP4
* `IMAP` - IMAP4 (unencrypted)
* `POP3_SSL` - POP3
* `POP3` - POP3 (unencrypted)
* `EXCHANGE` - Microsoft Exchange
* `JMAP` - JMAP
TypeEnum:
enum:
- INBOX
- OUTBOX
- SENT
- JUNK
- DRAFTS
- TRASH
type: string
description: "* `INBOX` - Inbox\n* `OUTBOX` - Outbox\n* `SENT` - Sent\n* `JUNK`
- Junk\n* `DRAFTS` - Drafts\n* `TRASH` - Trash\n* `` - "
UploadEmail:
type: object
description: Serializer for email file upload.
properties:
file_format:
$ref: '#/components/schemas/FileFormatEnum'
file:
type: string
format: uri
required:
- file
- file_format
UserProfile:
type: object
description: The serializer for :class:`eonvelope.models.UserProfile`.
properties:
paperless_url:
type: string
format: uri
title: Paperless server URL
description: URL of your Paperless server.
maxLength: 255
paperless_api_key:
type: string
writeOnly: true
title: Paperless server API key
description: API key for your Paperless server.
maxLength: 255
paperless_tika_enabled:
type: boolean
title: Paperless Tika support enabled
description: Whether Tika support is enabled on your Paperless server.
immich_url:
type: string
format: uri
title: Immich server URL
description: URL of your Immich server.
maxLength: 255
immich_api_key:
type: string
writeOnly: true
title: Immich server API key
description: API key for your Immich server.
maxLength: 255
nextcloud_url:
type: string
format: uri
title: Nextcloud server URL
description: URL of your Nextcloud server.
maxLength: 255
nextcloud_username:
type: string
title: Nextcloud server username
description: Username for your Nextcloud account.
maxLength: 255
nextcloud_password:
type: string
writeOnly: true
title: Nextcloud server password
description: Password for your Nextcloud account.
maxLength: 255
nextcloud_addressbook:
type: string
title: Nextcloud server addressbook
description: Main addressbook of your Nextcloud account.
maxLength: 255
add_daemons_response:
type: object
properties:
detail:
type: string
required:
- detail
fetch_criterion_data:
type: object
properties:
criterion:
$ref: '#/components/schemas/CriterionEnum'
criterion_arg:
type: string
required:
- criterion
fetch_mailbox_response:
type: object
properties:
detail:
type: string
result:
type: boolean
data:
$ref: '#/components/schemas/MailboxWithDaemon'
required:
- data
- detail
- result
reprocess_email_response:
type: object
properties:
detail:
type: string
data:
$ref: '#/components/schemas/FullEmail'
required:
- data
- detail
share_to_immich_failed_serializer:
type: object
properties:
detail:
type: string
error:
type: string
required:
- detail
- error
share_to_immich_serializer:
type: object
properties:
detail:
type: string
data:
type: string
required:
- data
- detail
share_to_nextcloud_failed_serializer:
type: object
properties:
detail:
type: string
error:
type: string
required:
- detail
- error
share_to_nextcloud_serializer:
type: object
properties:
detail:
type: string
data:
type: string
required:
- data
- detail
share_to_paperless_failed_serializer:
type: object
properties:
detail:
type: string
error:
type: string
required:
- detail
- error
share_to_paperless_serializer:
type: object
properties:
detail:
type: string
data:
type: string
required:
- data
- detail
test_account_response:
type: object
properties:
detail:
type: string
result:
type: boolean
data:
$ref: '#/components/schemas/Account'
required:
- data
- detail
- result
test_daemon_response:
type: object
properties:
detail:
type: string
result:
type: boolean
data:
$ref: '#/components/schemas/BaseDaemon'
required:
- data
- detail
- result
test_mailbox_response:
type: object
properties:
detail:
type: string
result:
type: boolean
data:
$ref: '#/components/schemas/MailboxWithDaemon'
required:
- data
- detail
- result
toggle_favorite_serializer:
type: object
properties:
detail:
type: string
required:
- detail
update_mailboxes_account_response:
type: object
properties:
detail:
type: string
data:
$ref: '#/components/schemas/Account'
required:
- data
- detail
upload_emails_mailbox_response:
type: object
properties:
detail:
type: string
data:
$ref: '#/components/schemas/MailboxWithDaemon'
required:
- data
- detail
securitySchemes:
XSessionTokenAuth:
type: apiKey
in: header
name: X-Session-Token
description: X-Session-Token authentication
basicAuth:
type: http
scheme: basic
description: Basic authentication is only allowed if you do not have MFA enabled.
cookieAuth:
type: apiKey
in: cookie
name: sessionid
tokenAuth:
type: apiKey
in: header
name: Authorization
description: Token-based authentication with required prefix "Token"
externalDocs:
description: Read the E∘nvelope Documentation on ReadTheDocs
url: https://eonvelope.readthedocs.io/stable/rst/api-instructions.html