Skriptschnittstelle enaio® exchange-webservice

enaio® 10.10

Funktionen des enaio® exchange-webservice

public interface IOsMailWebservice

string Echo(string echo);

Gibt den übergebenen String zurück. Testfunktion, ob der Webservice aktiv ist.

MailInfo ArchiveMailByEntryId(string exchangeUsername, string EntryId);

Legt eine E-Mail aus dem Exchange Postfach eines Benutzers unter Angabe der Exchange EntryId ab. Das Benutzerpostfach wird aus der NTLM Anmeldung des Webserviceaufrufs ermittelt. Handelt es sich dabei um den im enaio® exchange-administrator eingestellten technischen Benutzer, dann wird der übergebene Benutzername zur Ermittlung des Postfachs verwendet.

exchangeUsername: Der Benutzername, aus dessen E-Mail-Postfach die E-Mail abgelegt werden soll. Dieser Parameter wird nur ausgewertet, wenn der aufrufende Benutzer gleich dem im enaio® exchange-administrator konfigurierten technischen Benutzer ist.
EntryId: Die Entry ID der abzulegenden E-Mail
Rückgabe: Ein MailInfo-Objekt, das das Ergebnis des Aufrufs enthält.

MailInfo ArchiveMailByPropertyValue(string exchangeUsername, string PropertyName, string Value);

Legt eine E-Mail aus dem Exchange-Postfach eines Benutzers unter Angabe eines Feld-Value Paars ab. Das Benutzerpostfach wird aus der NTLM Anmeldung des Webserviceaufrufs ermittelt. Handelt es sich dabei um den im enaio® exchange-administrator eingestellten technischen Benutzer, dann wird der übergebene Benutzername zur Ermittlung des Postfachs verwendet.

