Webservice email: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
← Zum vorherigen Versionsunterschied
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(7 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter:
Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter:


http://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?email
http://demo.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.
Dieses in php geschriebene Beispiel beinhaltet die benötigten Strukturen um eine Mail an die Adresse schmelzer@netzkultur.de zu schicken
 
* '''Example'''
   
Dieses in php geschriebene Beispiel beinhaltet die benötigten Strukturen um eine Mail an die Adresse paul.pfiffig@netzkultur.de zu schicken


     <?php
     <?php
Zeile 17: Zeile 13:
     $password = "123456789";
     $password = "123456789";
     $userID = 4;
     $userID = 4;
 
   
     $Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false));
     $Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false));
     $token = $Client->__soapCall("authenticate",array($instanceUrl, $username, $password));
     $token = $Client->__soapCall("authenticate",array($instanceUrl, $username, $password));
Zeile 23: Zeile 19:
     $attachments = array();
     $attachments = array();
     $toArray = array(
     $toArray = array(
           1' => 'paul.pfiffig@netzkultur.de',
           '1' => 'schmelzer@netzkultur.de',
     );
     );
     $bccArray = array();
     $bccArray = array();
     $ccArray = array();
     $ccArray = array();
    $attachments[] = array('AttachmentFilename' => $fileName,
    'AttachmentFilesize' => filesize($filePath),
    'AttachmentFilesourceBase64Encoded' => base64_encode(file_get_contents($filePath)))
      
      
     $mailTemplate = array(
     $mailTemplate = array(
Zeile 333: Zeile 332:
|-
|-
|  || Aktion ||| Versendet eine Mail.
|  || Aktion ||| Versendet eine Mail.
|}
''<u>createDraftFromJSON</u>''
Erstellt einen Entwurf aus einem JSON-String
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MailData    ||String ||| Maildaten als JSON-String
|-
| Token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>setIDO</u>''
Verknüpft eine Mail mit einem Datensatz
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailId    ||Integer ||| ID der Mail
|-
| IdoID    ||Integer ||| ID des Datensatzes
|-
| InstanceID    ||Integer ||| ID der IDO Instanz
|-
| Token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
|}


Zeile 344: Zeile 389:
* [[Webservice_contacts]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_dms]]
* [[Webservice_dmstagging]]
* [[Webservice_ido]]
* [[Webservice_ido]]
* [[Webservice_idolinkings]]
* [[Webservice_msg]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_email]]
* [[Webservice_task]]
* [[Webservice_task]]

Aktuelle Version vom 13. Mai 2026, 11:57 Uhr

  • WSDL Datei

Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter:

http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?email

Dieses in php geschriebene Beispiel beinhaltet die benötigten Strukturen um eine Mail an die Adresse schmelzer@netzkultur.de zu schicken 

    <?php
    
    $instanceUrl = "https://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?email";
    $username = "webservice";
    $password = "123456789";
    $userID = 4;
    
    $Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false));
    $token = $Client->__soapCall("authenticate",array($instanceUrl, $username, $password));
    
    $attachments = array();
    $toArray = array(
         '1' => 'schmelzer@netzkultur.de',
    );
    $bccArray = array();
    $ccArray = array();
    $attachments[] = array('AttachmentFilename' => $fileName,
    'AttachmentFilesize' => filesize($filePath),
    'AttachmentFilesourceBase64Encoded' => base64_encode(file_get_contents($filePath)))
    
    $mailTemplate = array(
         'MailReceiversTO'      => $toArray,
         'MailReceiversCC'      => $ccArray,
         'MailReceiversBCC'     => $bccArray,
         'MailSubject'          => "Hier kommt der Betreff hin.",
         'MailText'             => "Hier kommt der Inhalt hin.",
         'MailSendingAccountID' => 119, //AbsenderpostfachID als integer
         'MailSendingTimestamp' => 0,
         'MailType'             => 'text/html',
         'UserID'               => $userID,
         'ImportMode'           => false,
         'DocumentID'           => 0,
         'Attachments'          => $attachments
    );     
    
    
    $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.


createDraftFromJSON

Erstellt einen Entwurf aus einem JSON-String

Parameter Datentyp Beschreibung
MailData String Maildaten als JSON-String
Token String Authentifizierungstoken
 
Rückgabewert


setIDO

Verknüpft eine Mail mit einem Datensatz

Parameter Datentyp Beschreibung
mailId Integer ID der Mail
IdoID Integer ID des Datensatzes
InstanceID Integer ID der IDO Instanz
Token String Authentifizierungstoken
 
Rückgabewert


Hauptkapitel

Verwandte Themen

Abgerufen von „https://adminwiki210.infra-struktur.de/index.php?title=Webservice_email&oldid=2801“