{"items":[{"type":"link","label":"Transactional Email API","link":"/tem/m4a-api","routeSlug":"/tem/m4a-api","content":{"contentType":"overview","meta":{"name":"Transactional Email API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"m4a-api.json","url":"/_bundle/tem/m4a-api.json?download"},{"kind":"download","label":"m4a-api.yaml","url":"/_bundle/tem/m4a-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/tem/m4a-api","description":"Mock server","isMockServer":true},{"url":"https://mail-de.retarus.com/rest/v2","description":""}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Transactional Email API (1.0.0)","showPageActions":true}],"sectionId":"/tem/m4a-api"}]}]}},{"type":"group","label":"mail","link":"/tem/m4a-api/mail","routeSlug":"/tem/m4a-api/mail","items":[{"label":"sendJobRequest","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tem/m4a-api/mail/sendjobrequest","routeSlug":"/tem/m4a-api/mail/sendjobrequest","metadata":{"seo":{"title":"sendJobRequest"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendJobRequest","name":"sendJobRequest","isWebhook":false,"pointer":"/paths/~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"sendJobRequest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"httpBasicAuth","scopes":[],"type":"http","scheme":"basic","description":"Basic authorization\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailJobRequest","exampleIds":["paths/~1jobs/post/requestBody/content/application~1json/examples/minimal","paths/~1jobs/post/requestBody/content/application~1json/examples/example","paths/~1jobs/post/requestBody/content/application~1json/examples/complete"]}},"schemaId":"components/schemas/EmailJobRequest","exampleIds":["paths/~1jobs/post/requestBody/content/application~1json/examples/minimal","paths/~1jobs/post/requestBody/content/application~1json/examples/example","paths/~1jobs/post/requestBody/content/application~1json/examples/complete"],"pointer":"/paths/~1jobs/post/requestBody","description":"JobRequest - Full Example"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/jobs","servers":[{"url":"/_mock/tem/m4a-api","description":"Mock server","isMockServer":true},{"url":"https://mail-de.retarus.com/rest/v2","description":""}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"httpBasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmailJobRequest","exampleIds":["paths/~1jobs/post/requestBody/content/application~1json/examples/minimal","paths/~1jobs/post/requestBody/content/application~1json/examples/example","paths/~1jobs/post/requestBody/content/application~1json/examples/complete"]}},"responseCodes":["200","400","401","403","429"],"pointer":"/jobs","href":"mail/sendjobrequest","openApiOperationId":"sendJobRequest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tem/m4a-api","description":"Mock server","isMockServer":true},{"url":"https://mail-de.retarus.com/rest/v2","description":""}],"schemaId":"components/schemas/EmailJobRequest","exampleIds":["paths/~1jobs/post/requestBody/content/application~1json/examples/minimal","paths/~1jobs/post/requestBody/content/application~1json/examples/example","paths/~1jobs/post/requestBody/content/application~1json/examples/complete"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailJobRequest","exampleIds":["paths/~1jobs/post/requestBody/content/application~1json/examples/minimal","paths/~1jobs/post/requestBody/content/application~1json/examples/example","paths/~1jobs/post/requestBody/content/application~1json/examples/complete"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseAccepted","exampleIds":["paths/~1jobs/post/responses/200/content/application~1json/examples/accepted","paths/~1jobs/post/responses/200/content/application~1json/examples/partial"]}},"schemaId":"components/schemas/ResponseAccepted","exampleIds":["paths/~1jobs/post/responses/200/content/application~1json/examples/accepted","paths/~1jobs/post/responses/200/content/application~1json/examples/partial"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/403/content/application~1json/example"]},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/429/content/application~1json/example"]}],"pointer":"/paths/~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResponseAccepted","exampleIds":["paths/~1jobs/post/responses/200/content/application~1json/examples/accepted","paths/~1jobs/post/responses/200/content/application~1json/examples/partial"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseAccepted","exampleIds":["paths/~1jobs/post/responses/200/content/application~1json/examples/accepted","paths/~1jobs/post/responses/200/content/application~1json/examples/partial"]}}},{"code":"400","schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/400/content/application~1json/example"]}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResponseRejected","exampleIds":["paths/~1jobs/post/responses/429/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mail/sendjobrequest"}],"panels":[]}]},"httpPath":"/jobs"}],"content":{"contentType":"group","meta":{"name":"mail"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"mail","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/jobs","summary":"sendJobRequest","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mail/sendjobrequest","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/EmailJobRequest":{"id":"components/schemas/EmailJobRequest","kind":"json-schema","title":"EmailJobRequest","data":{"type":"object","required":["mail","recipients","subject"],"properties":{"mail":{"$ref":"#/components/schemas/Mail"},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"},"minItems":1,"maxItems":100},"subject":{"$ref":"#/components/schemas/Subject"},"body":{"$ref":"#/components/schemas/Body"},"alternative":{"$ref":"#/components/schemas/Alternative"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"minItems":1,"maxItems":20},"job":{"$ref":"#/components/schemas/Job"},"notification":{"$ref":"#/components/schemas/Notification"}}}},"components/schemas/Subject":{"id":"components/schemas/Subject","kind":"json-schema","title":"Subject","data":{"type":"object","properties":{"content":{"type":"string","maxLength":500,"description":"Email subject. Max length 500 characters."},"template":{"type":"string","description":"Template for email subject.","example":"Subject-Standard-Text ${name}"},"contentEncoding":{"type":"string","enum":["plain","base64","quoted-printable"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default=plain"},"children":[]}]}]}],"example":"plain"},"contentTransferEncoding":{"type":"string","enum":["base64"],"example":"base64"},"charset":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default=UTF-8"},"children":[]}]}]}],"example":"UTF-8"}}}},"components/schemas/Mail":{"id":"components/schemas/Mail","kind":"json-schema","title":"Mail","data":{"type":"object","required":["from"],"properties":{"from":{"$ref":"#/components/schemas/EmailAddress"},"mimeFrom":{"$ref":"#/components/schemas/EmailAddress"},"replyTo":{"$ref":"#/components/schemas/EmailAddress"},"inReplyTo":{"type":"string","example":"<1234@example.com>"},"priority":{"$ref":"#/components/schemas/MailPriority"},"xHeaders":{"$ref":"#/components/schemas/EmailHeaders"}}}},"components/schemas/EmailAddress":{"id":"components/schemas/EmailAddress","kind":"json-schema","title":"EmailAddress","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","maxLength":254,"example":"john.doe@example.com"}}}},"components/schemas/EmailHeaders":{"id":"components/schemas/EmailHeaders","kind":"json-schema","title":"EmailHeaders","data":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header names must start with X- max header count=10"},"children":[]}]}]}],"maxProperties":10,"example":{"X-MY-ADDITIONAL-HEADER":"value1234"}}},"components/schemas/Recipient":{"id":"components/schemas/Recipient","kind":"json-schema","title":"Recipient","data":{"type":"object","required":["mail"],"properties":{"mail":{"$ref":"#/components/schemas/RecipientsMail"},"reference":{"type":"string","maxLength":50,"example":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c"},"features":{"$ref":"#/components/schemas/RecipientFeatures"}}}},"components/schemas/RecipientsMail":{"id":"components/schemas/RecipientsMail","kind":"json-schema","title":"RecipientsMail","data":{"type":"object","required":["to"],"properties":{"to":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"},"minItems":1},"cc":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"},"minItems":1},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"},"minItems":1},"replyTo":{"$ref":"#/components/schemas/EmailAddress"},"inReplyTo":{"type":"string","example":"<1234@example.com>"},"priority":{"$ref":"#/components/schemas/MailPriority"},"listUnsubscribe":{"type":"string"},"listHelp":{"type":"string"},"xHeaders":{"$ref":"#/components/schemas/EmailHeaders"}}}},"components/schemas/MailPriority":{"id":"components/schemas/MailPriority","kind":"json-schema","title":"MailPriority","data":{"type":"string","enum":["HIGH","NORMAL","LOW"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default=NORMAL"},"children":[]}]}]}],"example":"NORMAL"}},"components/schemas/RecipientFeatures":{"id":"components/schemas/RecipientFeatures","kind":"json-schema","title":"RecipientFeatures","data":{"type":"object","properties":{"openTracking":{"type":"object","properties":{"active":{"type":"boolean"}}},"linkTracking":{"type":"object","properties":{"active":{"type":"boolean"}}},"templating":{"properties":{"personalization":{"type":"object","additionalProperties":{"type":"string"},"description":"key-value-map with personalization information","example":{"name":"John","surname":"Doe"}}}}}}},"components/schemas/Job":{"id":"components/schemas/Job","kind":"json-schema","title":"Job","data":{"type":"object","properties":{"referenceJob":{"type":"string","maxLength":50,"example":"632cdc56-6480-406b-8faf-5a7e70876d0c"},"costCenter":{"type":"string","maxLength":50,"example":"cost-center"},"campaignId":{"type":"string","maxLength":50,"example":"zOsVEmBBV3TYzTPe"},"features":{"$ref":"#/components/schemas/JobFeatures"}}}},"components/schemas/JobFeatures":{"id":"components/schemas/JobFeatures","kind":"json-schema","title":"JobFeatures","data":{"type":"object","properties":{"openTracking":{"type":"object","properties":{"active":{"type":"boolean"}}},"linkTracking":{"type":"object","properties":{"active":{"type":"boolean"}}},"antivirus":{"type":"object","properties":{"active":{"type":"boolean"}}},"templating":{"type":"object","properties":{"active":{"type":"boolean"}}},"messageSigning":{"type":"object","properties":{"active":{"type":"boolean"}}},"secureDocument":{"type":"object","properties":{"active":{"type":"boolean"},"filename":{"type":"string","maxLength":50},"subjectPrefix":{"type":"string","maxLength":50},"password":{"type":"object","properties":{"password":{"type":"string","enum":["MEDIUM","HIGH","VERY_HIGH"]}}}}}}}},"components/schemas/Body":{"id":"components/schemas/Body","kind":"json-schema","title":"Body","data":{"type":"object","required":["contentType"],"properties":{"contentType":{"type":"string","enum":["text/plain","text/html"],"example":"text/html"},"charset":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default=UTF-8"},"children":[]}]}]}],"example":"UTF-8"},"contentEncoding":{"type":"string","enum":["plain","quoted-printable","base64"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default=plain"},"children":[]}]}]}],"example":"quoted-printable"},"contentTransferEncoding":{"type":"string","enum":["base64"],"example":"base64"},"content":{"type":"string","example":"<html><body>hello world</body></html>"},"template":{"type":"string","description":"Template for email body."}}}},"components/schemas/Alternative":{"id":"components/schemas/Alternative","kind":"json-schema","title":"Alternative","data":{"type":"object","properties":{"charset":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default=UTF-8"},"children":[]}]}]}],"example":"UTF-8"},"contentEncoding":{"type":"string","enum":["plain","quoted-printable","base64"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default=plain"},"children":[]}]}]}],"example":"quoted-printable"},"contentTransferEncoding":{"type":"string","enum":["base64"],"example":"base64"},"content":{"type":"string","example":"hello world."},"template":{"type":"string","description":"Template for email alternative."}}}},"components/schemas/Attachment":{"id":"components/schemas/Attachment","kind":"json-schema","title":"Attachment","data":{"type":"object","required":["name","contentType","content"],"properties":{"name":{"type":"string","example":"name.pdf"},"contentType":{"type":"string","example":"application/pdf"},"contentId":{"type":"string","maxLength":100},"content":{"type":"string","format":"byte","description":"base64 encoded content","example":"UmV0YXJ1cyEhCg=="},"secureDocument":{"type":"boolean"}}}},"components/schemas/Notification":{"id":"components/schemas/Notification","kind":"json-schema","title":"Notification","data":{"type":"object","properties":{"endPoint":{"$ref":"#/components/schemas/NotificationEndpoint"}}}},"components/schemas/NotificationEndpoint":{"id":"components/schemas/NotificationEndpoint","kind":"json-schema","title":"NotificationEndpoint","data":{"type":"object","required":["url"],"properties":{"url":{"type":"string","maxLength":1000,"example":"https://notification-endpoint.example.com/"},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"additional HTTP Headers for the notifications","example":{"X-REQUEST-ID":"3a5d3643-cc2b-41ba-b54f-9bb6a9de6b18"}},"authentication":{"$ref":"#/components/schemas/NotificationAuthentication"}}}},"components/schemas/NotificationAuthentication":{"id":"components/schemas/NotificationAuthentication","kind":"json-schema","title":"NotificationAuthentication","data":{"type":"object","required":["method","user","password"],"properties":{"method":{"type":"string","enum":["BASIC"],"example":"BASIC"},"user":{"type":"string","maxLength":100,"example":"notification-user"},"password":{"type":"string","maxLength":100,"example":"dfghoxjuvnzeso374i"}}}},"components/schemas/ResponseAccepted":{"id":"components/schemas/ResponseAccepted","kind":"json-schema","title":"ResponseAccepted","data":{"type":"object","required":["meta"],"properties":{"meta":{"$ref":"#/components/schemas/ResponseMeta"},"content":{"$ref":"#/components/schemas/ResponseContent"}}}},"components/schemas/ResponseRejected":{"id":"components/schemas/ResponseRejected","kind":"json-schema","title":"ResponseRejected","data":{"type":"object","required":["meta"],"properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaBasic"}}}},"components/schemas/ResponseMetaBasic":{"id":"components/schemas/ResponseMetaBasic","kind":"json-schema","title":"ResponseMetaBasic","data":{"type":"object","required":["jobId","state"],"properties":{"jobId":{"type":"string"},"state":{"$ref":"#/components/schemas/ResponseState"},"accountId":{"type":"string"}}}},"components/schemas/ResponseMeta":{"id":"components/schemas/ResponseMeta","kind":"json-schema","title":"ResponseMeta","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/ResponseMetaBasic"}],"properties":{"receivedTs":{"type":"string","format":"date-time"},"campaignId":{"type":"string"},"costCenter":{"type":"string"},"referenceJob":{"type":"string"}}}},"components/schemas/ResponseState":{"id":"components/schemas/ResponseState","kind":"json-schema","title":"ResponseState","data":{"type":"object","properties":{"type":{"type":"string"},"subType":{"type":"string"},"phase":{"type":"string"},"description":{"type":"string"}}}},"components/schemas/ResponseContent":{"id":"components/schemas/ResponseContent","kind":"json-schema","title":"ResponseContent","data":{"type":"object","properties":{"recipients":{"type":"array","items":{"$ref":"#/components/schemas/RecipientResponse"}}}}},"components/schemas/RecipientResponse":{"id":"components/schemas/RecipientResponse","kind":"json-schema","title":"RecipientResponse","data":{"type":"object","required":["mail"],"properties":{"mail":{"$ref":"#/components/schemas/RecipientMailResponse"},"referenceRecipients":{"type":"string"}}}},"components/schemas/RecipientMailResponse":{"id":"components/schemas/RecipientMailResponse","kind":"json-schema","title":"RecipientMailResponse","data":{"type":"object","required":["to"],"properties":{"to":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressResponse"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressResponse"}},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddressResponse"}}}}},"components/schemas/EmailAddressResponse":{"id":"components/schemas/EmailAddressResponse","kind":"json-schema","title":"EmailAddressResponse","data":{"type":"object","required":["id"],"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"properties":{"id":{"type":"string","example":"22579950-b1cb-4ad8-be2b-715d63a06fcd#999dc92b#a0b50b76"},"validationResult":{"$ref":"#/components/schemas/ValidationResult"}}}},"components/schemas/ValidationResult":{"id":"components/schemas/ValidationResult","kind":"json-schema","title":"ValidationResult","data":{"type":"object","properties":{"classifier":{"type":"string"},"message":{"type":"string"}}}}},"exampleStore":{"components/examples/EmailJobMinimalRequest":{"id":"components/examples/EmailJobMinimalRequest","value":{"subject":{"content":"minimal subject"},"recipients":[{"mail":{"to":[{"email":"test-01@null.dev.retloc"}]}}],"mail":{"from":{"email":"test@bot.com"}}},"summary":"minimal"},"components/examples/EmailJobExampleRequest":{"id":"components/examples/EmailJobExampleRequest","value":{"mail":{"from":{"email":"john.doe@example.com"}},"recipients":[{"mail":{"to":[{"email":"jane.doe@example.com"}]}}],"subject":{"content":"Hello"},"body":{"contentType":"text/html","content":"<html><body>hello world</body></html>"},"alternative":{"content":"hello world"},"attachments":[{"name":"name.pdf","contentType":"application/pdf","content":"aGVsbG8gd29ybGQ="}],"job":{"referenceJob":"632cdc56-6480-406b-8faf-5a7e70876d0c","costCenter":"cost-center","campaignId":"zOsVEmBBV3TYzTPe"}},"summary":"example"},"components/examples/EmailJobCompleteRequest":{"id":"components/examples/EmailJobCompleteRequest","value":{"mail":{"from":{"email":"john.doe@example.com"},"mimeFrom":{"email":"john.doe@example.com"},"replyTo":{"email":"john.doe@example.com"},"inReplyTo":"<1234@example.com>","priority":"NORMAL","xHeaders":{"X-MY-ADDITIONAL-HEADER":"value1234"}},"recipients":[{"mail":{"to":[{"email":"john.doe@example.com"}],"cc":[{"email":"john.doe@example.com"}],"bcc":[{"email":"john.doe@example.com"}],"replyTo":{"email":"john.doe@example.com"},"inReplyTo":"<1234@example.com>","priority":"NORMAL","listUnsubscribe":"string","listHelp":"string","xHeaders":{"X-MY-ADDITIONAL-HEADER":"value1234"}},"reference":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c","features":{"openTracking":{"active":true},"linkTracking":{"active":true},"templating":{"personalization":{"name":"John","surname":"Doe"}}}}],"subject":{"content":"string","template":"Subject-Standard-Text ${name}","contentEncoding":"plain","contentTransferEncoding":"base64","charset":"UTF-8"},"body":{"contentType":"text/html","charset":"UTF-8","contentEncoding":"quoted-printable","contentTransferEncoding":"base64","content":"<html><body>hello world</body></html>","template":"string"},"alternative":{"charset":"UTF-8","contentEncoding":"quoted-printable","contentTransferEncoding":"base64","content":"hello world.","template":"string"},"attachments":[{"name":"name.pdf","contentType":"application/pdf","contentId":"string","content":"string","secureDocument":true}],"job":{"referenceJob":"632cdc56-6480-406b-8faf-5a7e70876d0c","costCenter":"cost-center","campaignId":"zOsVEmBBV3TYzTPe","features":{"openTracking":{"active":true},"linkTracking":{"active":true},"antivirus":{"active":true},"templating":{"active":true},"messageSigning":{"active":true},"secureDocument":{"active":true,"filename":"string","subjectPrefix":"string","password":{"password":"MEDIUM"}}}},"notification":{"endPoint":{"url":"https://notification-endpoint.example.com/","headers":{"X-REQUEST-ID":"3a5d3643-cc2b-41ba-b54f-9bb6a9de6b18"},"authentication":{"method":"BASIC","user":"notification-user","password":"dfghoxjuvnzeso374i"}}}},"summary":"complete"},"components/examples/ResponseAccepted":{"id":"components/examples/ResponseAccepted","value":{"meta":{"jobId":"22579950-b1cb-4ad8-be2b-715d63a06fcd","state":{"type":"ACCEPTED","subType":"FULL","phase":"PRE_PROCESS"}},"content":{"recipients":[{"mail":{"to":[{"email":"john.doe@example.com","id":"22579950-b1cb-4ad8-be2b-715d63a06fcd#999dc92b#a0b50b76"}]}}]}},"summary":"accepted"},"components/examples/ResponseAcceptedPart":{"id":"components/examples/ResponseAcceptedPart","value":{"meta":{"jobId":"22579950-b1cb-4ad8-be2b-715d63a06fcd","receivedTs":"2023-02-02T08:51:42.097Z","state":{"type":"ACCEPTED","subType":"PART","phase":"PRE_PROCESS"}},"content":{"recipients":[{"mail":{"to":[{"id":"22579950-b1cb-4ad8-be2b-715d63a06fcd#999dc92b#92059835","email":"jane.doe@example.com"},{"id":"22579950-b1cb-4ad8-be2b-715d63a06fcd#999dc92b#a0b50b76","email":"not-an-address","validationResult":{"classifier":"INVALID_FORMAT"}}]}}]}},"summary":"partial accepted"},"paths/~1jobs/post/requestBody/content/application~1json/examples/minimal":{"value":{"subject":{"content":"minimal subject"},"recipients":[{"mail":{"to":[{"email":"test-01@null.dev.retloc"}]}}],"mail":{"from":{"email":"test@bot.com"}}},"key":"minimal","summary":"minimal","id":"paths/~1jobs/post/requestBody/content/application~1json/examples/minimal"},"paths/~1jobs/post/requestBody/content/application~1json/examples/example":{"value":{"mail":{"from":{"email":"john.doe@example.com"}},"recipients":[{"mail":{"to":[{"email":"jane.doe@example.com"}]}}],"subject":{"content":"Hello"},"body":{"contentType":"text/html","content":"<html><body>hello world</body></html>"},"alternative":{"content":"hello world"},"attachments":[{"name":"name.pdf","contentType":"application/pdf","content":"aGVsbG8gd29ybGQ="}],"job":{"referenceJob":"632cdc56-6480-406b-8faf-5a7e70876d0c","costCenter":"cost-center","campaignId":"zOsVEmBBV3TYzTPe"}},"key":"example","summary":"example","id":"paths/~1jobs/post/requestBody/content/application~1json/examples/example"},"paths/~1jobs/post/requestBody/content/application~1json/examples/complete":{"value":{"mail":{"from":{"email":"john.doe@example.com"},"mimeFrom":{"email":"john.doe@example.com"},"replyTo":{"email":"john.doe@example.com"},"inReplyTo":"<1234@example.com>","priority":"NORMAL","xHeaders":{"X-MY-ADDITIONAL-HEADER":"value1234"}},"recipients":[{"mail":{"to":[{"email":"john.doe@example.com"}],"cc":[{"email":"john.doe@example.com"}],"bcc":[{"email":"john.doe@example.com"}],"replyTo":{"email":"john.doe@example.com"},"inReplyTo":"<1234@example.com>","priority":"NORMAL","listUnsubscribe":"string","listHelp":"string","xHeaders":{"X-MY-ADDITIONAL-HEADER":"value1234"}},"reference":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c","features":{"openTracking":{"active":true},"linkTracking":{"active":true},"templating":{"personalization":{"name":"John","surname":"Doe"}}}}],"subject":{"content":"string","template":"Subject-Standard-Text ${name}","contentEncoding":"plain","contentTransferEncoding":"base64","charset":"UTF-8"},"body":{"contentType":"text/html","charset":"UTF-8","contentEncoding":"quoted-printable","contentTransferEncoding":"base64","content":"<html><body>hello world</body></html>","template":"string"},"alternative":{"charset":"UTF-8","contentEncoding":"quoted-printable","contentTransferEncoding":"base64","content":"hello world.","template":"string"},"attachments":[{"name":"name.pdf","contentType":"application/pdf","contentId":"string","content":"string","secureDocument":true}],"job":{"referenceJob":"632cdc56-6480-406b-8faf-5a7e70876d0c","costCenter":"cost-center","campaignId":"zOsVEmBBV3TYzTPe","features":{"openTracking":{"active":true},"linkTracking":{"active":true},"antivirus":{"active":true},"templating":{"active":true},"messageSigning":{"active":true},"secureDocument":{"active":true,"filename":"string","subjectPrefix":"string","password":{"password":"MEDIUM"}}}},"notification":{"endPoint":{"url":"https://notification-endpoint.example.com/","headers":{"X-REQUEST-ID":"3a5d3643-cc2b-41ba-b54f-9bb6a9de6b18"},"authentication":{"method":"BASIC","user":"notification-user","password":"dfghoxjuvnzeso374i"}}}},"key":"complete","summary":"complete","id":"paths/~1jobs/post/requestBody/content/application~1json/examples/complete"},"paths/~1jobs/post/responses/200/content/application~1json/examples/accepted":{"value":{"meta":{"jobId":"22579950-b1cb-4ad8-be2b-715d63a06fcd","state":{"type":"ACCEPTED","subType":"FULL","phase":"PRE_PROCESS"}},"content":{"recipients":[{"mail":{"to":[{"email":"john.doe@example.com","id":"22579950-b1cb-4ad8-be2b-715d63a06fcd#999dc92b#a0b50b76"}]}}]}},"key":"accepted","summary":"accepted","id":"paths/~1jobs/post/responses/200/content/application~1json/examples/accepted"},"paths/~1jobs/post/responses/200/content/application~1json/examples/partial":{"value":{"meta":{"jobId":"22579950-b1cb-4ad8-be2b-715d63a06fcd","receivedTs":"2023-02-02T08:51:42.097Z","state":{"type":"ACCEPTED","subType":"PART","phase":"PRE_PROCESS"}},"content":{"recipients":[{"mail":{"to":[{"id":"22579950-b1cb-4ad8-be2b-715d63a06fcd#999dc92b#92059835","email":"jane.doe@example.com"},{"id":"22579950-b1cb-4ad8-be2b-715d63a06fcd#999dc92b#a0b50b76","email":"not-an-address","validationResult":{"classifier":"INVALID_FORMAT"}}]}}]}},"key":"partial","summary":"partial accepted","id":"paths/~1jobs/post/responses/200/content/application~1json/examples/partial"},"paths/~1jobs/post/responses/400/content/application~1json/example":{"value":{"meta":{"jobId":"7fd6ec7a-194e-43d4-b54f-19312bb4124d","state":{"type":"REJECTED","subType":"INVALID_VALUE","phase":"PRE_PROCESS","description":"Invalid value for mail.from"}}},"id":"paths/~1jobs/post/responses/400/content/application~1json/example"},"paths/~1jobs/post/responses/403/content/application~1json/example":{"value":{"meta":{"jobId":"8764f6fd-7227-40f8-b242-ff21d02845e9","state":{"type":"REJECTED","subType":"FORBIDDEN_SENDER","phase":"PRE_PROCESS","description":"Unsupported value for mail.from domain - senderDomain not in configured/allowed domains"}}},"id":"paths/~1jobs/post/responses/403/content/application~1json/example"},"paths/~1jobs/post/responses/429/content/application~1json/example":{"value":{"meta":{"jobId":"7fd6ec7a-194e-43d4-b54f-19312bb4124d","state":{"type":"REJECTED","subType":"LIMIT_EXCEEDED","phase":"PRE_PROCESS","description":"Request rate limit per hour exceeded."}}},"id":"paths/~1jobs/post/responses/429/content/application~1json/example"}},"securitySchemeStore":{"httpBasicAuth":{"id":"httpBasicAuth","type":"http","scheme":"basic","description":"Basic authorization\n"}},"servers":[{"url":"/_mock/tem/m4a-api","isMockServer":true,"description":"Mock server"},{"url":"https://mail-de.retarus.com/rest/v2"}]},"options":{"layout":"stacked","hideSidebar":true,"mockServer":{"url":"/_mock/tem/m4a-api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/tem/m4a-api.json?download"},{"url":"/_bundle/tem/m4a-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Transactional Email API","description":""}},"baseSlug":"/tem/m4a-api","routesMapping":{}}