E-Mails

email_log_get_by_id_summary

email_log_get_by_id_description

get/pimcore-studio/api/emails/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/emails/{id}
  • Auth: none declared

Path parameters

idinteger required
Example:83

Id of the E-Mail

Response

email_log_get_by_id_success_response

additionalAttributesobject

AdditionalAttributes

idinteger required

id

sentDateinteger required

sent date

hasHtmlLogboolean required

HTML log exists

hasTextLogboolean required

Text log exists

hasErrorboolean required

Error occurred

fromstring nullable required

from

tostring nullable required

to

subjectstring nullable required

subject

bccstring nullable required

bcc

ccstring nullable required

cc

errorstring nullable required

error

Example response

{
  "id": 23,
  "sentDate": 1707312457,
  "hasHtmlLog": true,
  "hasTextLog": true,
  "hasError": true,
  "from": "from@pimcore.com",
  "to": "to@pimcore.com",
  "subject": "E-Mail subject",
  "bcc": "email@pimcore.com",
  "cc": "email@pimcore.com",
  "error": "Some error occurred"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.