{"id":3601,"date":"2023-08-29T20:37:44","date_gmt":"2023-08-29T19:37:44","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3601"},"modified":"2024-06-25T12:41:09","modified_gmt":"2024-06-25T11:41:09","slug":"create-message-content-check-task","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/email-messages\/create-message-content-check-task\/","title":{"rendered":"Create message content check task"},"content":{"rendered":"\n

Allows creating new task to check message content domain links on blacklist<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Data part of request for creating a new task.<\/p>\n\n\n\n

Data element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Html<\/td>string<\/td>HTML content of newsletter. The data should be enclosed in CDATA section for XML transport. See examples. Optional.*<\/td><\/tr>
Plain<\/td>string<\/td>Plain text content of newsletter. Optional.*<\/td><\/tr>
AmpHtml<\/td>string<\/td>AMP HTML content of newsletter. The data should be enclosed in CDATA section for XML transport. See examples. Optional.*<\/td><\/tr>
Preheader<\/td>string<\/td>Newsletter preheader. Optional.<\/td><\/tr>
Header<\/td>integer<\/td>ID of header template to use. Optional.<\/td><\/tr>
Footer<\/td>integer<\/td>ID of footer template to use. Optional.<\/td><\/tr>
ContentFromUrl<\/td>complex<\/td>Used if content is not inside XML request but has to be downloaded from external source. Optional.*<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

* You may either put content of newsletter inside using Html, Plain and\/or AmpHtml elements or specify that content is to be downloaded from external source (such as webpage or FTP server as zipped file with HTML and images) using ContentFromUrl element. If content was not found in either place, an error message will be returned. If there are more than one Html, Plain and\/or AmpHtml files only the last file will be the content of message.If you would like to send AMP Html you should provide Html and\/or Plain as a fallback version of email. AMP Html content must contain all needed elements (see examples) and all links must be secure links (like https:\/\/).<\/p>\n\n\n\n

ContentFromUrl element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Url<\/td>string<\/td>URL address of imported file. Supported protocols are HTTP, HTTPS, FTP, FTPS and SFTP. E.g. ftp:\/\/www.domain.com\/mycreative.zip<\/a>.<\/td><\/tr>
Username<\/td>string<\/td>Username used for authentication. Optional.<\/td><\/tr>
Password<\/td>string<\/td>Password used for authentication. Optional.<\/td><\/tr>
FtpUseActiveMode<\/td>boolean<\/td>If set to “true”, active mode will be used for FTP connections. Default value is “false” – passive connection mode will be used.<\/td><\/tr>
FtpAuth<\/td>string<\/td>Authentication method for secure FTP servers. Optional. Valid values are:
None – FTP server does not support secure authentication (default)
ExplicitTls – Explicit TLS\/SSL authentication
ExplicitSsl – Explicit SSL only authentication
ImplicitSsl – Implicit SSL authentication<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response<\/strong><\/h3>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>Guid<\/td>Id of created check message content task<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples<\/strong><\/h3>\n\n\n\n

Create new task to analyze message content<\/strong><\/p>\n\n\n\n

Request:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/CheckMessageContent HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: text\/xml;charset=UTF-8 <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 457 <\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ApiKey<\/span>><\/span>2OAEcpz0Rwv3Mhc9nTQK<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n       <\/span><<\/span>Plain<\/span>><\/span>Hello friend, how are you?<\/span><\/<\/span>Plain<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 201 Created <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nX-AspNetMvc-Version: 3.0 <\/span><\/span>\nX-AspNet-Version: 4.0.30319 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Tue, 27 Mar 2012 13:28:01 GMT <\/span><\/span>\nContent-Length: 149 <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n    <\/span><<\/span>Id<\/span>><\/span>869786bf-768f-4036-9128-d05667eac888<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Create new task to analyze message content from external source and full options<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/CheckMessageContent HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: text\/xml;charset=UTF-8 <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 1727 <\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ApiKey<\/span>><\/span>2OAEcpz0Rwv3Mhc9nTQK<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n       <\/span><<\/span>ContentFromUrl<\/span>><\/span><\/span>\n         <\/span><<\/span>Url<\/span>><\/span>ftp:\/\/ftp.domain.com.creative.zip<\/span><\/<\/span>Url<\/span>><\/span><\/span>\n         <\/span><<\/span>Username<\/span>><\/span>username<\/span><\/<\/span>Username<\/span>><\/span><\/span>\n         <\/span><<\/span>Password<\/span>><\/span>password<\/span><\/<\/span>Password<\/span>><\/span><\/span>\n         <\/span><<\/span>FtpAuth<\/span>><\/span>ExplicitTls<\/span><\/<\/span>FtpAuth<\/span>><\/span><\/span>\n       <\/span><\/<\/span>ContentFromUrl<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Create new task to analyze message with AMP Html content<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/CheckMessageContent HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nContent-Type: text\/xml;charset=UTF-8<\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nContent-Length: 32566<\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n    <\/span><<\/span>ApiKey<\/span>><\/span>2OAEcpz0Rwv3Mhc9nTQK<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n    <\/span><<\/span>Data<\/span>><\/span><\/span>\n            <\/span><<\/span>Html<\/span>><\/span>Some fallback HTML code here<\/span><\/<\/span>Html<\/span>><\/span><\/span>\n            <\/span><<\/span>AmpHtml<\/span>><\/span><![CDATA[<\/span><\/span>\n            <!doctype html><\/span><\/span>\n            <html amp4email><\/span><\/span>\n            <head><\/span><\/span>\n                <meta charset="utf-8"><\/span><\/span>\n                <script async src="https:\/\/cdn.ampproject.org\/v0.js"><\/script><\/span><\/span>\n                <style amp4email-boilerplate>body{visibility:hidden}<\/style><\/span><\/span>\n            <\/head><\/span><\/span>\n            <body><\/span><\/span>\n                Hello, AMP world.<\/span><\/span>\n<\/span>\n                Please use AMP markup if there is such like "amp-img" instead of "img"<\/span><\/span>\n<\/span>\n                <amp-img src="https:\/\/sites.google.com\/site\/expertsenderapiv2\/_\/rsrc\/1530873497175\/config\/Es-                    API.png.1530873496983.png"<\/span><\/span>\n                    alt="Welcome"<\/span><\/span>\n                    width="906"<\/span><\/span>\n                    height="132"><\/span><\/span>\n                <\/amp-img><\/span><\/span>\n            <\/body><\/span><\/span>\n            <\/html><\/span><\/span>\n            <\/span>]]><\/span><\/<\/span>AmpHtml<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3559,"menu_order":322,"template":"","format":"standard","emp-category":[],"class_list":["post-3601","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3601","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":3,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3601\/revisions"}],"predecessor-version":[{"id":11004,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3601\/revisions\/11004"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3559"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3601"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3601"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}