exchangeUsername: Der Benutzername, aus dessen E-Mail-Postfach die E-Mail abgelegt werden soll. Dieser Parameter wird nur ausgewertet, wenn der aufrufende Benutzer gleich dem im enaio® exchange-administrator konfigurierten technischen Benutzer ist.
PropertyName: Der Name eines Mail Properties in DASL Schreibweise (z.B. http://schemas.microsoft.com/mapi/proptag/0x1035001F)
Value: Der Wert, den das angegebene Property haben muss.
Rückgabe: Ein MailInfo-Objekt, das das Ergebnis des Aufrufs enthält.

MailInfo ArchiveMailByFile(string osUsername, string fileName);

Legt eine als Datei übergebene E-Mail ab.

osUsername: Der Benutzername, in dessen enaio® Ablagebereich die E-Mail abgelegt werden soll. Dieser Parameter wird nur ausgewertet, wenn der aufrufende Benutzer gleich dem im enaio® exchange-administrator konfigurierten technischen Benutzer ist.
EntryId: Die Entry ID der abzulegenden E-Mail
Rückgabe: Ein MailInfo-Objekt, das das Ergebnis des Aufrufs enthält.

MailInfo GetMailInfoByEntryId(string exchangeUsername, string EntryId);

Ermittelt Informationen über den Ablagestatus einer E-Mail aus dem Exchange Postfach eines Benutzers anhand einer übergebenen Entry ID. Das Benutzerpostfach wird aus der NTLM Anmeldung des Webserviceaufrufs ermittelt. Handelt es sich dabei um den im enaio® exchange-administrator eingestellten technischen Benutzer, dann wird der übergebene Benutzername zur Ermittlung des Postfachs verwendet.

exchangeUsername: Der Benutzername, aus dessen E-Mail-Postfach die E-Mail-Informationen ermittelt werden sollen. Dieser Parameter wird nur ausgewertet, wenn der aufrufende Benutzer gleich dem im enaio® exchange-administrator konfigurierten technischen Benutzer ist.
EntryId: Die Entry ID der E-Mail, über die Informationen ausgegeben werden sollen.
Rückgabe: Ein MailInfo-Objekt, das das Ergebnis des Aufrufs enthält.

MailInfo GetMailInfoByPropertyValue(string exchangeUsername, string PropertyName, string Value);

Ermittelt Informationen über den Ablagestatus einer E-Mail aus dem Exchange-Postfach eines Benutzers anhand eines Feld-Value. Das Benutzerpostfach wird aus der NTLM Anmeldung des Webserviceaufrufs ermittelt. Handelt es sich dabei um den im enaio® exchange-administrator eingestellten technischen Benutzer, dann wird der übergebene Benutzername zur Ermittlung des Postfachs verwendet.

exchangeUsername: Der Benutzername, aus dessen Postfach die E-Mail abgelegt werden soll. Dieser Parameter wird nur ausgewertet, wenn der aufrufende Benutzer gleich dem im enaio® exchange-administrator konfigurierten technischen Benutzer ist.
PropertyName: Der Name eines Mail Properties in DASL Schreibweise (z.B. http://schemas.microsoft.com/mapi/proptag/0x1035001F)
Value: Der Wert, den das angegebene Property haben muss.
Rückgabe: Ein MailInfo-Objekt, das das Ergebnis des Aufrufs enthält.

MailInfo LinkMail(OsInfo source,
  string osUsername,
  string osPassword,
  string destinationCabinetId,
  string destinationDocumentTypeId,
  string destinationFolderOsId);

Verlinkt eine E-Mail aus dem technischen OsExchange Ordner eines Benutzers an eine beliebige Stelle in enaio® als typübergreifendes Verweisdokument. Der Benutzerordner wird aus der NTLM Anmeldung des Webserviceaufrufs ermittelt. Handelt es sich dabei um den im enaio® exchange-administrator eingestellten technischen Benutzer, dann wird der übergebene Benutzername zur Ermittlung des Ordners verwendet.

Source: Ein OsInfo Objekt, das Informationen über die zu verlinkende Mail enthält.
osUsername: Der Benutzername, aus dessen Ordner die E-Mail abgelegt werden soll. Dieser Parameter wird nur ausgewertet, wenn der aufrufende Benutzer gleich dem im enaio® exchange-administrator konfigurierten technischen Benutzer ist.
osPassword: Dieser Parameter wird nicht ausgewertet.
destinationCabinetId: Interner Name des Ziel-Ordnertyps.
destinationDocumentTypeId: Interner Name des Ziel-Dokumenttyps.
destinationFolderOsId: ID des Verlinkungsziels im Format "F1234" (Ordner) bzw. "R1234" (Register).
Rückgabe: Ein MailInfo-Objekt, das das Ergebnis des Aufrufs enthält.

MailInfo DownloadRestoredMail(OsInfo destination, string osUsername, string osPassword);

Stellt eine abgelegte E-Mail wieder her, und gibt sie als Datei zurück. Bei der Ablage entfernte Anlagen werden wieder eingefügt. Zur Berechtigungsprüfung wird die NTLM Anmeldung des Webserviceaufrufs ermittelt. Handelt es sich dabei um den im enaio® exchange-administrator eingestellten technischen Benutzer, dann wird der übergebene Benutzername verwendet.

Destination: Identifiziert die wiederherzustellende E-Mail.
osUsername: Der Benutzername, aus dessen Ordner die E-Mail abgelegt werden soll. Dieser Parameter wird nur ausgewertet, wenn der aufrufende Benutzer gleich dem im enaio® exchange-administrator konfigurierten technischen Benutzer ist.
osPassword: Dieser Parameter wird nicht ausgewertet.
Rückgabe: Ein MailInfo-Objekt, das das Ergebnis des Aufrufs enthält.

MailInfo DownloadRestoredMailByEcmId(string osid);

Stellt eine abgelegte E-Mail wieder her und gibt sie als MSG Datei zurück. Bei der Ablage entfernte Anlagen werden wieder eingefügt. Zur Berechtigungsprüfung wird die NTLM Anmeldung des Webserviceaufrufs ermittelt.

Osid: Die Doc-ID der wiederherzustellenden E-Mail.
Rückgabe: Ein MailInfo-Objekt, das das Ergebnis des Aufrufs enthält.

MailInfo ArchiveLinkMail(string EntryId, string destinationFolderOsId);

Zur Berechtigungsprüfung wird die NTLM Anmeldung des Webserviceaufrufs ermittelt. Links werden immer als Verweise erzeugt.

EntryId: Die Entry ID der abzulegenden E-Mail.
destinationFolderOsId: Die Doc-ID des Zielordners.
Rückgabe: Ein MailInfo-Objekt, das das Ergebnis des Aufrufs enthält.

MailInfo BatchRestoreMails(string srcOsUserName,
    string srcListFilePath,
    byte[] srcListFile,
    string destMailbox,
    string destDirMsg,
    string destDirEml,
    string destDirPst,
    string mailboxFolder);

Befehl zum Wiederherstellen mehrere E-Mails:

srcListFilePath: OS ECM Benutzername: Alle Mails dieses Benutzers werden wiederhergestelt
srcListFile: Pfad zu einer OS ID Liste: Alle enthaltenen IDs werden wiederhergestellt
srcListFile: OS ID Listendatei als ASCII-Bytes: Alle enthaltenen IDs werden wiederhergestellt
destMailbox: Zielpostfach, in das Postfach werden die E-Mails wiederhergestellt
destDirMsg: Zielverzeichnis für MSG Dateien: in das Verzeichnis werden die E-Mail als MSG Dateien wiederhergestellt
destDirEml: Zielverzeichnis für EML Dateien: in das Verzeichnis werden die E-Mail als EML Dateien wiederhergestellt
destDirPst: Zielverzeichnis für PST Dateien: in das Verzeichnis werden die E-Mail in einer PST Datei wiederhergestellt
mailboxFolder: Bei Wiederherstellung in eine Mailbox kann hier der Mailbox-Ordnerpfad angegeben werden
Rückgabe: Ein MailInfo Object, dass im Feld 'RestoreInfo' das Ergebnis des Aufrufs enthält.

public class OsInfo

Informationen über ein enaio®-Objekt.

public string ServerConnectionString;

Komplette Verbindung zum enaio® server, inklusive IP und Port. Z.B. "127.0.0.1:4000".

public string CabinetId;

Interner Ordnertyp-Name.

public string DocumentTypeId;

Interner Objekttyp-Name.

public string DocId;

Doc-ID des Objekts.

public class RestoreInfo

Wiederherstellungs-Informationen als Ergebnis einer Stapelwiederherstellung.

public byte[] LogfileData

Protokolldatei eines Batch-Restore Webservice Aufrufs.

public string LogfileName

Dateiname der Protokolldatei eines Batch-Restore Webservice Aufrufs.

public string LogfileInfo

Informationen über die der Protokolldatei eines Batch-Restore Webservice Aufrufs.

public int DoneCount

Anzahl der erfolgreich wiederhergestellten Mails.

public int FailedCount

Anzahl der fehlgeschlagenen Wiederherstellungen.

public class ExchangeInfo

Informationen über eine E-Mail im Exchange Server.

public string EntryId = string.Empty;

Entry-ID der E-Mail. Bei Verwendung der Property-Value-Paar-Suche ist hier der Value-Wert eingetragen.

public byte[] MailData;

E-Mail-Daten der MSG Datei als Ergebnis eines Restore Webservice Aufrufs.

public string MailSearchValu;

Wert, der für die Suche der E-Mail per Property-Value-Paar verwendet worden ist.

public class AttachmentInfo

Informationen über eine Anlage

public OsInfo OsInfo;

Falls die Anlage abgelegt ist, enthält dieser Parameter Informationen über das abgelegte Objekt.

public string Filename;

Dateiname der Anlage.

public class MailInfo

Informationen über eine E-Mail, bzw. über Erfolg oder Misserfolg des Webservice Aufrufs.

public OsInfo OsInfo = null;

Informationen über die enaio®-Ablage der E-Mail

public ExchangeInfo ExchangeInfo = null;

Informationen über den Exchange-Standort der E-Mail

public RestoreInfo RestoreInfo = null;

Informationen über die Stapelwiederherstellung

public bool Succeeded = false;

'True', falls der Webservice Aufruf erfolgreich war, andernfalls 'false'. ACHTUNG: bei 'false' ist nur der Parameter 'Error' sicher gesetzt.

public string Error = string.Empty;

Fehlertext, falls der Webservice-Aufruf fehlgeschlagen ist.

public AttachmentInfo[] Attachments = null;

Liste mit AttachmentInfo Objekten für Anlagen der E-Mail.

Ansteuerung eines enaio® exchange-webservice aus einem Skript:

namespace OsExchange.Common.Tools
public class MailManagementService: IOsMailWebservice
{
public MailManagementService(string URL)
}

Beispiel:

using OsExchange.Common.Tools;
public override void OnBeforeExchangeProcessing(IOnScriptEventBeforeExchangeProcessing evt)
{
string connection = "http://127.0.0.1:13344/OsExchangeWebservice";

MailManagementService service = new MailManagementService(connection);
string test = service.Echo("test 123");
}
                                                            