You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 41
Next »
Overview
The service is available at the following locations:
https://wsvc.ss.mailup.it/MailupSend.asmx
http://services.mailupnet.it/mailupsend.asmx
The corresponding WSDL is available at the following location:
https://wsvc.ss.mailup.it/MailupSend.asmx?WSDL
The WebService is accessible through the SOAP protocol
Authentication
LoginFromId method
This method is available only from MailUp release 7.4 and it's very similar to the previous one (Login) but it allows to specify an account ID instead of a console URL. The main benefit lies in the fact that a URL limits the use of the infrastructure, whereas a fixed reference like the console ID makes it easier to move the administration console on a higher-performing hardware, if needed. There would be little or no malfunction, as the customer's applications would keep on working after the operation.
- string LoginFromId(string user, string pwd, int consoleId).
- user: username to access the MailUp console
- pwd: password to access the MailUp console
- consoleId: console identifier. The console ID can be drawn from the username associated to the console, without the initial "m" (e.g. username: m1234 > console ID 1234). In case it is not possible to get the console ID from the username, please contact our support team
Examples
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ws="http://services.mailupnet.it/WS">
<soap:Header/>
<soap:Body>
<ws:LoginFromId>
<!--you can use special username ('a'+consoleID, whose password never expires) that is defined in Manage/web services page-->
<ws:user>a1234</ws:user>
<ws:pwd>password</ws:pwd>
<ws:consoleId>1234</ws:consoleId>
</ws:LoginFromId>
</soap:Body>
</soap:Envelope>
<LoginResult>
<errorCode>0</errorCode>
<errorDescription></errorDescription>
<!--Use accessKey value that is returned by LoginFromId method-->
<ws:accessKey>HzAgwRRJaAKBtkgNWpkAuURfV4SxMm6T3HJegRuSkUivKJElNNcmSQe8nqGyoM9</ws:accessKey>
</LoginResult>
<?php
// The sample code described herein is provided on an "as is" basis, without warranty of any kind.
// MailUp shall not be liable for any direct, indirect or consequential damages or costs of any type arising out of any action taken by you or others related to the sample code.
class MailUpWsSend {
protected $WSDLUrl = "http://services.mailupnet.it/MailupSend.asmx?WSDL";
private $soapClient;
private $xmlResponse;
protected $domResult;
function __construct() {
$this->soapClient = new SoapClient($this->WSDLUrl, array("trace" => 1, "exceptions" => 0));
}
function __destruct() {
unset($this->soapClient);
}
public function getFunctions() {
print_r($this->soapClient->__getFunctions());
}
public function loginFromId() {
try {
$loginData = array("user" => "user",
"pwd" => "password",
"consoleId" => "idconsole");
$this->soapClient->loginFromId($loginData);
if ($this->readReturnCode("LoginFromId","errorCode") != 0) {
echo "<br /><br />Error in LoginFromId: ". $this->readReturnCode("LoginFromId","errorDescription");
die();
}
else $this->accessKey = $this->readReturnCode("LoginFromId","accessKey");
echo "<br>AccesKey: ". $this->accessKey;
} catch (SoapFault $soapFault) {
var_dump($soapFault);
}
}
public function logout() {
try {
$this->soapClient->Logout(array("accessKey" => $this->accessKey));
if ($this->readReturnCode("Logout","errorCode") != 0)
echo "<br /><br />Error in Logout". $this->readReturnCode("Logout","errorDescription");
} catch (SoapFault $soapFault) {
var_dump($soapFault);
}
}
private function readReturnCode($func, $param) {
$this->xmlResponse = $this->soapClient->__getLastResponse();
$dom = new DomDocument();
$dom->loadXML($this->xmlResponse) or die("(1)XML file is not valid!");
$xmlResult = $dom->getElementsByTagName($func."Result");
$this->domResult = new DomDocument();
$this->domResult->LoadXML(html_entity_decode($xmlResult->item(0)->nodeValue)) or die("(2)XML file is not valid!");
$rCode = $this->domResult->getElementsByTagName($param);
return $rCode->item(0)->nodeValue;
}
//... other functions...
// public function functionName(...) {...}
}
?>
<html>
<head></head>
<body>
<?php
$WsSend = new MailUpWsSend();
$WsSend->loginFromId();
// use $WsSend->functionName(...) to call other methods
$WsSend->logout();
?>
</body>
</html>
Logout method
Deletes the accessKey from the list, so that it can be no longer used. In case the method is not called, the accessKey remains active for 60 minutes
- string Logout(string accessKey)
- accessKey: access key obtained by calling the Login method
- LogoutResult: string containing the outcome of the operation
Sample LogoutResult response
<LogoutResult>
<errorCode>0</errorCode>
<errorDescription></errorDescription>
</LogoutResult>