Loading
Documentation Powered by ReDoc

DFS Email Bridge Services API (latest)

Download OpenAPI specification:Download

Contains functionality around sending email.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

Mail

Forward desired email request to Email Service Provider

Receives a desired email request and forwards the request to the configured Email Service Provider.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The request DTO

from
object (EmailAddress)
to
Array of objects (EmailAddress) Nullable
cc
Array of objects (EmailAddress) Nullable
bcc
Array of objects (EmailAddress) Nullable
replyTo
object (EmailAddress)
subject
string Nullable
content
Array of objects (BodyContent) Nullable
attachments
Array of objects (EmailAttachment) Nullable
priorityTypeKey
string (PriorityTypeKey)
Enum: "Normal" "Low" "High"
headers
Array of objects (HeaderItem) Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/mail/send
https://example-host/v1.0/mail/send

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "from":
    {
    },
  • "to":
    [
    ],
  • "subject": "testing email",
  • "content":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "messageId": "string",
  • "errorMessages":
    [
    ],
  • "successful": true
}