Transactional emails are emails that are typically related to system or account related activity triggered by customer interactions with your brand. Common examples of these emails are:
- Password reminders / resets
- System notifications
- Order confirmation
- Verification messages
- Shipping confirmation
Transactional Email Web Service Methods
The following table lists supported methods in Transactional Email Web Service and provides a brief description of each method. For more detail on each method, click Click on the method name .for more information:
Warning |
---|
To interact with any Web Services, developers must first use the Login method to create a Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
---|
| . Developers can send requests to other Web Service and methods using this Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
---|
| . |
PostHtml
Back to Top ^
<PostHtml> |
---|
Enables free-Html posting. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromName | Sender's name | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromAddress | Sender's email address | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ReplyAddress | Reply address that will appear on the email | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Subject | Email subject | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
HtmlBody | Email content | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Charset | Character set for HTML | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToName | Recipient's name | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToEmailAddress | Recipient's email address | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Attachments | Attachments to be included in the email | Status |
---|
| |
---|
colour | Yellow |
---|
title | optional |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtml xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>string</Subject>
<HtmlBody>string</HtmlBody>
<Charset>string</Charset>
<ToName>string</ToName>
<ToEmailAddress>string</ToEmailAddress>
<Attachments>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
</Attachments>
</PostHtml>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtmlResponse xmlns="http://ws.euromsg.com/post">
<PostHtmlResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</PostHtmlResult>
</PostHtmlResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | HtmlBody |
---|
| parameter must always have HTML, Head and Body Tags.
|
Note |
---|
Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromName |
---|
| and Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromAddress |
---|
| parameters are pre-defined in your account. You can access these information from settings>sending path.
|
Note |
---|
This service allows you to send informative emails only based on user's actions like account activation, password reset, order confirmation. Advertising/promotional content are excluded. Please contact RMC Technical Client Support Team to obtain more information about sending transactional emails with promotional content. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid email address! | Incorrect/invalid sender email address. |
99 | Not a valid from name! | The FromName information was not defined in your account. |
99 | Not a valid from address! | The FromAdress information was not defined in your account. |
99 | Email address exist in blacklist! | A previous transactional email was marked as spam by email recipient. |
99 | Not a valid HTML! | HTML content format is incorrect. |
PostHtmlWithType
Back to Top ^
<PostHtmlWithType> |
---|
Enables free-Html posting with type. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromName | Sender's name | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromAddress | Sender's email address | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ReplyAddress | Reply address that will appear on the email | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Subject | Email subject | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
HtmlBody | Email content | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Charset | Character set for HTML | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToName | Recipient's name | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToEmailAddress | Recipient's email address | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Attachments | Attachments to be included in the email | Status |
---|
| |
---|
colour | Yellow |
---|
title | optional |
---|
|
|
PostType | Type of the email to be sent | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtmlWithType xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>string</Subject>
<HtmlBody>string</HtmlBody>
<Charset>string</Charset>
<ToName>string</ToName>
<ToEmailAddress>string</ToEmailAddress>
<Attachments>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
</Attachments>
<PostType>string</PostType>
</PostHtmlWithType>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtmlWithTypeResponse xmlns="http://ws.euromsg.com/post">
<PostHtmlWithTypeResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</PostHtmlWithTypeResult>
</PostHtmlWithTypeResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | HtmlBody |
---|
| parameter must always have HTML, Head and Body Tags.
|
Note |
---|
Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromName |
---|
| and Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromAddress |
---|
| parameters are pre-defined in your account. You can access these information from settings>sending path.
|
Note |
---|
PostType parameter is used to group the sent SMS messages for reporting purposes. This is not a predefined parameter. For example for email Password Reminder messages Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Password Reminder |
---|
| can be be used as value. |
Note |
---|
This service allows you to send informative emails only based on user's actions like account activation, password reset, order confirmation. Advertising/promotional content are excluded. Please contact RMC Technical Client Support to obtain more information about sending transactional emails with promotional content. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid email address! | Incorrect/invalid sender email address. |
99 | Not a valid from name! | The FromName information was not defined in your account. |
99 | Not a valid from address! | The FromAdress information was not defined in your account. |
99 | Email address exist in blacklist! | A previous transactional email was marked as spam by email recipient. |
99 | Not a valid HTML! | HTML content format is incorrect. |
PostHtmlWithCCandBCC
Back to Top ^
<PostHtmlWithCCandBCC> |
---|
Enables free-Html posting with CC and BCC. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromName | Sender's name | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromAddress | Sender's email address | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ReplyAddress | Reply address that will appear on the email | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Subject | Email subject | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
HtmlBody | Email content | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Charset | Character set for HTML | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToName | Recipient's name | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToEmailAddress | Recipient's email address | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
CCEmailAddress | Email addresses to be included in CC | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
BCCEmailAddress | Email addresses to be included in BCC | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Attachments | Attachments to be included in the email | Status |
---|
| |
---|
colour | Yellow |
---|
title | optional |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtmlWithCCandBCC xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>string</Subject>
<HtmlBody>string</HtmlBody>
<Charset>string</Charset>
<ToName>string</ToName>
<ToEmailAddress>string</ToEmailAddress>
<CCEmailAddress>string</CCEmailAddress>
<BCCEmailAddress>string</BCCEmailAddress>
<Attachments>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
</Attachments>
</PostHtmlWithCCandBCC>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtmlWithCCandBCCResponse xmlns="http://ws.euromsg.com/post">
<PostHtmlWithCCandBCCResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</PostHtmlWithCCandBCCResult>
</PostHtmlWithCCandBCCResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| the parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | HtmlBody |
---|
| parameter must always have HTML, Head and Body Tags.
|
Note |
---|
Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromName |
---|
| and Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromAddress |
---|
| parameters are pre-defined in your account. You can access these information from settings>sending path.
|
Note |
---|
This service allows you to send informative emails only based on user's actions like account activation, password reset, order confirmation. Advertising/promotional content are excluded. Please contact our support team to obtain more information about sending transactional emails with promotional content. |
Warning |
---|
If any of the recipients in CC, BCC or the original recipient gives a response to an email; the email will be marked as "read". The detail as to which user has given the first response is not stored. Even if only one of the 3 recipient reads the email, the email will be reported as Status |
---|
subtle | true |
---|
colour | Red |
---|
title | READ |
---|
| . |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid email address! | Incorrect/invalid sender email address. |
99 | Not a valid from name! | The FromName information was not defined in your account. |
99 | Not a valid from address! | The FromAdress information was not defined in your account. |
99 | Email address exist in blacklist! | A previous transactional email was marked as spam by email recipient. |
99 | Not a valid HTML! | HTML content format is incorrect. |
PostHtmlWithTypeCCandBCC
Anchor |
---|
| posthtmlwtype |
---|
| posthtmlwtype |
---|
|
Back to Top ^
<PostHtmlWithTypeCCandBCC> |
---|
Enables free-Html posting with Type, CC and BCC |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromName | Sender's name | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromAddress | Sender's email address | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ReplyAddress | Reply address that will appear on the email. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Subject | Email subject. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
HtmlBody | Email content. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Charset | Character set for HTML. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToName | Recipient's name. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToEmailAddress | Recipient's email address. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
CCEmailAddress | Email addresses to be included in CC. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
BCCEmailAddress | Email addresses to be included in BCC. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Attachments | Attachments to be included in the email. | Status |
---|
| |
---|
colour | Yellow |
---|
title | optional |
---|
|
|
PostType | Type of the email to be sent. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtmlWithTypeCCandBCC xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>string</Subject>
<HtmlBody>string</HtmlBody>
<Charset>string</Charset>
<ToName>string</ToName>
<ToEmailAddress>string</ToEmailAddress>
<CCEmailAddress>string</CCEmailAddress>
<BCCEmailAddress>string</BCCEmailAddress>
<Attachments>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
</Attachments>
<PostType>string</PostType>
</PostHtmlWithTypeCCandBCC>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtmlWithTypeCCandBCCResponse xmlns="http://ws.euromsg.com/post">
<PostHtmlWithTypeCCandBCCResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</PostHtmlWithTypeCCandBCCResult>
</PostHtmlWithTypeCCandBCCResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| the parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | HtmlBody |
---|
| parameter must always have HTML, Head and Body Tags.
|
Note |
---|
Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromName |
---|
| and Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromAddress |
---|
| parameters are pre-defined in your account. You can access these information from settings>sending path.
|
Note |
---|
This service allows you to send informative emails only based on user's actions like account activation, password reset, order confirmation. Advertising/promotional content are excluded in this service. Please contact RMC Technical Client Support Team to obtain more information about sending transactional emails with promotional content. |
Note |
---|
PostType parameter is used to group the sent SMS messages for reporting purposes. This is not a predefined parameter. For example for email Password Reminder messages Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Password Reminder |
---|
| can be be used as value. |
Warning |
---|
If any of the recipients in CC, BCC or the original recipient gives a response to an email; the email will be marked as "read". The detail as to which user has given the first response is not stored. Even if only one of the 3 recipient reads the email, the email will be reported as Status |
---|
subtle | true |
---|
colour | Red |
---|
title | READ |
---|
| . |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid email address! | Incorrect/invalid sender email address. |
99 | Not a valid from name! | The FromName information was not defined in your account. |
99 | Not a valid from address! | The FromAdress information was not defined in your account. |
99 | Email address exist in blacklist! | A previous transactional email was marked as spam by email recipient. |
99 | Not a valid HTML! | HTML content format is incorrect. |
PostHtmlWithTypeKeyIDAndCustomParams
Back to Top ^
<PostHtmlWithTypeKeyIDAndCustomParams> |
---|
Enables free-Html posting with Type, Key_ID and Custom Fields. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromName | Sender's name. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromAddress | Sender's email address. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ReplyAddress | Reply address that will appear on the email. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Subject | Subject line. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
HtmlBody | Email content. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Charset | Character set for HTML. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToName | Recipient name. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToEmailAddress | Recipient's email address. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Attachments | Attachments to be included in the email. | Status |
---|
| |
---|
colour | Yellow |
---|
title | optional |
---|
|
|
PostType | Type of email to be sent. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
KeyID | Recipient KEY_ID information. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
CustomParams | Custom parameters found in the email (Ex. promotion code). | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtmlWithTypeKeyIDAndCustomParams xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<Subject>string</Subject>
<HtmlBody>string</HtmlBody>
<Charset>string</Charset>
<ToName>string</ToName>
<ToEmailAddress>string</ToEmailAddress>
<Attachments>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
</Attachments>
<PostType>string</PostType>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
</PostHtmlWithTypeKeyIDAndCustomParams>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostHtmlWithTypeKeyIDAndCustomParamsResponse xmlns="http://ws.euromsg.com/post">
<PostHtmlWithTypeKeyIDAndCustomParamsResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</PostHtmlWithTypeKeyIDAndCustomParamsResult>
</PostHtmlWithTypeKeyIDAndCustomParamsResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | HtmlBody |
---|
| parameter must always have HTML, Head and Body Tags.
|
Note |
---|
Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromName |
---|
| and Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | FromAddress |
---|
| parameters are pre-defined in your account. You can access these information from settings>sending path.
|
Note |
---|
This service allows you to send informative emails only based on user's actions like account activation, password reset, order confirmation. Advertising/promotional content are excluded in this service. Please contact our support team to obtain more information about sending transactional emails with promotional content. |
Note |
---|
PostType parameter is used to group the sent SMS messages for reporting purposes. This is not a predefined parameter. For example for email Password Reminder messages Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Password Reminder |
---|
| can be be used as value. |
Warning |
---|
If any of the recipients in CC, BCC or the original recipient gives a response to an email; the email will be marked as "read". The detail as to which user has given the first response is not stored. Even if only one of the 3 recipient reads the email, the email will be reported as Status |
---|
subtle | true |
---|
colour | Red |
---|
title | READ |
---|
| . |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid email address! | Incorrect/invalid recipient email address. |
99 | Not a valid from name! | The from name information was not defined in your account. |
99 | Not a valid from address! | The from address information was not defined in your account. |
99 | Email address exist in blacklist! | A previous transactional email was marked as spam by the email recipient. |
99 | Not a valid HTML! | HTML content format is incorrect. |
GetPostResult
Anchor |
---|
| getpostresult |
---|
| getpostresult |
---|
|
Back to Top ^
<GetPostResult> |
---|
Queries the status of a transactional email sent. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
PostID | Email ID in question. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostResult xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<PostID>string</PostID>
</GetPostResult>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostResultResponse xmlns="http://ws.euromsg.com/post">
<GetPostResultResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</GetPostResultResult>
</GetPostResultResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
PostID parameter is the 32 bytes long ID returned from the service after the transactional email is sent. |
Error Parameters
Code | Error Message | Descriptiom |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
GetPostBulkResult
Anchor |
---|
| getbulkresult |
---|
| getbulkresult |
---|
|
Back to Top ^
<GetPostBulkResult> |
---|
Queries the status of transactional emails sent between two dates. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
BeginDate | Report beginning date. Date format must be dd.mm.yyyy | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
EndDate | Report ending date. Date format must be dd.mm.yyyy | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkResult xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
</GetPostBulkResult>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkResultResponse xmlns="http://ws.euromsg.com/post">
<GetPostBulkResultResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</GetPostBulkResultResult>
<BulkReport>
<EmPostBulkReport>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
</EmPostBulkReport>
<EmPostBulkReport>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
</EmPostBulkReport>
</BulkReport>
</GetPostBulkResultResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
The date range is limited to a maximum of 24 hours. |
Note |
---|
Date format is Status |
---|
subtle | true |
---|
colour | Red |
---|
title | yyyy-MM-dd hh:mm:ss |
---|
| . |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid date! | The date range entered exceeds 24 hours. |
GetPostBulkBounceResult
Back to Top ^
<GetPostBulkBounceResult> |
---|
Queries the transactional emails reported as invalid or undelivered between two dates. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
BeginDate | Report start date. Date format must be dd.mm.yyyy | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
EndDate | Report end date. Date format must be dd.mm.yyyy | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkBounceResult xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
</GetPostBulkBounceResult>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkBounceResultResponse xmlns="http://ws.euromsg.com/post">
<GetPostBulkBounceResultResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</GetPostBulkBounceResultResult>
<BulkReport>
<EmPostBulkReport>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
</EmPostBulkReport>
<EmPostBulkReport>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
</EmPostBulkReport>
</BulkReport>
</GetPostBulkBounceResultResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
The date range is limited to a maximum of 24 hours. |
Note |
---|
Date format is Status |
---|
subtle | true |
---|
colour | Red |
---|
title | yyyy-MM-dd hh:mm:ss |
---|
| . |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid date! | The date range entered exceeds 24 hours. |
GetPostBulkResultByLastUpdate
Back to Top ^
<GetPostBulkResultByLastUpdate> |
---|
Queries the transactional emails with changed results (read, reported as invalid etc) between two dates. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
BeginDate | Report start date. Date format must be dd.mm.yyyy | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
EndDate | Report end date. Date format must be dd.mm.yyyy | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkResultByLastUpdate xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<BeginDate>string</BeginDate>
<EndDate>string</EndDate>
</GetPostBulkResultByLastUpdate>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkResultByLastUpdateResponse xmlns="http://ws.euromsg.com/post">
<GetPostBulkResultByLastUpdateResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</GetPostBulkResultByLastUpdateResult>
<BulkReport>
<EmPostBulkReport>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
</EmPostBulkReport>
<EmPostBulkReport>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
</EmPostBulkReport>
</BulkReport>
</GetPostBulkResultByLastUpdateResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
The date range is limited to a maximum of 24 hours. |
Note |
---|
Date format is Status |
---|
subtle | true |
---|
colour | Red |
---|
title | yyyy-MM-dd hh:mm:ss |
---|
| . |
Note |
---|
Function returns an email list including only emails for which the deliverability status has changed. For example: if 100 emails are sent, 20 of them are read and 15 of them are invalid or undelivered, the service returns the data only for those 35 emails. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid date! | The date range entered exceeds 24 hours. |
GetPostBulkResultByPostId
Anchor |
---|
| resultbypostid |
---|
| resultbypostid |
---|
|
Back to Top ^
<GetPostBulkResultByPostId> |
---|
Queries the status of transactional emails related to the PostID's. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
postIds | PostID's to question. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkResultByPostId xmlns="http://ws.euromsg.com/post">
<serviceTicket>string</serviceTicket>
<postIds>
<string>string</string>
<string>string</string>
</postIds>
</GetPostBulkResultByPostId>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkResultByPostIdResponse xmlns="http://ws.euromsg.com/post">
<GetPostBulkResultByPostIdResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</GetPostBulkResultByPostIdResult>
<bulkResult>
<EmPostResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</EmPostResult>
<EmPostResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</EmPostResult>
</bulkResult>
</GetPostBulkResultByPostIdResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
PostTransactionalEmailWithHtmlTemplate
Back to Top ^
<PostTransactionalEmailWithHtmlTemplate> |
---|
Enables Transactional Email with HTML Template posting. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromName | Sender's name. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromAddress | Sender's email address. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ReplyAddress | Reply address that will appear on the email. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
TemplateName | Template name for the email to be sent. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
SubjectVariables | Variables list to be used in the subject line. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
BodyVariables | List of variables to be used in the email body. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Charset | Character set for the email template. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToName | Recipient's name. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToEmailAddress | Recipient's email address. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Attachments | Attachments to be included in the email. | Status |
---|
| |
---|
colour | Yellow |
---|
title | optional |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostTransactionalEmailWithHtmlTemplate xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<TemplateName>string</TemplateName>
<SubjectVariables>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
</SubjectVariables>
<BodyVariables>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
</BodyVariables>
<Charset>string</Charset>
<ToName>string</ToName>
<ToEmailAddress>string</ToEmailAddress>
<Attachments>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
</Attachments>
</PostTransactionalEmailWithHtmlTemplate>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostTransactionalEmailWithHtmlTemplateResponse xmlns="http://ws.euromsg.com/post">
<PostTransactionalEmailWithHtmlTemplateResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</PostTransactionalEmailWithHtmlTemplateResult>
</PostTransactionalEmailWithHtmlTemplateResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
You can use the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CreateTransactionalEmailTemplate |
---|
| function in the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | template.asmx |
---|
| service in order to define the template that will be used in this function. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Invalid from name! | The from name information was not defined in your account. |
99 | Not a valid from address! | The from address information was not defined in your account. |
99 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Email address exist in blacklist! | A previous transactional email was marked as spam by the email recipient. |
PostTransactionalEmailWithXsltTemplate
Back to Top ^
<PostTransactionalEmailWithXsltTemplate> |
---|
Enables Transactional Email with XSLT Template posting. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromName | Senders's name. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FromAddress | Sender's email address. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ReplyAddress | Reply address that will appear on the email. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
TemplateName | Template name for the email to be sent. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
SubjectVariables | Variables list to be used in the subject line. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
BodyVariables | List of variables to be used in the email body. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Charset | Character set for the email template. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToName | Recipient's name. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ToEmailAddress | Recipient's email address. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Attachments | Attachments to be included in the email. | Status |
---|
| |
---|
colour | Yellow |
---|
title | optional |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PostTransactionalEmailWithXsltTemplate xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<TemplateName>string</TemplateName>
<Xml>string</Xml>
<Charset>string</Charset>
<ToName>string</ToName>
<ToEmailAddress>string</ToEmailAddress>
<Attachments>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
</Attachments>
</PostTransactionalEmailWithXsltTemplate>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<PostTransactionalEmailWithXsltTemplate xmlns="http://ws.euromsg.com/post">
<ServiceTicket>string</ServiceTicket>
<FromName>string</FromName>
<FromAddress>string</FromAddress>
<ReplyAddress>string</ReplyAddress>
<TemplateName>string</TemplateName>
<Xml>string</Xml>
<Charset>string</Charset>
<ToName>string</ToName>
<ToEmailAddress>string</ToEmailAddress>
<Attachments>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
<EmAttachment>
<Name>string</Name>
<Type>string</Type>
<Content>base64Binary</Content>
</EmAttachment>
</Attachments>
</PostTransactionalEmailWithXsltTemplate>
</soap12:Body>
</soap12:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Note |
---|
You can use the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | CreateTransactionalEmailTemplate |
---|
| function in the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | template.asmx |
---|
| service in order to define the template that will be used in this function. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Invalid from name! | The from name information was not defined in your account. |
99 | Not a valid from address! | The from address information was not defined in your account. |
99 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Email address exist in blacklist! | A previous transactional email was marked as spam by email recipient. |
GetPostBulkResultWithOptional
Anchor |
---|
| GetPostBulkResultWithOptional |
---|
| GetPostBulkResultWithOptional |
---|
|
Back to Top ^
<GetPostBulkResultWithOptional> |
---|
Queries the status of transactional emails related to the Optional. |
Parameters
Parameter | Value |
|
---|
ServiceTicket | ServiceTicket obtained through Login. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
beginDateStr | Email start date. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
endDateStr | Email end date. |
|
postType | Type of email to be sent. |
|
toAddress | Recipient's email address. |
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkResultWithOptional xmlns="http://ws.euromsg.com/post">
<serviceTicket>string</serviceTicket>
<beginDateStr>string</beginDateStr>
<endDateStr>string</endDateStr>
<postType>string</postType>
<toAddress>string</toAddress>
</GetPostBulkResultWithOptional>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPostBulkResultWithOptionalResponse xmlns="http://ws.euromsg.com/post">
<GetPostBulkResultWithOptionalResult>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
<FromAdress>string</FromAdress>
<ReplyAdress>string</ReplyAdress>
<Subject>string</Subject>
<ToAddress>string</ToAddress>
</GetPostBulkResultWithOptionalResult>
<BulkReport>
<EmPostBulkReport>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
</EmPostBulkReport>
<EmPostBulkReport>
<PostID>string</PostID>
<RelayStatus>string</RelayStatus>
<DeliveryStatus>string</DeliveryStatus>
<UndeliveryReason>string</UndeliveryReason>
<MarkedSpam>boolean</MarkedSpam>
<KeyID>string</KeyID>
<CustomParams>string</CustomParams>
<PostType>string</PostType>
<ReadTime>string</ReadTime>
<RelayBounceTime>string</RelayBounceTime>
<LastUpdateTime>string</LastUpdateTime>
</EmPostBulkReport>
</BulkReport>
</GetPostBulkResultWithOptionalResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
Parent Topic: SOAP Web Service