Webservice email: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
← Zum vorherigen VersionsunterschiedZum nächsten Versionsunterschied →
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 46: Zeile 46:
| MailID || integer ||| Datenbank ID der Mail
| MailID || integer ||| Datenbank ID der Mail
|-
|-
| UserID || integer ||| ID des Mailempfängers
| UserID || integer ||| ID des Mailabsenders
|-
|-
| Token|| String ||| Authentifizierungstoken
| Token|| String ||| Authentifizierungstoken
Zeile 58: Zeile 58:




''<u>getUserIDByKuerzel</u>''
''<u>createDraft</u>''


Liefert das Kürzel UserID an hand des Loginnamens
Erstellt einen Entwurf in der infra-struktur


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 67: Zeile 67:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| UserKuerzel||String ||| Kuerzel des Users
| mailData || Array ||| Array aus Mailvorlage
|-
|-
| Token|| String ||| Authentifizierungstoken
| Token|| String ||| Authentifizierungstoken
Zeile 75: Zeile 75:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| UserID|| Integer||| UserID des Benutzers
| || Aktion ||| Erstellt einen Entwurf in der infra-struktur
|}
|}




''<u>getUserList</u>''
''<u>getEmptyMailTemplateJson</u>''


Liefert eine Liste aller im System registrierten Benutzer
Holt eine leere Mailvorlage (das mailData Array)


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 94: Zeile 94:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| UserList|| Array||| Alle UserIDs im System
| mailTemplate || Array ||| Array mit dem Aufbau der für das mailData Array gebraucht wird
|}
|}


''<u>getMailGroupsForUser</u>''


''<u>getUsername</u>''
Gibt die Mailgruppen des angegebenen Users aus.


Liefert den Benutzernamen zur angegebenen UserID
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| mailGroups || Array ||| Array mit GruppenID und Gruppenname
|}
 
 
''<u>getNewDirectEmailCount</u>''
 
Gibt die Anzahl an Mails an, die nach einer gewählten Mail angekommen sind.


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 107: Zeile 127:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| UserID|| Integer||| UserID des Benutzers
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
|-
| Token|| String ||| Authentifizierungstoken
| Token|| String ||| Authentifizierungstoken
Zeile 115: Zeile 137:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| UserName|| String||| Angeforderter Benutzername
| newMailCount || Array ||| Array mit MailIDs der neuen Mails
|}
 
 
''<u>getNewGlobalizedEmailCount</u>''
 
Gibt die Anzahl an delegierten Mails an, die nach einer gewählten Mail angekommen sind.
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| newGlobCount || Array ||| Array mit MailIDs der neuen, globalisierten Mails
|}
 
 
 
''<u>getPostboxesForUser</u>''
 
Zeigt die Postfächer eines gewählten Users an.
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| postboxes || Array ||| Array mit PostfachID und Name des Postfaches
|}
 
 
''<u>getStandardTemplateForMailAccountAndUser</u>''
 
Gibt die ID der Standardvorlage eines Users für ein Postfach.
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| mailAccountID || integer ||| Datenbank ID des Mailpostfaches
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| templateID || integer ||| ID der Standardvorlage
|}
 
 
''<u>getWebmailTemplate</u>''
 
Holt die Ausgewählte Vorlage in ein Array.
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| templateID || integer ||| Datenbank ID der Standardvorlage
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| standardTemplate || Array ||| Array, im mailData-Format mit den Daten der gewählten Vorlage
|}
 
 
''<u>openComposeWindow</u>''
 
Öffnet das "Verfassen"-Fenster mit einer gewählten Vorlage.
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| templateID || integer ||| Datenbank ID der Vorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| || Aktion ||| Öffnet das Verfassenfenster
|}
 
 
''<u>sendBulkMail</u>''
 
Versendet eine Massenmail
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| mailArray|| Array ||| Array aus mailData-Arrays
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|  || Aktion ||| Versendet eine Massenmail
|}
 
 
''<u>sendMail</u>''
 
Versendet eine Mail.
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array mit Maildata
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|  || Aktion ||| Versendet eine Mail.
|}
 
 
''<u>archiveMail</u>''
 
Wechselt den Archivierungsstatus einer Mail.
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| MailID || integer ||| Datenbank ID der Mail
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| Wert: 1 || integer ||| Hat den Archivierungsstatus einer Mail gewechselt
|}
|}


Version vom 20. Dezember 2018, 16:28 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


  • 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
UserID integer ID des Mailabsenders
Token String Authentifizierungstoken
 
Rückgabewert
Aktion Versendet eine Mail.


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


Hauptkapitel

Verwandte Themen

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