diff --git a/doc/index.html b/doc/index.html index ccd0fce..5e25e4d 100644 --- a/doc/index.html +++ b/doc/index.html @@ -519,12 +519,12 @@ data-styled.g140[id="sc-global-kJtbWf1"]{content:"sc-global-kJtbWf1,"}/*!sc*/ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

EXPMail (0.3)

Download OpenAPI specification:Download

E-mail: support@kumi.systems

A simple endpoint to send email messages

+ " fill="currentColor">

EXPMail (0.4)

Download OpenAPI specification:Download

E-mail: support@kumi.systems

A simple endpoint to send email messages

sending

Sending out an email

Send out an email

Request Body schema: application/json

Object defining the email message to be sent

subject
string

Subject of the email

-
html
string

String containing the HTML content of the email. Takes precedence over htmlurl if provided. If both html and text or texturl are provided, will create a multi-part MIME message.

-
htmlurl
string

String containing the URL to a file containing the HTML content of the email. Ignored if html if provided. If both htmlurl and text or texturl are provided, will create a multi-part MIME message.

+
html
string

String containing the HTML content of the email. Takes precedence over htmlurl if provided. If both html and text or texturl are provided, or the noconversion config key is not provided, will create a multi-part MIME message.

+
htmlurl
string

String containing the URL to a file containing the HTML content of the email. Ignored if html if provided. If both htmlurl and text or texturl are provided, or the noconversion config key is not provided, will create a multi-part MIME message.

text
string

String containing the plain text content of the email. Takes precedence over texturl if provided. If both text and html or htmlurl are provided, will create a multi-part MIME message.

texturl
string

String containing the URL to a file containing the plain text content of the email. Ignored if text is provided. If both texturl and html or htmlurl are provided, will create a multi-part MIME message.

object

Recipient object to be used as "From:" address for the email

@@ -533,11 +533,12 @@ data-styled.g140[id="sc-global-kJtbWf1"]{content:"sc-global-kJtbWf1,"}/*!sc*/
Array of objects (Recipient)

Array of Recipient objects to be used as "BCC:" addresses for the email

Array of objects (Attachment)

Array of Attachment objects to be attached to the email

Array of objects (Placeholder)

Array of Placeholder objects. Any occurrences of {PLACEHOLDER_NAME} (name in all caps enclosed with curly brackets) in the email's HTML or plain text will be replaced by value.

+
Array of objects (Config)

Array of Config objects to change the default behaviour

key
required
string

API key to authenticate request with

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "html": "string",
  • "htmlurl": "string",
  • "text": "string",
  • "texturl": "string",
  • "sender":
    {
    },
  • "recipients":
    [
    ],
  • "ccs":
    [
    ],
  • "bccs":
    [
    ],
  • "attachments":
    [
    ],
  • "placeholders":
    [
    ],
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "error": "string"
}
+

Request samples

Content type
application/json
{
  • "subject": "string",
  • "html": "string",
  • "htmlurl": "string",
  • "text": "string",
  • "texturl": "string",
  • "sender":
    {
    },
  • "recipients":
    [
    ],
  • "ccs":
    [
    ],
  • "bccs":
    [
    ],
  • "attachments":
    [
    ],
  • "placeholders":
    [
    ],
  • "config":
    [
    ],
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "error": "string"
}