Webservice email: Unterschied zwischen den Versionen
Jan (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Jan (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| Zeile 9: | Zeile 9: | ||
* '''Example''' | * '''Example''' | ||
Dieses Beispiel php versendet eine Mail an die Adresse paul.pfiffig@netzkultur.de | |||
$Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false)); | $Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false)); | ||
$token = $Client->__soapCall("authenticate",array($instanceUrl."?email", $username, $password)); | $token = $Client->__soapCall("authenticate",array($instanceUrl."?email", $username, $password)); | ||
Version vom 21. Dezember 2018, 11:22 Uhr
- WSDL Datei
Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter:
http://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?email
Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl“ benötigt.
- Example
Dieses Beispiel php versendet eine Mail an die Adresse paul.pfiffig@netzkultur.de
$Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false));
$token = $Client->__soapCall("authenticate",array($instanceUrl."?email", $username, $password));
$attachments = array();
$toArray = array(
1' => 'paul.pfiffig@netzkultur.de',
);
$bccArray = array();
$ccArray = array();
$mailTemplate = array(
'MailReceiversTO' => $toArray,
'MailReceiversCC' => $ccArray,
'MailReceiversBCC' => $bccArray,
'MailSubject' => "Hier kommt der Betreff hin.",
'MailText' => "Hier kommt der Inhalt hin.",
'MailSendingAccountID' => 119,
'MailSendingTimestamp' => 0,
'MailType' => 'text/html',
'UserID' => $userID,
'ImportMode' => false,
'DocumentID' => 0,
'Attachments' => $attachments
);
$sendMail= array();
$Client->__soapCall('sendMail', array ($mailTemplate, $token));
- Funktionsübersicht
Authenticate
Authentifiziert einen Benutzer am Webservice
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| instanceName | String | Vollständiger Pfad der Instanz |
| userName | String | infra-struktur Benutzername |
| password | String | infra-struktur Passwort |
Rückgabewert |
||
| token | String | Authentifizierungstoken für weitere Anfragen am Webservice |
archiveMail
Wechselt den Archivierungsstatus einer Mail.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| MailID | integer | Datenbank ID der Mail |
| UserID | integer | ID des Mailabsenders |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Wert: 1 | integer | Hat den Archivierungsstatus einer Mail gewechselt |
createDraft
Erstellt einen Entwurf in der infra-struktur
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| mailData | Array | Array aus Mailvorlage |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Aktion | Erstellt einen Entwurf in der infra-struktur |
getEmptyMailTemplateJson
Holt eine leere Mailvorlage (das mailData Array)
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| mailTemplate | Array | Array mit dem Aufbau der für das mailData Array gebraucht wird |
getMailGroupsForUser
Gibt die Mailgruppen des angegebenen Users aus.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserID | integer | ID des Mailabsenders |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| mailGroups | Array | Array mit GruppenID und Gruppenname |
getNewDirectEmailCount
Gibt die Anzahl an Mails an, die nach einer gewählten Mail angekommen sind.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserID | integer | ID des Mailabsenders |
| lastMailID | integer | MailID der auszuwählenden Mail |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| newMailCount | Array | Array mit MailIDs der neuen Mails |
getNewGlobalizedEmailCount
Gibt die Anzahl an delegierten Mails an, die nach einer gewählten Mail angekommen sind.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserID | integer | ID des Mailabsenders |
| lastMailID | integer | MailID der auszuwählenden Mail |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| newGlobCount | Array | Array mit MailIDs der neuen, globalisierten Mails |
getPostboxesForUser
Zeigt die Postfächer eines gewählten Users an.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserID | integer | ID des Mailabsenders |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| postboxes | Array | Array mit PostfachID und Name des Postfaches |
getStandardTemplateForMailAccountAndUser
Gibt die ID der Standardvorlage eines Users für ein Postfach.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| mailAccountID | integer | Datenbank ID des Mailpostfaches |
| UserID | integer | ID des Mailabsenders |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| templateID | integer | ID der Standardvorlage |
getWebmailTemplate
Holt die Ausgewählte Vorlage in ein Array.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| templateID | integer | Datenbank ID der Standardvorlage |
| UserID | integer | ID des Mailabsenders |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| standardTemplate | Array | Array, im mailData-Format mit den Daten der gewählten Vorlage |
openComposeWindow
Öffnet das "Verfassen"-Fenster mit einer gewählten Vorlage.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserID | integer | ID des Mailabsenders |
| templateID | integer | Datenbank ID der Vorlage |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Aktion | Öffnet das Verfassenfenster |
sendBulkMail
Versendet eine Massenmail
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| mailArray | Array | Array aus mailData-Arrays |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Aktion | Versendet eine Massenmail |
sendMail
Versendet eine Mail.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| mailData | Array | Array mit Maildata |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Aktion | Versendet eine Mail. |
