Email & SMTP Service

Send email alerts and notifications with your Murano solution.

Your Murano plan provides you a limited amount of free emails for evaluation purposes. If your solution requires additional emails, consider setting up your own SMTP relay server.

You can check your current usage with the getSettings operation.
Before you can use this service, you need to add your email credentials in the service configuration. You can refer to the "configuration" section in following doc for instructions of setting your service configuration - http://docs.exosite.com/development/services/send-notifications.

Operations

Email

• Email.send() - send an email

Settings

• Email.getSettings() - get email settings

Configuration parameters

Operations

send

Send an email message.
If the connection.server attribute is omitted, a limited amount of emails per day are allowed depending on your Murano plan and the email sender is automatically set to _mailrelay@exosite.com_ email address.

Arguments

parameters - object - Object containing service call parameters.

Responses

Email successfully sent

Content: object Email transmission details

Daily email quota reached. Consider adding your personal SMTP server or contact Murano team for upgrading your plan. You can view your current email usage with getSettings operation or on your Murano portal account.

Content: nil

Destination email address has been blocked due to too many bounces or complaints.

Content: nil

Failed to send email. Detailed error is available in the service response.

Content: object Error response

Example

local emailData = {
  from = "me@myemail.com",
  to = {
    "destination1@email.com",
    "destination2@email.com",
  },
  subject = "Hello",
  text = "World",
  html = "<p><b>World</b></p>",
  connection = {
    server = "smtp.myemail.com",
    port = 1234,
    user = "me",
    password = "mysecret"
  }
}
local result = Email.send(emailData)

getSettings

Get email settings, current usage, and quota. Detailed error is available in the service response.

Responses

Email usage information

Content: object Usage and settings information

Failed to get email settings

Content: object Error response

Example

local result = Email.getSettings()
print("I am using " .. result.usage.daily .. " out of my " .. result.quota.daily .. " free daily emails.")