| POST | /api/public/email/ | Send email message | Send an email message or a secure message notification. When MessageGuid is provided, a secure message notification is sent. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FromEmail | body | String | Yes | |
| FromName | body | string | No | |
| To | body | String[] | No | To, CC or BCC must contain at least 1 valid email address. |
| Cc | body | String[] | No | To, CC or BCC must contain at least 1 valid email address. |
| Bcc | body | String[] | No | To, CC or BCC must contain at least 1 valid email address. |
| Subject | body | string | No | |
| BodyText | body | string | No | |
| BodyHtml | body | string | No | |
| BodyFormat | body | String | No | Defaults to 'text' if not suppliedAllowable Values
|
| ServiceGuid | body | Guid | No | Service Guid if message is a secure message notification |
| MessageGuid | body | Guid | No | Message Guid if message is a secure message notification |
| AttachmentNames | body | String[] | No | List of Attachment names with extensions if message is a secure message notification. If the AttachmentNames is supplied, the MessageGuid needs to be supplied as well |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/public/email/ HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"fromEmail": "String",
"fromName": "String",
"to": [
"String"
],
"cc": [
"String"
],
"bcc": [
"String"
],
"subject": "String",
"bodyText": "String",
"bodyHtml": "String",
"bodyFormat": "String",
"serviceGuid": "00000000000000000000000000000000",
"messageGuid": "00000000000000000000000000000000",
"attachmentNames": [
"String"
]
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}