Skip to main content
API docs by Redocly

Email Service (1.0)

Download OpenAPI specification:Download

Team Web Platform: team-web-platform@newstore.com URL: https://backstage.p.newstore.io/catalog/default/group/team-web-platform

HTTP API for sending emails. It is only accessible from the shared VPCs.

send-email

Endpoint for sending emails.

Sends an email

The email service creates an email out of the given request and sends it via the tenant specific configured email provider.

header Parameters
Tenant
required
string (tenant)
Request ID
string (request_id)
Request Body schema: application/json
subject
string^(NS-EU-[0-9A-Z]+-[0-9A-Z]+|.+)$

The subject of the email. PII Token is accepted.

recipient
string^(NS-EU-[0-9A-Z]+-[0-9A-Z]+|.+)$

The recipient of the email. PII Token is accepted

message
string^(NS-EU-[0-9A-Z]+-[0-9A-Z]+|.+)$

The content or body of the email. PII Token is accepted

attachments
Array of strings

A list of URLs to download the attachements of the email from. PII Token is accepted

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "recipient": "string",
  • "message": "string",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "message": "string"
}

send-test-email

Endpoint for sending a test email to verify the email configuration.

Send test email

Sends a test email to the given email address to verify the email configuration. If SMTP configuration is not provided in the request, the tenant's stored configuration is used.

header Parameters
Tenant
required
string (tenant)
Request ID
string (request_id)
Request Body schema: application/json
email
required
string <email>

The email address to send the test email to

smtp_host
string

SMTP hostname. If not provided, the tenant's stored configuration is used.

smtp_port
string^([0-9]+)$

SMTP port. If not provided, the tenant's stored configuration is used.

smtp_user
string

SMTP username. If not provided, the tenant's stored configuration is used.

smtp_pass
string

SMTP password. If not provided, the tenant's stored configuration is used.

from_name
string

The sender name. If not provided, the tenant's stored configuration is used.

from_address
string

The sender email address. If not provided, the tenant's stored configuration is used.

object

Microsoft OAuth2 authentication configuration. If not provided, the tenant's stored configuration is used.

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "smtp_host": "string",
  • "smtp_port": "string",
  • "smtp_user": "string",
  • "smtp_pass": "string",
  • "from_name": "string",
  • "from_address": "string",
  • "microsoft_auth": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

validate-credentials

Endpoint for validation the credentials defined in config-api.

Validate credentials

The email service validates the credentials given in the request.

header Parameters
Tenant
required
string (tenant)
Request ID
string (request_id)
Request Body schema: application/json
smtp_host
required
string

SMTP hostname

smtp_port
required
string^([0-9]+)$

SMTP port

smtp_user
string

SMTP username

smtp_pass
string

SMTP password

Responses

Request samples

Content type
application/json
{
  • "smtp_host": "string",
  • "smtp_port": "string",
  • "smtp_user": "string",
  • "smtp_pass": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}