Save
This operation is part of the Email API section of the Web Services API.
Overview
Saves an email.
Request URL | /api/v2/me/emails/{id} |
---|---|
HTTP Method | POST |
Required Features | api-multimedia |
Parameters
Parameter | Value |
---|---|
operationName | Save |
Specified data with email parameters. (required) |
Parameters
Parameter | Description |
---|---|
subject | A summary of the text. |
bodyAsPlainText | The actual message to send. Plain text body |
body | The actual message to send. Html body |
mime | Multipurpose internet mail extensions. (optional) |
to | One or more target email addresses. (required) |
from | The email’s displayed address or origin. (required) |
cc | Address to send a copy of the email. When there are multiple addresses, they must be comma delimited. (optional) |
bcc | Address to send a blind copy of the email. When there are multiple addresses, they must be comma delimited. (optional) |
Sample
Request
POST api/v2/me/emails/0071023821aec011 { "operationName": "Save", "email": { "body": "Feelslikegood.", "to": [ "qwerty@gplus-w2k3-gf80", "bruce.one@witcher.xyz" ], "from": "GWS@gplus-w2k3-gf80", "subject": "HelloEmail" } }
Response
{ "statusCode": 0 }
Notification
Here are the list of notifications received after save message
Notification with new message
{ "referenceId": 38, "notificationType": "EmailSaved", "messageType": "EmailStateChangeMessage", "email": { "body": "HelloSave", "from": "GWS@gplus-w2k3-gf80", "uri": "http: //localhost: 8080/api/v2/email/01QG9WAK37H38027", "capabilities": [ "Cancel", "Send", "AddComment", "AttachUserData", "UpdateUserData", "DeleteUserData", "SetDisposition", "SetInFocus", "Transfer" ], "to": [ "qwerty@gplus-w2k3-gf80" ], "state": "Composing", "id": "01QG9WAK37H38027", "subject": "Thisisatest" }
This page was last edited on October 31, 2023, at 13:29.
Comments or questions about this documentation? Contact us for support!