Page tree
Skip to end of metadata
Go to start of metadata
 

Bitte beachten Sie, dass seit TecArt Version 4.10 und aufwärts der SOAP Webservice nicht mehr weiterentwickelt wird. Ab der TecArt Version 5.1 ist der SOAP Webservice nicht mehr unterstützt.

Please note: with the release of TecArt version 4.10 onwards SOAP Webservice will no longer be updated or expanded. With the release of TecArt version 5.1, the soap webservice will be deprecated.

1. WSDL-URI

http://hostname/dirname/soap/index.php?op=email&wsdl

z.B. https://test.tecart-system.de/soap/index.php?op=email&wsdl

2. Methoden

2.1. crmgetTree

Syntax:


Beschreibung:

Liefert den Mailtree für den aktuellen Benutzer.

Liefert ein Array von tree entry Objekten.

Eigenschaften:

Typ(Länge)    Eigenschaft     Beschreibung
-------------------------------------------------------------------
int           $id             Tree-Id
int           $parent         Id des Eltern-Knoten dieses Eintrags
string(255)   $name           Name des Eintrags 
int           $imap           Imap-Account-Id, 0 = POP3-Folder
int           $cid            Contact ID (Version >= 3.1.2566)
int           $pid            Project ID (Version >= 3.1.2566)
int           $unread         Anzahl der ungelesenen Nachrichten in diesem Ordner
int           $total          Anzahl der Nachrichten in diesem Ordner

int           $chgtime        Unix-Timestamp der letzten Änderung
int           $chguser        Userid der letzten Änderung

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
	$client_logon = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
	$session_id = $client_logon->crmLogin('test', 'test');
	if (!$session_id) {
		die("invalid login");
	}
 
	$client_email = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=email&wsdl");
 
	$result = $client_email->crmgetTree($session_id);
	foreach($result as $entry) {
		echo $entry->id." ".$entry->name."<br>\n";
	}
}
catch (SOAPFault $f) {
	print $f->faultstring;
}




2.2. crmgetCommonTree

(Version >= 3.1.2566)

Syntax:

array crmgetCommonTree( string $session_id, int $type, int $obj_id )

Beschreibung:

Liefert den Mailtree für bestimmtes Objekt.

type ist der Typ des Objekts, 0 → Kontakt, 1 → Projekt.

obj_id ist den ID des Objekts.

Liefert ein Array von tree entry Objekten.

Eigenschaften:

sind die selben wie für crmgetTree

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
	$client_logon = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
	$session_id = $client_logon->crmLogin('test', 'test');
	if (!$session_id) {
		die("invalid login");
	}
 
	$client_email = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=email&wsdl");
 
	$result = $client_email->crmgetCommonTree($session_id, 0, 1148);
	foreach($result as $entry) {
		echo $entry->id." ".$entry->name."<br>\n";
	}
}
catch (SOAPFault $f) {
	print $f->faultstring;
}




2.3. crmaddTreeEntry

Syntax:

int crmaddTreeEntry( string $session_id, int $parent, string $name )

Beschreibung:

Fügt einen POP3-Folder zum user tree hinzu.

Gibt eine tree_id des neuen Ordners bei Erfolg, 0 bei einem Fehler -1, wenn ein Ordner mit dem selben nameist bereits vorhanden ist.

parent ist die ID des übergeordneten Ordners.

name ist der Ordnername.

Beispiel:

<?php
 
$tree_id = $client_email->crmaddTreeEntry($session_id, 5011, 'Webservices');
echo $tree_id;




2.4. crmaddImapEntry

Syntax:

int crmaddImapEntry( string $session_id, int $parent, string $name )

Beschreibung:

Fügt einen IMAP-Ordner zum user tree hinzu.

Liefert eine tree_id des neuen Ordners bei Erfolg, 0 im Fehlerfall.

parent ist der ID des übergeordneten Ordners und muss ein gültiger IMAP-Ordner sein.

name ist der Ordnername.

Beispiel:

<?php
 
$tree_id = $client_email->crmaddImapEntry($session_id, 2328, 'New Imap-Folder');
echo $tree_id;




2.5. crmrenameTreeEntry

Syntax:

int crmrenameTreeEntry( string $session_id, int $tree_id, string $newname )

Beschreibung:

Benennt ein POP3-Ordner um.

Liefert die tree_id bei Erfolg, 0 im Fehlerfall.

tree_id ist die ID des Ordners.

newname ist der neue Ordnername.

Beispiel:

<?php
 
$tree_id = $client_email->crmrenameTreeEntry($session_id, $tree_id, 'Webservice renamed');
echo $tree_id;


2.6. crmrenameImapEntry

Syntax:

int crmrenameImapEntry( string $session_id, int $tree_id, string $newname )

Beschreibung:

Benennt einen IMAP-Ordner um.

Liefert die tree_id bei Erfolg, 0 im Fehlerfall.

tree_id ist die ID des IMAP-Ordners.

newname ist der neue Ordnername.

Beispiel:

<?php
 
$tree_id = $client_email->crmrenameImapEntry($session_id, $tree_id, 'IMAP-Folder renamed');
echo $tree_id;




2.7. crmdeleteEntry

Syntax:

boolean crmdeleteEntry( string $session_id, int $tree_id )

Beschreibung:

Löscht einen POP3-oder IMAP-Ordner.

Liefert 1 bei Erfolg, 0 im Fehlerfall.

Beispiel:

<?php
 
$result = $client_email->crmdeleteEntry($session_id, $tree_id);
if (!$result) echo "Unable to delete Folder";




2.8. crmsyncTree

Syntax:

boolean crmsyncTree( string $session_id, crmTreeItem $crmTreeItem )

Beschreibung:

Synchronisiert den Mailtree für den aktuellen Benutzer.

crmTreeItem ist ein Objekt oder ein mehrdimensionales assoziatives Array und muss die vollständige Baumstruktur auf dem Client enthalten.

Liefert 1 bei Erfolg, 0 im Fehlerfall.

Hinweis: Neue Ordner in crmTreeItem werden hinzugefügt, nicht existierende Ordner entfernt. Die Standard-Ordner "Posteingang", "Postausgang", "Trash", "Junk" und "Entwürfe" können nicht entfernt werden. Es ist auch möglich, einen Ordner, zu einem anderen Ordner zu verschieben.

Eigenschaften:

Typ(Länge)    Eigenschaft     Beschreibung
-------------------------------------------------------------------
int           $id             Tree-Id 
int           $imap           Imap-Account-Id, 0 = POP3-Folder
string(255)   $name           Name des Eintrags
int           $parent         Parent-Id des Eintrags

Beispiel 1:

<?php
 
class synctree {
	public $crmTreeItemElements = array(
    	array(
			'id'     => 4958, 
			'parent' => 2, 
			'name'   => 'Folder2 synced', 
			'imap'   => 0
		),
 		array(
			'id'     => 3195,
			'parent' => 1, 
			'name'   => 'WebTest added', 
			'imap'   => 0
		)
	);
}
 
$success = $client_email->crmsyncTree($session_id, new synctree());
if (!$success) {
	echo "Sync failed";
}



Beispiel 2:

<?php
 
$synctree = array(
	'crmTreeItemElements' => array(
		array(
			'id'     => 4958, 
			'parent' => 2, 
			'name'   => 'Folder2 synced', 
			'imap'   => 0
		),
		array(
			'id'     => 3195, 
			'parent' => 1, 
			'name'   => 'WebTest added', 
			'imap'   => 0
		)
	)
);
 
$synctree['crmTreeItemElements'][] = array(
	'id'     => 3882, 
	'parent' => 3195, 
	'name'   => 'New Folder', 
	'imap'   => 0
);
 
$success = $client_email->crmsyncTree($session_id, $synctree);
if (!$success) {
	echo "Sync failed";
}



Beispiel 3:

<?php
 
class tree 
{   
	public $crmTreeItemElements = array();
}
 
class tree_item 
{ 
	public $id;
	public $parent;
	public $name;
	public $imap;
 
	function __construct($id, $parent, $name, $imap = 0)
	{
		$this->id     = $id;
		$this->parent = $parent;
		$this->name   = $name;
		$this->imap   = $imap;
	}
}
 
$synctree = new tree();
$synctree->crmTreeItemElements[] = new tree_item(4958, 2, 'Folder2 synced');
$synctree->crmTreeItemElements[] = new tree_item(3195, 1, 'WebTest added');
 
$success = $client_email->crmsyncTree($session_id, $synctree);
if (!$success) {
	echo "Sync failed";
}




2.9. crmgetInboxFolder

Syntax:

int crmgetInboxFolder( string $session_id, int $konto )

Beschreibung:

Liefert die tree_id des des Posteingangsordners bei Erfolg, 0 im Fehlerfall.

konto ist die POP3-oder IMAP-Account-ID, wenn auf 0 gesetzt wird der Standard Posteingang zurückgegeben.

Beispiel:

<?php
 
$inbox = $client_email->crmgetInboxFolder($session_id, 0);
echo $inbox;




2.10. crmgetCommonInboxFolder

(Version >= 3.1.2566)

Syntax:

int crmgetCommonInboxFolder( string $session_id, int $type, int $obj_id )

Beschreibung:

Liefert die tree_id des Posteingangsordners bei Erfolg, 0 im Fehlerfall.

type ist der Typ des Objekts, 0 → Kontakt, 1 → Projekt.

obj_id ist die ID des Objekts.

Beispiel:

<?php
 
$inbox = $client_email->crmgetCommonInboxFolder($session_id, 1, 4521);
echo $inbox;




2.11. crmgetOutboxFolder

Syntax:

int crmgetOutboxFolder( string $session_id )

Beschreibung:

Liefert die tree_id des Ordners "Postausgang" bei Erfolg, 0 im Fehlerfall.

Beispiel:

<?php
 
$outbox = $client_email->crmgetOutboxFolder($session_id);
echo $outbox;
 

2.12. crmgetTrashFolder

Syntax:

int crmgetTrashFolder( string $session_id, int $konto )

Beschreibung:

Liefert die tree_id des Ordners "Papierkorb" bei Erfolg, 0 im Fehlerfall.

konto ist die POP3-oder IMAP-Account-ID, auf 0 setzen um den Standard Trash zurückzuliefern.

Beispiel:

<?php
 
$trash = $client_email->crmgetTrashFolder($session_id, 0);
echo $trash;




2.13. crmgetCommonTrashFolder

(Version >= 3.1.2566)

Syntax:

int crmgetCommonTrashFolder( string $session_id, int $type, int $obj_id )

Beschreibung:

Liefert die tree_id des Ordners "Papierkorb" bei Erfolg, 0 im Fehlerfall.

type ist der Typ des Objekts, 0 → Kontakt, 1 → Projekt.

obj_id ist die ID des Objekts.

Beispiel:

<?php
 
$trash = $client_email->crmgetCommonTrashFolder($session_id, 0, 5532);
echo $trash;




2.14. crmgetSentFolder

Syntax:

int crmgetSentFolder( string $session_id, int $konto )

Beschreibung:

Liefert die tree_id des Ordners "Gesendet" bei Erfolg, 0 im Fehlerfall.

konto ist die POP3-oder IMAP-Account-ID, auf 0 setzen um den Standard Ordner "Gesendet" zurückzuliefern.

Beispiel:

<?php
 
$sent = $client_email->crmgetSentFolder($session_id, 0);
echo $sent;




2.15. crmgetCommonSentFolder

(Version >= 3.1.2566)

Syntax:

int crmgetCommonSentFolder( string $session_id, int $type, int $obj_id )

Beschreibung:

Liefert die tree_id des Ordners "Gesendet" bei Erfolg, 0 im Fehlerfall.

type ist der Typ des Objekts, 0 → Kontakt, 1 → Projekt.

obj_id ist die ID des Objekts.

Beispiel:

<?php
 
$sent = $client_email->crmgetCommonSentFolder($session_id, 1, 5581);
echo $sent;




2.16. crmgetDraftFolder

Syntax:

int crmgetDraftFolder( string $session_id, int $konto )

Beschreibung:

Liefert die tree_id des Ordner "Entwürfe" bei Erfolg, 0 im Fehlerfall.

konto ist die POP3-oder IMAP-Account-ID, auf 0 setzen um den Standard Ordner "Entwürfe" zurückzuliefern.

Beispiel:

<?php
 
$drafts = $client_email->crmgetDraftFolder($session_id, 0);
echo $drafts;




2.17. crmgetCommonDraftFolder

(Version >= 3.1.2566)

Syntax:

int crmgetCommonDraftFolder( string $session_id, int $type, int $obj_id )

Beschreibung:

Liefert die tree_id des Ordners "Entwürfe" bei Erfolg, 0 im Fehlerfall.

type ist der Typ des Objekts, 0 → Kontakt, 1 → Projekt.

obj_id ist die ID des Objekts.

Beispiel:

<?php
 
$drafts = $client_email->crmgetCommonDraftFolder($session_id, 0, 5214);
echo $drafts;




2.18. crmgetJunkFolder

Syntax:

int crmgetJunkFolder( string $session_id, int $konto )

Beschreibung:

Liefert die tree_id des Junk-Ordners bei Erfolg, 0 im Fehlerfall.

konto ist die POP3-oder IMAP-Account-ID, auf 0 setzen um den Standard Junk-Ordner zurückzuliefern.

Beispiel:

<?php
 
$junk = $client_email->crmgetJunkFolder($session_id, 0);
echo $junk;




2.19. crmgetCommonJunkFolder

(Version >= 3.1.2566)

Syntax:

int crmgetCommonJunkFolder( string $session_id, int $type, int $obj_id )

Beschreibung:

Liefert die tree_id des Junk-Ordners bei Erfolg, 0 im Fehlerfall.

type ist der Typ des Objekts, 0 → Kontakt, 1 → Projekt.

obj_id ist die ID des Objekts.

Beispiel:

<?php
 
$junk = $client_email->crmgetCommonJunkFolder($session_id, 0, 3385);
echo $junk;




2.20. crmgetMailHeaders

Syntax:

array crmgetMailHeaders( string $session_id, int $tree_id, int $timestamp, int $count, int $offset )

Beschreibung:

Liefert ein Array von E-Mail-Header-Objekten des aktuellen Benutzers.

tree_id ist die ID des Ordners, um Mail-Header zu erhalten.

timestamp ist ein UNIX-Timestamp, falls er größer als 0 ist werden alle Header zurückgegeben , die seit dieser Zeit verändert wurden.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden sollen, 0 bedeutet keine Beschränkung.

offset ist die Offset-Position zu Ergebnissen zu kommen , es wird nicht verwendet werden, wenn count auf 0 ist.

Eigenschaften:

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
int             $id             Mail-Id 
int             $folder         Tree-Id 
string(255)     $uidl           Unique-Id, gegeben vom Mailserver
string(65535)   $to             An-Addressen
string(255)     $from           Von-Addresse
string(65535)   $cc             CC-Addressen   
string(65535)   $bcc            BCC-Addressen
string(255)     $reply          Antwort-Adresse
string(255)     $subject        Betreff     
int             $attach         E-Mail hat Anhänge, 0 = keine Anhänge
int             $was_read       E-Mail wurde gelesen
                                  0 = ungelesen
                                  1 = gelesen
                                > 1 = Unix-Timestamp des Lesens
string(64)      $mail_id        Unique Identifier um die E-Mail im Dateisystem des Servers
                                zu identifizieren
int             $date           Unix-Timestamp des Zeitpunkts, an dem die E-Mail versendet
                                wurde, oft das Datum des Versendens
int             $priority       Priorität
                                  5 = niedrig
                                  3 = normal
                                  1 = hoch
int             $intern         Interne Nachricht
                                  0 = extern
                                  1 = intern von Nutzer (blau)
                                  2 = intern vom System (grün)
int             $size           Größe der E-Mail in Bytes einschließlich Anhängen
int             $pid            Project-Id, nur mit gemeinsamen E-Mails verwendet
int             $cid            Contact-Id, nur mit gemeinsamen E-Mails verwendet
int             $tid            Ticket-Id, nur mit gemeinsamen E-Mails verwendet (Version >= 3.1.2566)
int             $konto          IMAP-Account of E-Mail
                                  0 = POP3 
                                > 0 = IMAP-Account-Id
int             $signed         Nachricht ist signiert
                                  0 = unsigniert
                                  1 = signiert
int             $encrypted      Nachricht ist verschlüsselt
                                  0 = klartext
                                  1 = verschlüsselt
int             $imap           IMAP Message Sequence Number vom Mailserver
int             $message        System Nachricht
                                  0 = normal
                                  1 = system
int             $flag           Nachricht wurde markiert
                                  0 = nicht markiert
                                  1 = markiert
                                > 1 = Unix-Timestamp des Markierens
int             $answered       Die Nachricht wurde beantwortet
                                  0 = nicht beantwortet
                                  1 = beantwortet
                                > 1 = Unix-Timestamp der Antwort
int             $forwarded      Nachricht wurde weitergeleitet
                                  0 = nicht weitergeleitet
                                  1 = weitergeleitet
                                > 1 = Unix-Timestamp des Weiterleitens
string(65535)   $forwarded_to   Empfänger diesen diese E-Mail weitergeleitet wurde
string(255)     $forwarded_from Absender, von dem diese Nachricht weitergeleitet wurde
int             $done           Die Nachricht wurde als erledigt gekennzeichnet
                                  0 = nicht erledigt
                                  1 = erledigt
                                > 1 = Unix-Timestamp des Erledigt-Markierens
int             $remember       Erinnerung an den Nutzer
                                  0 = nicht benachrichtigen
                                > 0 = Unix-Timestamp der Erinnerung
int             $remuser        Userid , die Eine Rückmeldung erhalten, nur mit gemeinsamen Mails verwendet
string(255)     $answered_from  Nachricht wurde von dieser Adresse geantwortet
string(255)     $return_receipt Empfangsbestätigungen, E-Mail-Adresse für den Empfang von Empfangsbestätigungen
string(255)     $disposition_notification 
                                E-Mail-Adresse für den Empfang der Lesebestätigung
string(255)     $classref       ERP-Reference Identifier 
                                Format: customer:supplier:orderno:article:cas_no:tracking:ordertype:notes 
int             $filtered       Nachricht wurde gefiltert
                                  0 = nicht gefiltert
                                > 0 = Unix-Timestamp des Filterns
string(32)      $md5body        MD5 des Textinhalts, um ihn mit anderen E-Mails zu vergleichen,
int             $tstamp         Unix-Timestamp der letzten Änderung der Header-Daten
string(65535)   $deposition     Derzeit nicht verwendet
int             $received       Unix-Timestamp der Empfangszeit

Beispiel 1:

<?php
 
$inbox = $client_email->crmgetInboxFolder($session_id, 0);
 
$headers = $client_email->crmgetMailHeaders($session_id, $inbox, 0, 10, 0);
foreach($headers as $email) {
	echo htmlentities($email->from)." -> ".$email->subject."<br>  \n";
}



Beispiel 2:

<?php
 
$inbox = $client_email->crmgetInboxFolder($session_id, 0);
 
// Returns all headers changed after 2007-05-24
$headers = $client_email->crmgetMailHeaders($session_id, $inbox, mktime(0, 0, 0, 5, 25, 2007), 0, 0);
foreach($headers as $email) {
	echo htmlentities($email->from)." -> ".$email->subject."<br>  \n";
}
 




2.21. crmgetMailHeadersAll

(Version >= 3.7.8168)

Syntax:

array crmgetMailHeadersAll( string $session_id, int $timestamp, int $count, int $offset )

Beschreibung:

Liefert ein Array von E-Mail-Header-Objekten des aktuellen Benutzers.

timestamp ist ein UNIX-Timestamp, falls er größer als 0 ist werden alle Header zurückgegeben , die seit dieser Zeit verändert wurden.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden sollen, 0 bedeutet keine Beschränkung.

offset ist die Offset-Position zu Ergebnissen zu kommen , es wird nicht verwendet werden, wenn count auf 0 ist.

Eigenschaften:

sind die selben wie für crmgetMailHeaders

Beispiel 1:

<?php
 
$headers = $client_email->crmgetMailHeadersAll($session_id, 0, 10, 0);
foreach($headers as $email) {
	echo htmlentities($email->from)." -> ".$email->subject."<br>  \n";
}




2.22. crmgetCommonMailHeaders

(Version >= 3.1.2566)

Syntax:

array crmgetCommonMailHeaders( string $session_id, int $tree_id, int $type, int $obj_id, int $timestamp, int $count, int $offset )

Beschreibung:

Liefert ein Array von E-Mail-Header-Objekten des aktuellen Benutzers.

tree_id ist die ID des Ordnersvon dem Mail-Header geholt werden, setzen Sie sie auf 0 um Header aus allen Ordnern zu erhalten.

type ist der Typ des Objekts, 0 = Kontakte, 1 = Projekte, 2 = Tickets.

obj_id ist die die ID die Objekts.

timestamp ist ein UNIX-Timestamp, falls er größer als 0 ist, werden alle Header zurückgegeben , die seit dieser Zeit verändert wurden.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden soll, 0 bedeutet keine Beschränkung.

offset ist die Offset-Position, von der aus Ergebnisse geliefert werden, wird nicht verwendet werden, wenn count auf 0 gesetzt ist.

Eigenschaften:

sind die selben wie für crmgetMailHeaders

Beispiel 1:

<?php
 
// Returns the first 10 Headers of contact with id 1254 for all contact folders
$headers = $client_email->crmgetCommonMailHeaders($session_id, 0, 0, 1254, 0, 10, 0);
foreach($headers as $email) {
	echo htmlentities($email->from)." -> ".$email->subject."<br>  \n";
}




2.23. crmgetMail

Syntax:

array crmgetMail( string $session_id, int $mail_id, boolean $attachments, boolean $gzip )

Beschreibung:

Gibt ein Array mit nur einem Element eines E-Mail-Objekts.

mail_id ist die ID des Header-Objekts.

Stellen Sie Attachments auf 1, wenn Sie die Anhänge erhalten möchten.

Stellen Siegzipauf 1, wenn Sie den Inhalt der E-Mail und Anhänge mit GZIP komprimieren möchten.

Eigenschaften (E-Mail):

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
int             $id             Mail-Id
string(255)     $subject        Betreff
string(255)     $from           Von-Adresse
string(65535)   $to             An-Adresse (n)
int             $date           Datum der E-Mail, häufig das Datum des Versendens, Unix-Timestamp
boolean         $is_html        E-Mail in HTML gesendet (0 = false, 1 = true)
binary          $text           Text-Inhalt, base64-codiert
binary          $html           HTML-Inhalt, base64-codiert
array           $attachments    Array mit Attachment Objekte

Eigenschaften (Attachment):

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
string          $name           Name des Anhangs, z. B. picture.jpg
string          $ctype          Content-Type des Anhangs, z. B. image/jpeg
string          $cid            Content-ID, für multipart / related Inhalt, z. B. eingebettete Objekte
int             $size           Größe des Anhangs in Bytes
binary          $content        Binärer Inhalt des Anhangs, base64-codiert

Beispiel 1:

<?php
 
$result = $client_email->crmgetMail($session_id, 24013, 1, 0);
 
$email = $result[0];
 
echo "";
echo "From: ".$email->from."<br/>";
echo "Subject: ".$email->subject."<br/>";
echo "To: ".$email->to."<br/>";
echo "Date: ".date("d.m.Y - H:i:s", $email->date)."<br/><br/>";
 
echo $email->is_html ? base64_decode($email->html) : base64_decode($email->text);
 
foreach ($email->attachments as $attachment) {
	echo "Attachment: <a href='{$attachment->name}' target=_blank>".$attachment->name."</a> (".$attachment->size.")<br/>";
    $fp = fopen($attachment->name, "w");
    fwrite($fp, base64_decode($attachment->content));
    fclose($fp);
}
 



Beispiel 2 (related content, gzipped):

<?php
 
$result = $client_email->crmgetMail($session_id, 24013, 1, 1);
 
$email = $result[0];
 
echo "";
echo "From: ".$email->from."<br/>";
echo "Subject: ".$email->subject."<br/>";
echo "To: ".$email->to."<br/>";
echo "Date: ".date("d.m.Y - H:i:s", $email->date)."<br/><br/>";
 
$content = $email->is_html ? gzdecode(base64_decode($email->html)) : gzdecode(base64_decode($email->text));
 
foreach ($email->attachments as $attachment) {
     
    $fp = fopen($attachment->name, "w");
    if (!$fp) continue;
    fwrite($fp, gzdecode(base64_decode($attachment->content)));
    fclose($fp); 
 
    if ($attachment->cid && $email->is_html) {
        $content = str_replace('cid:'.$attachment->cid, $attachment->name, $content);
    }
    else {
        echo "Attachment: <a href='{$attachment->name}' target=_blank>".$attachment->name."</a> (".$attachment->size.")<br/>";
    }
}
 
echo $content;




2.24. crmgetCommonMail

(Version >= 3.1.2566)

Syntax:

array crmgetCommonMail( string $session_id, int $mail_id, boolean $attachments, boolean $gzip )

Beschreibung:

Liefert eine E-Mail mit der angegebenen ID die bei Kontakten, Projekten oder Karten gespeichert ist. Gibt ein Array mit nur einem Element eines E-Mail-Objekts zurück.

mail_id ist des ID des Header-Objekts.

Stellen Sie Attachments auf 1, wenn Sie die Anhänge erhalten möchten.

Stellen Siegzipauf 1, wenn Sie den Inhalt der E-Mail und Attachments mit GZIP komprimieren möchten.

Eigenschaften (E-Mail):

sind die selben wie für crmgetMail

Eigenschaften (Attachment):

sind die selben wie für crmgetMail

Beispiel 1:

<?php
 
$result = $client_email->crmgetCommonMail($session_id, 1153, 1, 0);
 
$email = $result[0];
 
echo "";
echo "From: ".$email->from."<br/>";
echo "Subject: ".$email->subject."<br/>";
echo "To: ".$email->to."<br/>";
echo "Date: ".date("d.m.Y - H:i:s", $email->date)."<br/><br/>";
 
echo $email->is_html ? base64_decode($email->html) : base64_decode($email->text);
 
foreach ($email->attachments as $attachment) {
    echo "Attachment: <a href='{$attachment->name}' target=_blank>".$attachment->name."</a> (".$attachment->size.")<br/>";
    $fp = fopen($attachment->name, "w");
    fwrite($fp, base64_decode($attachment->content));
    fclose($fp);
}



Beispiel 2 (related content, gzipped):

<?php
 
$result = $client_email->crmgetCommonMail($session_id, 4128, 1, 1);
 
$email = $result[0];
 
echo "";
echo "From: ".$email->from."<br/>";
echo "Subject: ".$email->subject."<br/>";
echo "To: ".$email->to."<br/>";
echo "Date: ".date("d.m.Y - H:i:s", $email->date)."<br/><br/>";
 
$content = $email->is_html ? gzdecode(base64_decode($email->html)) : gzdecode(base64_decode($email->text));
 
foreach ($email->attachments as $attachment) {
     
    $fp = fopen($attachment->name, "w");
    if (!$fp) continue;
    fwrite($fp, gzdecode(base64_decode($attachment->content)));
    fclose($fp); 
 
    if ($attachment->cid && $email->is_html) {
        $content = str_replace('cid:'.$attachment->cid, $attachment->name, $content);
    }
    else {
        echo "Attachment: <a href='{$attachment->name}' target=_blank>".$attachment->name."</a> (".$attachment->size.")<br/>";
    }
}
 
echo $content;




2.25. crmgetMailText

Syntax:

string crmgetMailText( string $session_id, int $mail_id, boolean $gzip )

Beschreibung:

Liefert nur den base64-kodierten Plain-Text Teil einer E-Mail.

mail_id ist die ID des Mail-Header-Objekt.

Setzen Sie gzipauf 1, wenn Sie wollen, dass der Inhalt mit gzip kodiert wird.

Beispiel:

<?php
 
$result = $client_email->crmgetMailText($session_id, 24013, 0);
echo base64_decode($result);




2.26. crmgetCommonMailText

(Version >= 3.1.2566)

Syntax:

string crmgetCommonMailText( string $session_id, int $mail_id, boolean $gzip )

Beschreibung:

Liefert nur den base64-kodierten Plain-Text Teil einer E-Mail die in Kontakten, Projekten oder Tickets gespeichert ist.

mail_id ist die ID des Mail-Header-Objekts.

Setzen Sie gzipauf 1, wenn Sie wollen, dass der Inhalt mit gzip kodiert wird.

Beispiel:

<?php
 
$result = $client_email->crmgetCommonMailText($session_id, 5535, 0);
echo base64_decode($result);




2.27. crmgetMailSource

Syntax:

string crmgetMailSource( string $session_id, int $mail_id, boolean $gzip )

Beschreibung:

Liefert die vollständige Quelle einer E-Mail, nützlich, wenn Sie sie an andere E-Mail-Anwendungen zu importieren.

mail_id ist die ID des Mail-Header-Objekts.

Setzen Sie gzipauf 1, wenn Sie wollen, dass der Inhalt mit gzip kodiert wird.

Hinweis: Sie können den Inhalt in einer Datei mit der Endung '. eml' speichern, dann können Sie sie mit Outlook Express oder Mozilla Thunderbird öffnen.

Beispiel:

<?php
 
$source = $client_email->crmgetMailSource($session_id, 23988, 0);
echo htmlentities(base64_decode($source));




2.28. crmgetCommonMailSource

(Version >= 3.1.2566)

Syntax:

string crmgetCommonMailSource( string $session_id, int $mail_id, boolean $gzip )

Beschreibung:

Liefert die vollständige Quelle von einer E-Mail aus Kontakten, Projekten oder Tickets, nützlich, wenn Sie er mit anderen E-Mail-Anwendungen zu importieren.

mail_id ist die ID des Mail-Header-Objekts.

Setzen Sie gzipauf 1, wenn Sie wollen, dass der Inhalt mit gzip kodiert wird.

Hinweis: Sie können den Inhalt in einer Datei speichern mit der Endung '. eml', dann können Sie sie mit Outlook Express oder Mozilla Thunderbird öffnen.

Beispiel:

<?php
 
$source = $client_email->crmgetCommonMailSource($session_id, 5785, 0);
echo htmlentities(base64_decode($source));




2.29. crmImportMailSource

Syntax:

boolean crmImportMailSource( string $session_id, int $tree_id, string $source )

Beschreibung:

Importiert base64-kodierten E-Mail-Quellcode in den Ordner tree_id. Nützlich, wenn Sie eine E-Mail Import-Tool zu entwickeln.

Liefert 1 bei Erfolg, 0, im Fehlerfall

Beispiel:

<?php
 
$draft   = $client_email->crmgetDraftFolder($session_id, 0);
$success = $client_email->crmImportMailSource($session_id, $draft, base64_encode($source));



2.30. crmSendNotification

Syntax:

boolean crmSendNotification( string $session_id, string $to, string $subject, string $body )

Beschreibung:

Sendet eine interne Benachrichtigung. Diese Nachricht ist eine Text-Nachricht und grün markiert.

to enthält die E-Mail-Adresse, z. B. info@Beispiel.com.

subject ist die Betreffzeile der Nachricht, kann Sonderzeichen enthalten.

body der Text der Nachricht.

Liefert 1 bei Erfolg, 0, im Fehlerfall

Hinweis: Der to Parameter kann auch den Namen des Empfängers enthalten, z.B. "Christian Friebel xray@tecart.de" .

Beispiel:

<?php
 
$to      = "Michael Smith <info@Beispiel.com>";
$subject = "TestWebservice";
$body    = "This is a Test";
 
$success = $client_email->crmSendNotification($session_id, $to, $subject, $body);
if ($success) {
	echo "Message was sent successfully.";
}
else {
	echo "Error sending message.";
}




2.31. crmGetEmailAccounts

Syntax:

array crmGetEmailAccounts( string $session_id )

Beschreibung:

Liefert ein Array mit E-Mail Konto-Objekten für den aktuellen Benutzer.

Eigenschaften:

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
int             $id             Account-Id erforderlich für das Senden von E-Mails
string(255)     $account_name   Account Name 
string(255)     $name           Vollständiger Name des Kontoinhabers
string(255)     $org            Firma oder Organisation 
string(255)     $email          E-Mail-Addresse
string(255)     $reply          Antwort-Addresse
boolean         $def            Account ist der Standardaccount 
                                1 = standard
                                0 = nicht standard
boolean         $sig            Fügen Sie die Signatur an die E-Mail an
                                1 = anfügen
                                0 = nicht anfügen
string(65535)   $signature      Text-Signatur
boolean         $siganswer      Hängen Sie keine Signatur für Antwort und Weiterleitung an
                                0 = anhängen
                                1 = nicht anhängen
boolean         $send           Verwenden Sie dieses Konto für das Senden von E-Mails
                                0 = nicht verwenden
                                1 = verwenden
boolean         $get            Verwenden Sie dieses Konto für den Empfang von E-Mails
                                0 = nicht verwenden
                                1 = verwenden
boolean         $type           Account-Typ 
                                0 = POP3
                                1 = IMAP
int             $inbox          Tree-Id des Posteingangs-Ordners für diesen Account
int             $trash          Tree-Id des Papierkorb-Ordners für diesen Account
int             $sent           Tree-Id des Gesendet-Ordners für diesen Account
int             $draft          Tree-Id des Entwürfe-Ordners für diesen Account
int             $junk           Tree-Id des Spam-Ordners für diesen Account

int             $chguser        Userid der letzten Änderung
int             $chgtime        Unix-Timestamp der letzten Änderung

Beispiel:

<?php
 
$result = $client_email->crmGetEmailAccounts($session_id);
foreach ($result as $account) {
	echo $account->id." ".$account->name." ".$account->email."<br>  ";
}




2.32. crmCreateMail

Syntax:

int crmCreateMail( string $session_id, MailItem $MailItem )

Beschreibung:

Erstellt eine E-Mail und kopiert sie in den Postausgangs-Ordner auf dem Server.

MailItem ist ein Objekt oder ein mehrdimensionales assoziatives Array.

Liefert die mail_id bei Erfolg, 0 im Fehlerfall.

Eigenschaften von MailItem:

Typ(Länge)          Eigenschaft     Beschreibung
-------------------------------------------------------------------
int                 $account_id     Account-Id, verwendet für das Senden von E-Mails
                                    kann 0 sein, dann wird das Standard-Konto verwendet
string(65535)       $to             An-Adressen Format: Name <info@test.com>; Name2 <info2@test.com> 
string(65535)       $cc             CC-Adressen Format: Name <info@test.com>; Name2 <info2@test.com>
string(65535)       $bcc            BCC-Adressen Format: Name <info@test.com>; Name2 <info2@test.com>
string(255)         $subject        Betreff der Nachricht
binary              $body           Base64 kodierter Text der Nachricht, kann entweder HTML oder Text sein
                                    is_html muss eingestellt werden
int                 $priority       Priorität, 5 = niedrig, 3 = normal, 1 = hoch
boolean             $is_html        HTML oder Text-Nachricht
                                    0 = Text
                                    1 = HTML
boolean             $sign           Signiert die Nachricht, ein gültiges S-MIME Zertifikat ist erforderlich
                                    0 = nicht signieren
                                    1 = signieren
boolean             $encrypt        Nachricht verschlüsseln 
                                    0 = nicht verschlüsseln 
                                    1 = verschlüsseln 
boolean             $return_receipt Empfangsbestätigung
                                    0 = keine Empfangsbestätigung
                                    1 = Empfangsbestätigung anfordern
boolean             $disposition_notification
                                    0 = keine Lesebestätigung anfordern
                                    1 = Lesebestätigung anfordern

MailItemAttachment  $MailItemAttachments Anhangs-Liste

Eigenschaften von MailItemAttachment:

Typ(Länge)          Eigenschaft     Beschreibung
-------------------------------------------------------------------
string              $name           Name das Anhangs z. B. picture.jpg
binary              $content        Binärer Inhalt des Anhangs (base64-kodiert)
string              $cid            Content-ID, nur für multipart / related Inhalt

Beispiel 1, with embedded picture:

<?php
 
$attachment_file    = "../attachments/bild.jpg";
$attachment_name    = basename($attachment_file);
$attachment_content = base64_encode(file_get_contents($attachment_file));
 
$html_body = "**This is a** //Test// with embedded picture: 
<img src=\"cid:".$attachment_name.'@'.md5($attachment_name)."\">";
 
$email = array(
	'account_id'               => 0,
	'to'                       => 'Christian Friebel <xray@tecart.de>',
	'cc'                       => '',
	'bcc'                      => '',
	'subject'                  => 'Webservice-E-Mail',
	'body'                     => base64_encode($html_body),
	'priority'                 => 5,
	'is_html'                  => 1,
	'sign'                     => 0,
	'encrypt'                  => 0,
	'disposition_notification' => 1,
	'MailItemAttachments'      => array(
		array(
			'name'     => $attachment_name,
			'content'  => $attachment_content,
			'cid'      => $attachment_name.'@'.md5($attachment_name)
		)
	)
);
 
$success = $client_email->crmCreateMail($session_id, $email);
if (!$success) {
	echo "Unable to create email";
}



Beispiel 2:

<?php
 
class attachment {
 
   public $name;
   public $content;
 
   function __construct($name, $content)
   {
       $this->name    = $name;
       $this->content = $content;
   }
}
 
class email {
 
   public $account_id = 0;
   public $to         = '';
   public $cc         = '';
   public $bcc        = '';
   public $subject    = '';
   public $body       = '';
   public $priority   = 5;
   public $is_html    = 1;
   public $sign       = 0;
   public $encrypt    = 0;
   public $MailItemAttachments = array(); 
 
   function __construct($to, $subject, $body)
   {
       $this->to      = $to;
       $this->subject = $subject;
       $this->body    = $body;  
   }
 
   public function add_attachment($name, $content)
   {
       $this->MailItemAttachments[] = new attachment($name, $content);
   }
 
}
 
$attachment_file    = "../attachments/bild.jpg";
$attachment_name    = basename($attachment_file);
$attachment_content = base64_encode(file_get_contents($attachment_file));
 
$email = new email('Christian Friebel <xray@tecart.de>', 'Webservice-E-Mail', '**This is a Test**');
$email->add_attachment($attachment_name, $attachment_content);
 
$success = $client_email->crmCreateMail($session_id, $email);
if (!$success) {
	echo "Unable to create email";
}



2.33. crmCreateNewMail

Syntax:

int crmCreateNewMail( string $session_id, MailItem $MailItem, boolean $gzip )

Beschreibung:

Erstellt eine E-Mail und kopiert sie in den Postausgangs -Ordner auf dem Server.

MailItem ist ein Objekt oder ein mehrdimensionales assoziatives Array.

Wenn gzip auf true gesetzt ist, müssen der Inhalt und die Anhänge gz kodiert gesendet werden.

Liefert die mail_id bei Erfolg, 0 im Fehlerfall.

Eigenschaften von MailItem:

Typ(Länge)          Eigenschaft     Beschreibung
-------------------------------------------------------------------
int                 $account_id     Account-Id, verwendet für das Senden von Mails
                                    kann 0 sein, dann wird das Standard-Konto verwendet
string(65535)       $to             An-Addressen Format: Name <info@test.com>; Name2 <info2@test.com> 
string(65535)       $cc             CC-Adressen Format: Name <info@test.com>; Name2 <info2@test.com>
string(65535)       $bcc            BCC-Adressen Format: Name <info@test.com>; Name2 <info2@test.com>
string(255)         $subject        Betreff der Nachricht
binary              $body           base64-kodierter Text der Nachricht (gz-kodiert), kann entweder HTML oder Text sein
                                    is_html muss gesetzt sein
int                 $priority       Priorität, 5 = niedrig, 3 = normal, 1 = hoch
boolean             $is_html        Inhalt als Text oder HTML
                                    0 = Text 
                                    1 = HTML
boolean             $sign           Nachricht Signieren, ein gültiges S-MIME-Certificate wird benötigt
                                    0 = nicht signieren
                                    1 = signieren
boolean             $encrypt        Nachricht verschlüsseln
                                    0 = nicht verschlüsseln
                                    1 = verschlüsseln
boolean             $return_receipt Empfangsbestätigung
                                    0 = nicht anfordern
                                    1 = anfordern
boolean             $disposition_notification
                                    0 = Lesebestätigung nicht anfordern
                                    1 = Lesebestätigung anfordern
int                 $mail_id        Mail-Id für die Mail der man antwortet/die weitergeleitet wird,
                                    0 for new mail
int                 $kind           0 = Neue Mail
                                    1 = Antwort
                                    2 = Weiterleitung
MailItemAttachment  $MailItemAttachments Liste der Anhänge 

Eigenschaften von MailItemAttachment:

Typ(Länge)          Eigenschaft     Beschreibung
-------------------------------------------------------------------
string              $name           Name des Anhangs z. B. picture.jpg
binary              $content        Binärer Inhalt des Anhangs, base64 kodiert (gz kodiert)
string              $cid            Content-ID, nur für multipart / related Inhalt

Beispiel:

<?php
 
$attachment_file    = "../attachments/bild.jpg";
$attachment_name    = basename($attachment_file);
$attachment_content = base64_encode(gzencode(file_get_contents($attachment_file)));
 
$html_body = "**This is a** //Test// with embedded picture: 
<img src=\"cid:".$attachment_name.'@'.md5($attachment_name)."\">";
 
$email = array(
	'account_id'               => 0,
	'to'                       => 'Christian Friebel <xray@tecart.de>',
	'cc'                       => '',
	'bcc'                      => '',
	'subject'                  => 'Webservice-E-Mail',
	'body'                     => base64_encode(gzencode($html_body)),
	'priority'                 => 5,
	'is_html'                  => 1,
	'sign'                     => 0,
	'encrypt'                  => 0,
	'disposition_notification' => 1,
	'MailItemAttachments'      => array(
		array(
			'name'     => $attachment_name,
			'content'  => $attachment_content,
			'cid'      => $attachment_name.'@'.md5($attachment_name)
		)
	)
);
 
$success = $client_email->crmCreateNewMail($session_id, $email, true);
if (!$success) {
	echo "Unable to create email";
}




2.34. crmcreateNewDraftMail

(Version >= 4.2.12314)

Syntax:

int crmcreateNewDraftMail( string $session_id, MailItem $MailItem, boolean $gzip )

Beschreibung:

Erstellt eine E-Mail und kopiert sie in den Entwurf-Ordner auf dem Server. MailItem ist ein Objekt oder ein mehrdimensionales assoziatives Array. Wenn gzip auf true gesetzt ist, müssen der Inhalt und die Anhänge gz kodiert gesendet werden. Liefert die mail_id bei Erfolg, 0 im Fehlerfall.

Eigenschaften von MailItem:

Typ(Länge)          Eigenschaft     Beschreibung
-------------------------------------------------------------------
int                 $account_id     Account-Id, verwendet für das Senden von Mails
                                    kann 0 sein, dann wird das Standard-Konto verwendet
string(65535)       $to             An-Addressen Format: Name <info@test.com>; Name2 <info2@test.com> 
string(65535)       $cc             CC-Adressen Format: Name <info@test.com>; Name2 <info2@test.com>
string(65535)       $bcc            BCC-Adressen Format: Name <info@test.com>; Name2 <info2@test.com>
string(255)         $subject        Betreff der Nachricht
binary              $body           base64-kodierter Text der Nachricht (gz-kodiert), kann entweder HTML oder Text sein
                                    is_html muss gesetzt sein
int                 $priority       Priorität, 5 = niedrig, 3 = normal, 1 = hoch
boolean             $is_html        Inhalt als Text oder HTML
                                    0 = Text 
                                    1 = HTML
boolean             $sign           Nachricht Signieren, ein gültiges S-MIME-Certificate wird benötigt
                                    0 = nicht signieren
                                    1 = signieren
boolean             $encrypt        Nachricht verschlüsseln
                                    0 = nicht verschlüsseln
                                    1 = verschlüsseln
boolean             $return_receipt Empfangsbestätigung
                                    0 = nicht anfordern
                                    1 = anfordern
boolean             $disposition_notification
                                    0 = Lesebestätigung nicht anfordern
                                    1 = Lesebestätigung anfordern
int                 $mail_id        Mail-Id für die Mail der man antwortet/die weitergeleitet wird,
                                    0 for new mail
int                 $kind           0 = Neue Mail
                                    1 = Antwort
                                    2 = Weiterleitung
MailItemAttachment  $MailItemAttachments Liste der Anhänge 

Eigenschaften von MailItemAttachment:

Typ(Länge)          Eigenschaft     Beschreibung
-------------------------------------------------------------------
string              $name           Name des Anhangs z. B. picture.jpg
binary              $content        Binärer Inhalt des Anhangs, base64 kodiert (gz kodiert)
string              $cid            Content-ID, nur für multipart / related Inhalt

Beispiel:

<?php
 
$attachment_file    = "../attachments/bild.jpg";
$attachment_name    = basename($attachment_file);
$attachment_content = base64_encode(gzencode(file_get_contents($attachment_file)));
 
$html_body = "**This is a** //Test// draft with embedded picture: 
<img src=\"cid:".$attachment_name.'@'.md5($attachment_name)."\">";
 
$email = array(
    'account_id'               => 0,
    'to'                       => 'Christian Friebel <xray@tecart.de>',
    'cc'                       => '',
    'bcc'                      => '',
    'subject'                  => 'Webservice-E-Mail',
    'body'                     => base64_encode(gzencode($html_body)),
    'priority'                 => 5,
    'is_html'                  => 1,
    'sign'                     => 0,
    'encrypt'                  => 0,
    'disposition_notification' => 1,
    'MailItemAttachments'      => array(
        array(
            'name'     => $attachment_name,
            'content'  => $attachment_content,
            'cid'      => $attachment_name.'@'.md5($attachment_name)
        )
    )
);
 
$success = $client_email->crmcreateNewDraftMail($session_id, $email, true);
if (!$success) {
	echo "Unable to create email draft";
}




2.35. crmcreateNewDraftMailFromTemplate

(Version >= 4.6.18540)

Syntax:

int crmcreateNewDraftMailFromTemplate( string $session_id, MailItem $MailItem, boolean $gzip, string $template )

Beschreibung:

Erstellt eine E-Mail und kopiert sie in den Entwurf-Ordner auf dem Server. MailItem ist ein Objekt oder ein mehrdimensionales assoziatives Array. Wenn gzip auf true gesetzt ist, müssen der Inhalt und die Anhänge gz kodiert gesendet werden. Mit template geben Sie den Namen eines Ordners der E-Mail Vorlagen an, wo ihr gewünschtes E-Mail Template liegt. Liefert die mail_id bei Erfolg, 0 im Fehlerfall.

Eigenschaften von MailItem und MailItemAttachment sind identisch zu crmcreateNewDraftMail

Beispiel:


<?php
 
$attachment_file    = "../attachments/bild.jpg";
$attachment_name    = basename($attachment_file);
$attachment_content = base64_encode(gzencode(file_get_contents($attachment_file)));
 
$template = 'testtemplate';
 
$email = array(
    'account_id'               => 0,
    'to'                       => 'Christian Friebel <xray@tecart.de>',
    'cc'                       => '',
    'bcc'                      => '',
    'subject'                  => 'Webservice-E-Mail',
    'priority'                 => 5,
    'is_html'                  => 1,
    'sign'                     => 0,
    'encrypt'                  => 0,
    'disposition_notification' => 1,
    'MailItemAttachments'      => array(
        array(
            'name'     => $attachment_name,
            'content'  => $attachment_content,
            'cid'      => $attachment_name.'@'.md5($attachment_name)
        )
    )
);
 
$success = $client_email->crmcreateNewDraftMailFromTemplate($session_id, $email, true, $template);
if (!$success) {
	echo "Unable to create email draft";
}
 




2.36. crmSendMail

Syntax:

int crmSendMail( string $session_id )

Beschreibung:

Sendet alle Nachrichten im Postausgang -Ordner.

Liefert die Anzahl der Nachrichten, die gesendet wurde.

Beispiel:

<?php
 
$sent = $client_email->crmSendMail($session_id);
echo "{$sent} Messages was sent.";




2.37. crmReceiveMail

Syntax:

int crmReceiveMail( string $session_id, int $account_id )

Beschreibung:

Empfängt Nachrichten von POP3 Server.

Wenn account_id auf 0 gesetzt ist, werden alle Mails aller registrierten Konten des aktuellen Benutzers empfangen.

Liefert die Anzahl der Nachrichten, die empfangen wurde.

Beispiel:

<?php
 
$get = $client_email->crmReceiveMail($session_id, 0);
echo "You have {$get} new Messages.";




2.38. crmSyncImapMail

Syntax:

int crmSyncImapMail( string $session_id )

Beschreibung:

Synchronisiert Imap-Nachrichten.

Liefert des Anzahl der neuen IMAP-Nachrichten.

Beispiel:

<?php
 
$get = $client_email->crmSyncImapMail($session_id);
echo "You have {$get} new IMAP-Messages.";




2.39. crmgetERPMailHeaders

Syntax:

array crmgetERPMailHeaders( string $session_id, EPRSearch $EPRSearch, int $count, int $offset)

Beschreibung:

Liefert ein Array der E-Mail-Header-Objekten für alle Benutzer je nach EPRSearch.

EPRSearch ist ein Objekt oder assoziatives Array.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden soll, 0 bedeutet keine Beschränkung.

offset ist die Offset-Position, von der aus Ergebnisse geliefert werden, wird nicht verwendet werden, wenn count auf 0 gesetzt ist .

Eigenschaften von EPRSearch:

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
int             $userid         Userid, setzen Sie sie auf 0 um Header für alle Benutzer zu erhalten
string(32)      $article        Artikelnr.
string(32)      $cas            CAS No. 
string(32)      $customer       Kundennr. 
string(255)     $notes          Notizen, oder einen Teil der Notizen
string(32)      $orderno        BestellNr.
string(128)     $ordertype      Bestell-Typ 
string(32)      $supplier       Lieferanten Nr. 
string(32)      $tracking       Tracking-Nr.

Eigenschaften von mail-header object:

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
int             $id             Mail-Id 
int             $userid         Userid
int             $folder         Tree-Id 
string(255)     $uidl           Unique-Id, gegeben vom Mailserver
string(65535)   $to             An-Addressen
string(255)     $from           Von-Addresse
string(65535)   $cc             CC-Addressen   
string(65535)   $bcc            BCC-Addressen
string(255)     $reply          Antwort-Adresse
string(255)     $subject        Betreff     
int             $attach         E-Mail hat Anhänge, 0 = keine Anhänge
int             $was_read       E-Mail wurde gelesen
                                  0 = ungelesen
                                  1 = gelesen
                                > 1 = Unix-Timestamp des Lesens
string(64)      $mail_id        Unique Identifier, um die E-Mail im Dateisystem des Servers zu identifizieren 
int             $date           Unix-Timestamp des Zeitpunkts, an dem die E Mail versendet wurde, häufig die Datum des Sendens
int             $priority       Priorität
                                  5 = niedrig
                                  3 = normal
                                  1 = hoch
int             $intern         Interne Nachricht
                                  0 = extern
                                  1 = intern von Nutzer (blau)
                                  2 = intern vom System (grün)
int             $size           Größe des E Mail in Bytes, einschließlich Anhängen
int             $pid            Project-Id, nur mit gemeinsamen E-Mails verwendet
int             $cid            Contact-Id, nur mit gemeinsamen E-Mails verwendet
int             $konto          IMAP-Account der E-Mail
                                  0 = POP3 
                                > 0 = IMAP-Account-Id
int             $signed         Nachricht ist signiert
                                  0 = nicht signiert
                                  1 = signiert
int             $encrypted      Nachricht ist verschlüsselt
                                  0 = nicht verschlüsselt
                                  1 = verschlüsselt
int             $imap           IMAP Message Sequence Number vom Mailserver
int             $message        Systemnachricht 
                                  0 = normal
                                  1 = system
int             $flag           Nachricht wurde markiert
                                  0 = nicht markiert
                                  1 = markiert
                                > 1 = Unix-Timestamp des Markierens
int             $answered       Nachricht wurde beantwortet
                                  0 = nicht beantwortet
                                  1 = beantwortet
                                > 1 = Unix-Timestamp der Antwort
int             $forwarded      Nachricht wurde weitergeleitet
                                  0 = nicht weitergeleitet
                                  1 = weitergeleitet
                                > 1 = Unix-Timestamp des Weiterleitens
string(65535)   $forwarded_to   Empfänger an den die Mail weitergeleitet wurde
string(255)     $forwarded_from Sender von dem die Mail weitergeleitet wurde
int             $done           Die Nachricht wurde als erledigt gekennzeichnet
                                  0 = nicht erledigt
                                  1 = erledigt
                                > 1 = Unix-Timestamp des erledigt-Markierens
int             $remember       Benachrichtigung an Nutzer
                                  0 = nicht benachrichtigen
                                > 0 = Unix-Timestamp der Benachrichtigung
int             $remuser        Userid, die die Benachrichtigung erhält, nur mit gemeinsamen Mails verwendet
string(255)     $answered_from  Nachricht wurde von E-Mail Adresse beantwortet  
string(255)     $return_receipt E-Mail-Addresse für die Empfangsbestätigung
string(255)     $disposition_notification 
                                E-Mail-Addresse für die Lesebestätigung
string(255)     $classref       ERP-Reference Identifier 
                                Format: customer:supplier:orderno:article:cas_no:tracking:ordertype:notes 
int             $filtered       Nachricht wurde gefiltert
                                  0 = nicht gefiltert
                                > 0 = Unix-Timestamp des Filterns
string(32)      $md5body        MD5 Checksumme des Textinhalts um die Nachricht mit anderen E-Mails zu vergleichen 
int             $tstamp         Unix-Timestamp der letzten Änderung der Header-Daten
string(65535)   $deposition     Derzeit nicht verwendet
int             $received       Unix-Timestamp des Empfangs 

Beispiel 1:

<?php
 
// Gets all headers for Customer No. 1234567
$headers = $client_email->crmgetERPMailHeaders($session_id, array('customer' => '1234567'), 0, 0);
 
foreach($headers as $email) {
	echo $email->userid." - ".$email->from." -> ".$email->subject." -> ".$email->classref."<br>  \n";
}



Beispiel 2:

<?php
 
$search = array('customer' => '1234567', 'ordertype' => 1);
 
// Gets all headers for Customer No. 1234567 and ordertype = 1
$headers = $client_email->crmgetERPMailHeaders($session_id, $search, 0, 0);
 
foreach($headers as $email) {
	echo $email->userid." - ".$email->from." -> ".$email->subject." -> ".$email->classref."<br>  \n";
}




2.40. crmgetERPMail

Syntax:

array crmgetERPMail( string $session_id, int $userid, int $mail_id, boolean $gzip )

Beschreibung:

Gibt ein Array mit nur einem Element eines E-Mail-Objekts zurück.

mail_idist die ID vom die Header-Objekt.

userid ist die User-ID vom die Header -Objekt und muss gesetzt werden.

Stellen Siegzipauf 1, wenn der Inhalt der E-Mail und Anhänge mit GZIP komprimiert werden soll.

Hinweis: Nur Mails mit einer gültigen ERP Referenz werden zurückgegeben.

Eigenschaften (E-Mail):

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
int             $id             Mail-Id
string(255)     $subject        Betreff
string(255)     $from           Von-Adresse
string(65535)   $to             An-Adresse (n)
int             $date           Datum an dem die E Mail versendet wurde, häufig das Datum des Versendens, Unix-Timestamp
boolean         $is_html        E-Mail in HTML gesendet (0 = falsch, 1 = true)
binary          $text           Text-Inhalt, base64-kodiert
binary          $html           HTML-Inhalt, base64-kodiert
string(255)     $classref       ERP-Reference Identifier
                                Format: customer:supplier:orderno:article:cas_no:tracking:ordertype:notes 
array           $attachments    Array mit Attachment Objekten

Eigenschaften (Attachment):

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
string          $name           Name das Anhangs, z. B. picture.jpg
string          $ctype          Content-Type des Anhangs, z. B. image / jpeg
string          $cid            Content-ID, für multipart / related content , z. B. eingebettete Objekte
int             $size           Größe der Anhangs in Bytes
binary          $content        Binärer Inhalt des Anhangs, base64-kodiert

Beispiel :

<?php
 
$result = $client_email->crmgetERPMail($session_id, 5, 20142, 0);
 
$email = $result[0];
 
echo "";
echo "From: ".$email->from."<br/>";
echo "Subject: ".$email->subject."<br/>";
echo "To: ".$email->to."<br/>";
echo "Date: ".date("d.m.Y - H:i:s", $email->date)."<br/><br/>";
 
echo $email->is_html ? base64_decode($email->html) : base64_decode($email->text);
 
foreach ($email->attachments as $attachment) {
 
    echo "Attachment: <a href='{$attachment->name}'>".$attachment->name."</a> (".$attachment->size.")<br/>";
    $fp = fopen($attachment->name, "w");
    fwrite($fp, base64_decode($attachment->content));
    fclose($fp);
}




2.41. crmGetPContacts

Syntax:

array crmGetPContacts( string $session_id, string $search, int $timestamp, int $count, int $offset )

Beschreibung:

Liefert ein Array mit Kontakt-Objekte aus dem persönlichen Adressbuch des aktuellen Benutzers zurück.

search ist ein freier Suchbegriff für die Suche in firstname oder lastname oder displayname oder nickname oder emailadr1 oder emailadr2 oder work_organisation

timestamp ist ein UNIX-Timestamp, falls er größer als 0 ist werden alle Kontakte zurückgegeben, die seit diesem Zeitpunkt verändert wurden.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden soll, 0 bedeutet keine Beschränkung.

offset ist die Offset-Position, von der aus Ergebnisse geliefert werden, wird nicht verwendet werden, wenn count auf 0 gesetzt ist .

Eigenschaften von contact object:

Typ(Länge)      Eigenschaft        Beschreibung
-------------------------------------------------------------------
int             $id                Contact Id 
int             $userid            Userid, 0 bedeutet dies ist ein öffentlicher Kontakt
int             $list              0 => persönlichen Kontakt, 1 => Mailingliste
string(128)     $firstname         Vorname
string(128)     $middlename        zweiter Vorname
string(128)     $lastname          Nachname
string(128)     $displayname       Name, der in Listenansichten erscheint
string(128)     $nickname          Spitzname
string(128)     $spousename        Name des Ehepartners
string(128)     $childrennames     Kinder (Namen)
int             $birthday          Unix-Timestamp des Geburtstags
int             $anniversary       Unix-Timestamp des Jahrestages
string(255)     $emailadr1         Erste E-Mail Adresse
string(255)     $emailadr2         Zweite E-Mail Adresse
string(255)     $emailadr3         Dritte E-Mail Adresse
int             $email_format      Bevorzugtes Format
                                   0 = Text
                                   1 = HTML
string(128)     $screen_name       Erster Screen Name, z.B. Messenger-Account 
string(128)     $screen_name2      Zweiter Screen Name, z.B. Messenger-Account 
string(128)     $screen_name3      Dritter Screen Name, z.B. Messenger-Account 
string(128)     $phone_work        Erste Telefonnummer geschäftlich
string(128)     $phone_work2       Zweite Telefonnummer geschäftlich
string(128)     $phone_home        Erste Telefonnummer privat
string(128)     $phone_home2       Zweite Telefonnummer privat
string(128)     $phone_fax         Faxnummer
string(128)     $phone_fax_work    Faxnummer geschäftlich
string(128)     $phone_pager       Pagernummer
string(128)     $phone_mobil       Mobilnummer
string(128)     $phone_mms         MMS-Nummer
string(128)     $phone_sms         SMS-Nummer
string(128)     $phone_car         Autotelefon
string(128)     $phone_radio       Radio-Nummer
string(128)     $phone_company     Haupttelefonnummer des Unternehmens
string(128)     $phone_assistant   Telefonnummer des Assistenten
string(128)     $home_address1     Private Addresse Zeile 1 
string(128)     $home_address2     Private Addresse Zeile 2 
string(128)     $home_city         Stadt
string(128)     $home_region       Region 
string(128)     $home_postcode     PLZ
string(128)     $home_country      Land
string(128)     $home_website      Persönliche Website 
string(128)     $work_title        Titel, z.B. CEO 
string(128)     $work_department   Abteilung 
string(128)     $work_organisation Organisations oder Unternehmensname   
string(128)     $work_address1     Geschäftliche Addresse Zeile 1 
string(128)     $work_address2     Geschäftliche Addresse Zeile 2 
string(128)     $work_city         Stadt 
string(128)     $work_region       Region 
string(128)     $work_postcode     PLZ 
string(128)     $work_country      Land 
string(255)     $work_website      Offizielle Unternehmenswebsite
string(255)     $work_location     Bürostandort
string(128)     $other_address1    Andere Adresszeile 1 
string(128)     $other_address2    Andere Adresszeile 2 
string(128)     $other_city        Andere Stadt
string(128)     $other_region      Andere Region 
string(128)     $other_postcode    Andere PLZ
string(128)     $other_country     Land
string(128)     $suffix            Suffix des Kontakts
string(128)     $managername       Manager Name
string(128)     $assistantname     Assistent Name
string(128)     $customer_id       Kunden-ID
string(128)     $gov_id            Regierungs ID
string(128)     $accountname       Account-Name 
string(255)     $custom1           Benutzerdefiniertes Feld 1 
string(255)     $custom2           Benutzerdefiniertes Feld 2 
string(255)     $custom3           Benutzerdefiniertes Feld 3 
string(255)     $custom4           Benutzerdefiniertes Feld 4 
string(65535)   $notes             Notizen
string          $picture           Kontakt-Bild-Daten - base64-kodiert
int             $chguser           Userid der letzten Änderung
int             $chgtime           Unix-Timestamp der letzten Änderung
int             $createuser        Userid der Erstellung
int             $createtime        Unix-Timestamp der Erstellung

Beispiel:

<?php
 
$result = $client_email->crmGetPContacts($session_id, 'friebel', 0, 0, 0);
 
foreach($result as $pcontact) {
 
	echo $pcontact->displayname." ".$pcontact->emailadr1."<br>";
 
}




2.42. crmGetPContact

(Version >= 3.7)

Syntax:

array crmGetPContact( string $session_id, int $pcontact_id )

Beschreibung:

Liefert ein Array mit genau einem Objekt (anhand der pcontact_id) aus dem persönlichen Adressbuch des aktuellen Benutzers zurück.

Eigenschaften von contact object:

sind die selben wie für crmGetPContacts

Beispiel:

<?php
 
$result = $client_email->crmGetPContact($session_id, 1234);
 
echo $result[0]->displayname." ".$result[0]->emailadr1."<br>";




2.43. crmAddPContact

Syntax:

int crmAddPContact( string $session_id, PContactItem $PContactItem )

Beschreibung:

Hinzufügen eines persönlichen Kontakts.

PContactItem ist ein Kontakt-Objekt oder ein assoziatives Array.

Liefert eine kontakt_id bei Erfolg, 0 ist, im Fehlerfall.

Eigenschaften von PContactItem:

Typ(Länge)      Eigenschaft        Beschreibung
-------------------------------------------------------------------
int             $userid            Userid, 0 bedeutet dies ein öffentlicher Kontakt
int             $list              0 => persönlichen Kontakt, 1 => Mailingliste
string(128)     $firstname         Vorname
string(128)     $middlename        zweiter Vorname
string(128)     $lastname          Familienname
string(128)     $displayname       Name, der in Listenansichten erscheint
string(128)     $nickname          Spitzname
string(128)     $spousename        Name des Ehepartners
string(128)     $childrennames     Kinder (Namen)
int             $birthday          Unix-Timestamp des Geburtstags
int             $anniversary       Unix-Timestamp des Jahrestages
string(255)     $emailadr1         Erste E-Mail Adresse
string(255)     $emailadr2         Zweite E-Mail Adresse
string(255)     $emailadr3         Dritte E-Mail Adresse
int             $email_format      Bevorzugtes Format
                                   0 = Text
                                   1 = HTML
string(128)     $screen_name       Erster Screen Name, z.B. Messenger-Account 
string(128)     $screen_name2      Zweiter Screen Name, z.B. Messenger-Account 
string(128)     $screen_name3      Dritter Screen Name, z.B. Messenger-Account 
string(128)     $phone_work        Erste Telefon-Nummer geschäftlich
string(128)     $phone_work2       Zweite Telefon-Nummer geschäftlich
string(128)     $phone_home        Erste Telefon-Nummer privat
string(128)     $phone_home2       Zweite Telefon-Nummer privat
string(128)     $phone_fax         Fax-Nummer
string(128)     $phone_fax_work    Fax-Nummer geschäftlich
string(128)     $phone_pager       Pager-Nummer 
string(128)     $phone_mobil       Mobilnummer
string(128)     $phone_mms         MMS-Nummer
string(128)     $phone_sms         SMS-Nummer
string(128)     $phone_car         Auto Telefonnummer
string(128)     $phone_radio       Radio Telefonnummer
string(128)     $phone_company     Haupttelefonnummer des Unternehmens
string(128)     $phone_assistant   Telefonnummer des Assistenten
string(128)     $home_address1     Private Adresse Zeile 1 
string(128)     $home_address2     Private Adresse Zeile 2 
string(128)     $home_city         Stadt 
string(128)     $home_region       Region 
string(128)     $home_postcode     PLZ
string(128)     $home_country      Land
string(128)     $home_website      Persönliche Website 
string(128)     $work_title        Titel, z.B. CEO 
string(128)     $work_department   Abteilung
string(128)     $work_organisation Organisations- oder Unternehmensname  
string(128)     $work_address1     Geschäftliche Addresse Zeile 1 
string(128)     $work_address2     Geschäftliche Addresse Zeile 2 
string(128)     $work_city         Stadt
string(128)     $work_region       Region 
string(128)     $work_postcode     PLZ 
string(128)     $work_country      Land
string(255)     $work_website      Offizielle Unternehmens-Website
string(255)     $work_location     Bürostandort
string(128)     $other_address1    Andere Adresse Zeile 1 
string(128)     $other_address2    Andere Adresse Zeile 2 
string(128)     $other_city        STadt
string(128)     $other_region      Region 
string(128)     $other_postcode    PLZ
string(128)     $other_country     Land
string(128)     $suffix            Suffix des Kontakts
string(128)     $managername       Manager Name
string(128)     $assistantname     Assistent Name
string(128)     $customer_id       Kunden-ID
string(128)     $gov_id            Regierungs ID
string(128)     $accountname       Account Name 
string(255)     $custom1           Benutzerdefiniertes Feld 1 
string(255)     $custom2           Benutzerdefiniertes Feld 2 
string(255)     $custom3           Benutzerdefiniertes Feld 3 
string(255)     $custom4           Benutzerdefiniertes Feld 4 
string(65535)   $notes             Notizen
string          $picture           Kontakt Bild-Daten (base64-kodiert)

Beispiel 1:

<?php
 
$contact = array('firstname' => 'Web', 'lastname' => 'Service', 'emailadr1' => 'test@webservice.com');
 
$pid = $client_email->crmAddPContact($session_id, $contact);
echo $pid;



Beispiel 2:

<?php
 
class contact {
 
   public $firstname;
   public $lastname;
   public $emailadr1;
   public $emailadr2;
   public $email_format;
}
 
$contact = new contact();
$contact->firstname    = 'Web';
$contact->lastname     = 'Service';
$contact->emailadr1    = 'test@webservice.com';
$contact->emailadr2    = 'home@myhouse.com';
$contact->email_format = 0;
 
$pid = $client_email->crmAddPContact($session_id, $contact);
echo $pid;




2.44. crmChangePContact

Syntax:

int crmChangePContact( string $session_id, int $contact_id, PContactItem $PContactItem )

Beschreibung:

Ändert einen persönlichen Kontakt im persönlichen Adressbuch des aktuellen Benutzers.

PContactItem ist ein Kontakt-Objekt oder ein assoziatives Array.

Liefert eine kontakt_id bei Erfolg, 0 im Fehlerfall.

Eigenschaften von PContactItem:

sind die selben wie für crmAddPContact

Beispiel:

<?php
 
$pid = $client_email->crmChangePContact($session_id, $pid, array('lastname' => 'Service Changed'));
echo $pid;




2.45. crmdeletePContact

Syntax:

boolean crmdeletePContact( string $session_id, int $contact_id )

Beschreibung:

Löscht einen persönlichen Kontakt vom persönlichen Adressbuch des aktuellen Benutzers.

Liefert 1 bei Erfolg, 0 im Fehlerfall.

Beispiel:

<?php
 
$success = $client_email->crmdeletePContact($session_id, $pid);
if (!$success) echo "Unable to delete Contact.";




2.46. crmgetPContactIdByExtId

(Version >= 4.2)

Syntax:

array crmgetPContactIdByExtId( string $session_id, string $external_id )

Beschreibung

Liefert interne ID(s) von persönlichen Kontakten mit der übergebenen externen ID zurück.

Eigenschaften der zurückgegebenen pcontact Objekte:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			            $id			      Contact-Id

Beispiel:

<?php
 
try {
  $result = $client_email->crmgetPContactIdByExtId($session_id, 12345);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($result as $id) {
   
     echo $id."<br>  ";
}




2.47. crmgetAllPContactExtIds

(Version >= 4.2)

Syntax:

array crmgetAllPContactExtIds( string $session_id )

Beschreibung

Liefert eine Liste aller externen IDs in persönlichen Kontakten zurück.

Eigenschaften der zurückgegebenen pcontact Objekte:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			            $id			      externe Contact-Id

Beispiel:

<?php
 
try { 
	$result = $client_email->crmgetAllPContactExtIds($session_id);
}
catch (SOAPFault $f) {
	print $f->faultstring;
}
 
foreach($result as $id) {
   
	echo $id."<br>  ";
}




2.48. crmdeletePContactsString

Syntax:

boolean crmdeletePContactsString( string $session_id, string $contact_ids )

Beschreibung:

Löscht mehrere persönliche Kontakte vom persönlichen Adressbuch des aktuellen Benutzers.

contact_ids ist eine Semikolon getrennter Zeichenfolge von IDs zum löschen.

Liefert 1 bei Erfolg, 0 im Fehlerfall.

Beispiel:

<?php
 
$success = $client_email->crmdeletePContactsString($session_id, '123;124;999');
if (!$success) {
	echo "Unable to delete one or more Contacts.";
}




2.49. crmgetPContactAddrs

Syntax:

array crmgetPContactAddrs( string $session_id, int $contact_id, int $timestamp )

Beschreibung:

Liefert Adress-IDs für eine bestimmte Mailing-Liste.

contact_id ist die ID des persönlichen Kontakts (id der Mailing-Liste).

timestamp ist ein UNIX-Timestamp, falls er größer als 0 gesetzt ist werden alle Adressen zurückgegeben die seit diesem Zeitpunkt verändert wurden.

Liefert ein Array von Objekt-Adressen

Eigenschaften von address object:

Typ(Länge)      Eigenschaft        Beschreibung
--------------------------------------------------------------------------
int             $id                Adress-ID
int             $mid               Mailing-List-ID ( personal contact id )
int             $cid               contact id von gemeinsamen Kontakten
int             $pid               person id von gemeinsamen Kontakten
int             $uid               user id
int             $pcid              personal contact id
int             $chguser           Userid der letzten Änderung 
int             $chgtime           Unix-Timestamp der letzten Änderung
int             $createuser        Userid der Erstellung
int             $createtime        Unix-Timestamp der Erstellung 
--------------------------------------------------------------------------

Beispiel 1:

<?php
 
// Get addresses from mailing list 
 
$pcontact_id = 300;
 
$result = $client_email->crmgetPContactAddrs($session_id, $pcontact_id, 0);
 
foreach($result as $pcontact_addr)
{
	echo "MID: {$pcontact_addr->mid}<br>  ";
    echo "CID: {$pcontact_addr->cid}<br>  ";
    echo "PID: {$pcontact_addr->pid}<br>  ";
    echo "UID: {$pcontact_addr->uid}<br>  ";
    echo "PCID: {$pcontact_addr->pcid}<br>  <hr/>";
}



Beispiel 2:

<?php
 
// Get addresses from all mailing lists
 
$result = $client_email->crmgetPContactAddrs($session_id, 0, 0);
 
foreach($result as $pcontact_addr)
{
	echo "MID: {$pcontact_addr->mid}<br>  ";
    echo "CID: {$pcontact_addr->cid}<br>  ";
    echo "PID: {$pcontact_addr->pid}<br>  ";
    echo "UID: {$pcontact_addr->uid}<br>  ";
    echo "PCID: {$pcontact_addr->pcid}<br>  <hr/>";
}




2.50. crmaddPContactAddrs

Syntax:

boolean crmaddPContactAddrs( string $session_id, addPContactAddrs $addPContactAddrs )

Beschreibung:

Adress-IDs zu einer bestimmten Mailing-Liste hinzufügen.

addPContactAddrs ist ein Objekt mit den Adress-IDs.

Liefert 1 bei Erfolg, 0 im Fehlerfall.

Eigenschaften von addPContactAddrs:

Typ(Länge)      Eigenschaft                Beschreibung
-----------------------------------------------------------------------------------
array           $addPContactAddrsElements  array mit addPContactAddrsElement Objekte
-----------------------------------------------------------------------------------

Eigenschaften von addPContactAddrsElement:

Typ(Länge)      Eigenschaft                Beschreibung
-----------------------------------------------------------------------------------
int             $mid                       mailing list id ( personal contact id )
int             $cid                       contact id von gemeinsamen Kontakten
int             $pid                       person id von gemeinsamen Kontakten
int             $uid                       user id
int             $pcid                      personal contact id
-----------------------------------------------------------------------------------

Beispiel:

<?php
 
// Add addresses to mailing list with id 300
 
class addPContactAddrs 
{
	public $addPContactAddrsElements = array(
		array('mid' => 300, 'cid' => 5149),
		array('mid' => 300, 'pid' => 5887),
		array('mid' => 300, 'pid' => 5888),
		array('mid' => 300, 'pid' => 5886)
	);
}
 
$success = $client_email->crmaddPContactAddrs($session_id, new addPContactAddrs());
if ($success === false) {
	echo "Error adding addresses";
}




2.51. crmdelPContactAddrs

Syntax:

boolean crmdelPContactAddrs( string $session_id, int $mid, int $id )

Beschreibung:

Löscht alle oder eine Adress-ID (s) aus einer bestimmten Mailing-Liste.

mid ist die mailing list id ( personal contact id ).

id ist die address id.

Wenn mid gesetzt ist und id ist 0, werden alle Adressen dieser Mailingliste gelöscht.

Liefert 1 bei Erfolg, 0 im Fehlerfall.

Beispiel:


<?php
 
// Deletes all addresses from mailing list with id 300
 
$success = $client_email->crmdelPContactAddrs($session_id, 300, 0);
if ($success === false) {
	echo "Error deleting addresses";
}

2.52. crmChangeMailItems

Syntax:

int crmChangeMailItems( string $session_id, ChangeMailItems $ChangeMailItems )

Beschreibung:

Ändert Eigenschaften der gegebenen E-Mails.

ChangeMailItems ist ein Objekt oder ein mehrdimensionales Array Assoziative.

Liefert 1 bei Erfolg, im Fehlerfall mail_id.

Hinweis: Wenn ein Fehler auftritt, bricht die Funktion an der Stelle des Fehlers ab, und gibt die fehlerhafte mail_id zurück.

Wenn ein Element nicht existiert wird kein Fehler zurückgegeben.

Hinweis: Seit Version >= 3.1.2566 ist es möglich, MailItems zu Kontakten, Projekten und Tickets zu verschieben, indem man ihnen einen neuen Ordner zuweist, in diesem Fall muss der Ordner ein gemeinsamer Ordner sein.

Eigenschaften von ChangeMailItems:

Typ(Länge)              Eigenschaft                 
------------------------------------------------
ChangeMailItemsElement  ChangeMailItemsElements

Eigenschaften von ChangeMailItemsElement:

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
int             $id             Mail-Id 
int             $folder         Tree-Id 
int             $was_read       E-Mail wurde gelesen 
                                  0 = ungelesen
                                  1 = gelesen
                                > 1 = Unix-Timestamp des Lesens
int             $priority       Priorität 
                                  5 = niedrig
                                  3 = normal
                                  1 = hoch
int             $intern         Interne Nachricht
                                  0 = extern
                                  1 = intern von Nutzer (blau)
                                  2 = intern vom System (grün)
int             $konto          IMAP-Account der E-Mail
                                  0 = POP3 
                                > 0 = IMAP-Account-Id
int             $flag           Nachricht wurde markiert 
                                  0 = nicht markiert
                                  1 = markiert
                                > 1 = Unix-Timestamp des Markierens
int             $answered       Die Nachricht wurde beantwortet
                                  0 = nicht beantwortet
                                  1 = beantwortet
                                > 1 = Unix-Timestamp der Antwort
int             $forwarded      Nachricht wurde weitergeleitet
                                  0 = nicht weitergeleitet
                                  1 = weitergeleitet
                                > 1 = Unix-Timestamp des weiterleitens
string(65535)   $forwarded_to   Empfänger zu dem diese Mail weitergeleitet wurde
string(255)     $forwarded_from Sender der diese MAil weitergeleitet hat
int             $done           Die Nachricht wurde als erledigt gekennzeichnet
                                  0 = nicht erledigt
                                  1 = erledigt
                                > 1 = Unix-Timestamp des Erledigt-Markierens
int             $remember       Benachrichtigung
                                  0 = nicht benachrichtigen
                                > 0 = Unix-Timestamp der Benachrichtigung
string(255)     $answered_from  Wurde von E-Mail Adresse beantwortet 
string(255)     $return_receipt E Mail Adresse für den Empfang von Empfangsbestätigungen
string(255)     $disposition_notification 
                                E-Mail Adresse für den Empfang von Lesebestätigung
int             $filtered       Nachricht wurde gefiltert
                                  0 = nicht gefiltert
                                > 0 = Unix-Timestamp des filterns

Beispiel:

<?php
 
class ChangeMails 
{
	public $ChangeMailItemsElements = array(
		array('id' => 24006, 'was_read' => 0),
		array('id' => 23964, 'was_read' => 0),
		array('id' => 23970, 'was_read' => 0, 'folder' => 4958)
	);
}
 
$success = $client_email->crmChangeMailItems($session_id, new ChangeMails());




2.53. crmChangeCommonMailItems

(Version >= 3.1.2566)

Syntax:

int crmChangeCommonMailItems( string $session_id, ChangeMailItems $ChangeMailItems )

Beschreibung:

Ändert Eigenschaften der angegebenen E-Mails.

ChangeMailItems ist ein Objekt oder ein mehrdimensionales Array Assoziative.

Liefert 1 bei Erfolg, im Fehlerfall mail_id zurück

Hinweis: Wenn ein Fehler auftritt, bricht die Funktion an der Stelle des Fehlers ab, und gibt die fehlerhafte mail_id zurück.

Wenn ein Element nicht existiert wird kein Fehler zurückgegeben

Eigenschaften von ChangeMailItems:

sind die selben wie für crmChangeMailItems

Beispiel:

<?php
 
class ChangeMails 
{
	public $ChangeMailItemsElements = array(
		array('id' => 24006, 'was_read' => 0),
		array('id' => 23964, 'was_read' => 0),
		array('id' => 23970, 'was_read' => 0, 'folder' => 4958)
	);
}
 
$success = $client_email->crmChangeCommonMailItems($session_id, new ChangeMails());




2.54. crmgetMailIds

Syntax:

array crmgetMailIds( string $session_id, int $tree_id, int $timestamp, int $count, int $offset )

Beschreibung:

Liefert ein Array der E-Mail-IDs des aktuellen Benutzers.

tree_id ist die ID des Ordners von dem die Mail-Header geholt werden, setzen Sie sie auf 0 um Header aus allen Ordnern( ohne gemeinsame E-Mails ) zu bekommen.

timestamp ist eine UNIX-Timestamp, falls er größer als 0 gesetzt ist werden alle Header zurückgegeben die seit diesem Zeitpunkt verändert wurden.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden soll, 0 bedeutet keine Beschränkung.

offset ist die Offset-Position, von der aus Ergebnisse geliefert werden, wird nicht verwendet werden, wenn count auf 0 gesetzt ist .

Hinweis: Seit Version >= 3.1.2566 erhalten Sie auch gemeinsame mail_ids aus dem Ordner tree_id

Eigenschaften von crmgetMailIdsResult:

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
int             $id             Mail-Id

Beispiel:

<?php
 
$inbox = $client_email->crmgetInboxFolder($session_id, 0);
 
$headers = $client_email->crmgetMailIds($session_id, $inbox, 0, 10, 0);
foreach($headers as $email) {
	echo $email->id."<br>  \n";
}




2.55. crmgetMailIdsString

Syntax:

string crmgetMailIdsString( string $session_id, int $tree_id, int $timestamp, int $count, int $offset )

Beschreibung:

Liefert eine Doppelpunkt getrennt Zeichenfolge von Mail-IDs des aktuellen Benutzers.

tree_id ist die ID des Ordners von dem Mail-Header geholt werden.

timestamp ist eine UNIX-Timestamp, falls er größer als 0 gesetzt ist werden alle Header zurückgegeben die seit dieser Zeit verändert wurden.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden soll, 0 bedeutet keine Beschränkung.

offset ist die Offset-Position, von der aus Ergebnisse geliefert werden, wird nicht verwendet werden, wenn count auf 0 gesetzt ist .

Hinweis: Seit Version >= 3.1.2566 erhalten Sie auch mail_ids von gemeinsame Ordnern mit tree_id.

Beispiel:

<?php
 
$inbox = $client_email->crmgetInboxFolder($session_id, 0);
 
$mail_ids = $client_email->crmgetMailIdsString($session_id, $inbox, 0, 10, 0);
echo $mail_ids;




2.56. crmgetMailIdsStringAll

(Version >= 3.7.8168)

Syntax:

string crmgetMailIdsStringAll( string $session_id, int $timestamp, int $count, int $offset )

Beschreibung:

Liefert eine kommagetrennte Zeichenfolge von Mail-IDs und Ordnern des aktuellen Benutzers.

timestamp ist eine UNIX-Timestamp, falls er größer als 0 gesetzt ist werden alle Header zurückgegeben die seit dieser Zeit verändert wurden.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden soll, 0 bedeutet keine Beschränkung.

offset ist die Offset-Position, von der aus Ergebnisse geliefert werden, wird nicht verwendet werden, wenn count auf 0 gesetzt ist .

Beispiel:

<?php
 
$result = $client_email->crmgetMailIdsStringAll($inbox, 0, 10, 0);
 
$mail_ids = explode(',', $result);
foreach ($mail_ids as $id) {
	list($mid, $folder) = explode(':', $id);
    echo $mid." -> ".$folder."\n";
}




2.57. crmGetPContactIds

Syntax:

array crmGetPContactIds( string $session_id, string $search, int $timestamp, int $count, int $offset )

Beschreibung:

Liefert ein Array mit Kontakt-Objekten aus dem persönlichen Adressbuch des aktuellen Benutzers.

search ist eine freier Suchbegriff für die Suche in firstname oder lastname oder displayname oder nickname oder emailadr1 oder emailadr2 oder work_organisation.

timestamp ist eine UNIX-Timestamp, falls er größer als 0 gesetzt ist werden alle Kontakte zurückgegeben, die seit diesem Zeitpunkt verändert wurden.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden soll, 0 bedeutet keine Beschränkung.

offset ist die Offset-Position, von der aus Ergebnisse geliefert werden, wird nicht verwendet werden, wenn count auf 0 gesetzt ist .

Eigenschaften von contact object:

Typ(Länge)      Eigenschaft        Beschreibung
-------------------------------------------------------------------
int             $id                Contact Id 

Beispiel:

<?php
 
$result = $client_email->crmGetPContactIds($session_id, //, 0, 0, 0);//
 
foreach($result as $pcontact) {
 
	echo $pcontact->id."<br>";
 
}




2.58. crmGetPContactIdsString

Syntax:

array crmGetPContactIdsString( string $session_id, string $search, int $timestamp, int $count, int $offset )

Beschreibung:

Liefert eine Semikolon getrennte Zeichenfolge von IDs von den Kontakt-Objekten des aktuellen Benutzers.

search ist ein freier Suchbegriff für die Suche in firstname oder lastname oder displayname oder nickname oder emailadr1 oder emailadr2 oder work_organisation.

timestamp ist ein UNIX-Timestamp, falls er größer als 0 gesetzt ist werden alle Kontakte zurückgegeben, die seit diesem Zeitpunkt verändert wurden.

count ist die Anzahl der Ergebnisse die zurückgeliefert werden soll, 0 bedeutet keine Beschränkung.

offset ist den Offset-Position, von der aus Ergebnisse geliefert werden, wird nicht verwendet werden, wenn count auf 0 gesetzt ist .

Beispiel:

<?php
 
$contact_ids = $client_email->crmGetPContactIdsString($session_id, //, 0, 0, 0);//
echo $contact_ids;




2.59. crmDeleteMails

Syntax:

boolean crmDeleteMails( string $session_id, string $mail_ids )

Beschreibung:

Bewegen der ausgewählten E-Mails in den Papierkorb.

mail_ids enthält die Doppelpunkt getrennten mail_ids zum löschen.

Alle mail_ids müssen sich im selben Ordner befinden.

Beispiel:

<?php
 
$mailids = "24183:24179";
 
$success = $client_email->crmDeleteMails($session_id, $mailids);
if ($success === false) {
	echo "Error deleting mails";
}




2.60. crmDeleteCommonMails

(Version >= 3.1.2566)

Syntax:

boolean crmDeleteCommonMails( string $session_id, string $mail_ids )

Beschreibung:

Bewegt ausgewählte gemeinsame E-Mails von Kontakten Projekten oder Tickets in ihren Papierkorb.

mail_ids enthält die Doppelpunkt getrennten mail_ids zum löschen.

Alle mail_ids müssen sich im selben Ordner befinden.

Beispiel:

<?php
 
$mailids = "24183:24179:5534";
 
$success = $client_email->crmDeleteCommonMails($session_id, $mailids);
if ($success === false) {
	echo "Error deleting mails";
}




2.61. crmEmptyTrash

Syntax:

boolean crmEmptyTrash( string $session_id )

Beschreibung:

Leert den Papierkorb-Ordner und löscht alle Unterordner darin.

Beispiel:

<?php
 
$success = $client_email->crmEmptyTrash($session_id);
if ($success === false) {
	echo "Error empty trash";
}




2.62. crmSetSpam

Syntax:

boolean crmSetSpam( string $session_id, string $mail_ids )

Beschreibung:

Setzt die ausgewählte E-Mails als Spam und verschiebt Sie sie in den Spam Ordner.

mail_ids ist eine Zeichenfolge mit dem mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

Beispiel:

<?php
 
$mail_ids = "24173:24170";
 
$success = $client_email->crmsetSpam($session_id, $mail_ids);
if ($success === false) {
	echo "Error setting selected mails as spam.";
}




2.63. crmSetNotSpam

Syntax:

boolean crmSetNotSpam( string $session_id, string $mail_ids )

Beschreibung:

Setzt die ausgewählten E-Mails als Nicht Spam und verschiebt Sie sie zurück in den Posteingangsordner.

mail_ids ist eine Zeichenfolge mit mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

Beispiel:

<?php
 
$mail_ids = "24173:24170";
 
$success = $client_email->crmSetNotSpam($session_id, $mail_ids);
if ($success === false) {
	echo "Error setting selected mails as not-spam.";
}




2.64. crmMoveToUser

Syntax:

boolean crmMoveToUser( string $session_id, string $mail_ids, string $user_ids, boolean $notify )

Beschreibung:

Bewegt ausgewählte E-Mails zu Nutzer(n).

mail_ids ist eine Zeichenfolge mit den mail_ids.Format: mail_id1:mail_id2:…:mail_idn.

user_ids ist eine Zeichenfolge mit den user_ids. Format: user_id1:user_id2:…:user_idn.

Wenn notify auf true gesetzt ist wird eine Lesebestätigung angefordert.

Beispiel:

<?php
 
$mail_ids = "24173:24170";
$user_ids = "28";
 
$success = $client_email->crmMoveToUser($session_id, $mail_ids, $user_ids, 1);
if ($success === false) {
	echo "Error moving mails to user 28.";
}
 




2.65. crmMoveCommonToUser

(Version >= 3.1.2566)

Syntax:

boolean crmMoveCommonToUser( string $session_id, string $mail_ids, string $user_ids, boolean $notify )

Beschreibung:

Bewegt ausgewählte E-Mails von Kontakten Projekten oder Tickets zu Nutzer(n).

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

user_ids ist eine Zeichenfolge mit den user_ids. Format: user_id1:user_id2:…:user_idn.

Wenn notify auf true gesetzt ist wird eine Lesebestätigung angefordert.

Beispiel:

<?php
 
$mail_ids = "24173:24170";
$user_ids = "28:29:5";
 
$success = $client_email->crmMoveCommonToUser($session_id, $mail_ids, $user_ids, 1);
if ($success === false) {
	echo "Error moving mails to user 28, 29, 5.";
}




2.66. crmCopyToUser

Syntax:

boolean crmCopyToUser( string $session_id, string $mail_ids, string $user_ids, boolean $notify )

Beschreibung:

Kopiert / Forwardet ausgewählten E-Mails an Nutzer.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

user_ids ist eine Zeichenfolge mit den user_ids. Format: user_id1:user_id2:…:user_idn.

Wenn notify auf true gesetzt ist wird eine Lesebestätigung angefordert.

Beispiel:

<?php
 
$mail_ids = "24173:24170";
$user_ids = "28:29:30";
 
$success = $client_email->crmCopyToUser($session_id, $mail_ids, $user_ids, 1);
if ($success === false) {
	echo "Error forwarding mails to users.";
}




2.67. crmCopyCommonToUser

(Version >= 3.1.2566)

Syntax:

boolean crmCopyCommonToUser( string $session_id, string $mail_ids, string $user_ids, boolean $notify )

Beschreibung:

Kopiert / Forwardet ausgewählten E-Mails von Kontakten Projekten oder Tickets zu Nutzer(n).

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

user_ids ist eine Zeichenfolge mit den user_ids. Format: user_id1:user_id2:…:user_idn.

Wenn notify auf true gesetzt ist wird eine Lesebestätigung angefordert.

Beispiel:

<?php
 
$mail_ids = "24173:24170";
$user_ids = "28:29:30";
 
$success = $client_email->crmCopyCommonToUser($session_id, $mail_ids, $user_ids, 1);
if ($success === false) {
	echo "Error forwarding mails to users.";
}




2.68. crmMoveToContact

Syntax:

int crmMoveToContact( string $session_id, string $mail_ids, int $cid )

Beschreibung:

Verschiebt die ausgewählten E-Mails zum bestimmten Kontakt.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

cid ist die Kontakt-ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1, wenn Mail bereits im Kontakt existiert

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmMoveToContact($session_id, $mail_ids, 344);
 
switch($success) {
  case 0:
       echo "Error moving mails to contact";
       break;
    case -1:
       echo "Some of the Mails already exists at contact.";
       break;
    case 1:
       echo "Mails successfully moved";
       break;
}




2.69. crmMoveCommonToContact

(Version >= 3.1.2566)

Syntax:

int crmMoveCommonToContact( string $session_id, string $mail_ids, int $cid )

Beschreibung:

Verschiebt die ausgewählten E-Mails von Kontakten Projekten oder Tickets zum bestimmten Kontakt.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

cid ist die Kontakt-ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1, wenn Mail bereits im Kontakt existiert.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmMoveCommonToContact($session_id, $mail_ids, 662);
 
switch($success) {
  case 0:
       echo "Error moving mails to contact";
       break;
    case -1:
       echo "Some of the Mails already exists at contact.";
       break;
    case 1:
       echo "Mails successfully moved";
       break;
}




2.70. crmMoveToTicket

(Version >= 3.1.2566)

Syntax:

int crmMoveToTicket( string $session_id, string $mail_ids, int $tid )

Beschreibung:

Verschiebt die ausgewählten E-Mails zum bestimmten Ticket.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

tid ist die Ticket-ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1, wenn Mail bereits im Ticket existiert.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmMoveToTicket($session_id, $mail_ids, 152);
 
switch($success) {
  case 0:
       echo "Error moving mails to ticket";
       break;
    case -1:
       echo "Some of the Mails already exists at ticket.";
       break;
    case 1:
       echo "Mails successfully moved";
       break;
}




2.71. crmMoveCommonToTicket

(Version >= 3.1.2566)

Syntax:

int crmMoveToTicket( string $session_id, string $mail_ids, int $tid )

Beschreibung:

Verschiebt die ausgewählten E-Mails von Kontakten, Projekten oder Tickets zum angegebenen Ticket.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

tid ist die Ticket-ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1, wenn Mail bereits im Ticket existiert.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmMoveCommonToTicket($session_id, $mail_ids, 152);
 
switch($success) {
  case 0:
       echo "Error moving mails to ticket";
       break;
    case -1:
       echo "Some of the Mails already exists at ticket.";
       break;
    case 1:
       echo "Mails successfully moved";
       break;
}




2.72. crmCopyToContact

Syntax:

int crmCopyToContact( string $session_id, string $mail_ids, int $cid )

Beschreibung:

Kopiert die ausgewählten E-Mails zum angegebenen Kontakt.

mail_ids ist eine Zeichenfolge mit den mail_ids.Format: mail_id1:mail_id2:…:mail_idn.

cid ist die Kontakt-ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1, wenn Mail bereits im Kontakt existiert.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmCopyToContact($session_id, $mail_ids, 344);
 
switch($success) {
  case 0:
       echo "Error copy mails to contact";
       break;
    case -1:
       echo "Some of the Mails already exists at contact.";
       break;
    case 1:
       echo "Mails successfully copied";
       break;
}




2.73. crmCopyCommonToContact

(Version >= 3.1.2566)

Syntax:

int crmCopyCommonToContact( string $session_id, string $mail_ids, int $cid )

Beschreibung:

Kopiert die ausgewählten E-Mails von Kontakten, Projekten oder Tickets zum angegebenen Kontakt.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

cid ist die Kontakt-ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1, wenn Mail bereits im Kontakt existiert.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmCopyCommonToContact($session_id, $mail_ids, 866);
 
switch($success) {
  case 0:
       echo "Error copy mails to contact";
       break;
    case -1:
       echo "Some of the Mails already exists at contact.";
       break;
    case 1:
       echo "Mails successfully copied";
       break;
}




2.74. crmCopyToTicket

(Version >= 3.1.2566)

Syntax:

int crmCopyToTicket( string $session_id, string $mail_ids, int $tid )

Beschreibung:

Kopiert die ausgewählten E-Mails zum angegebenen Ticket.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

tid ist die Ticket-ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1, wenn Mail bereits im Ticket existiert.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmCopyToTicket($session_id, $mail_ids, 881);
 
switch($success) {
  case 0:
       echo "Error copy mails to ticket";
       break;
    case -1:
       echo "Some of the Mails already exists at ticket.";
       break;
    case 1:
       echo "Mails successfully copied";
       break;
}




2.75. crmCopyCommonToTicket

(Version >= 3.1.2566)

Syntax:

int crmCopyCommonToTicket( string $session_id, string $mail_ids, int $tid )

Beschreibung:

Kopiert die ausgewählten E-Mails von Kontakten, Projekten oder Tickets zum angegebenen Ticket.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

tid ist die Ticket-ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1, wenn Mail bereits im Ticket existiert.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmCopyCommonToTicket($session_id, $mail_ids, 772);
 
switch($success) {
  case 0:
       echo "Error copy mails to ticket";
       break;
    case -1:
       echo "Some of the Mails already exists at ticket.";
       break;
    case 1:
       echo "Mails successfully copied";
       break;
}




2.76. crmMoveToProject

Syntax:

int crmMoveToProject( string $session_id, string $mail_ids, int $pid )

Beschreibung:

Verschiebt die ausgewählten E-Mails zum angegebenen Projekt.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

pid ist die Projekt ID.

Zurück 1 bei Erfolg, 0 im Fehlerfall -1, wenn E-Mail bereits im Projekt vorhanden ist.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmMoveToProject($session_id, $mail_ids, 107);
 
switch($success) {
  case 0:
       echo "Error moving mails to project";
       break;
    case -1:
       echo "Some of the Mails already exists at project.";
       break;
    case 1:
       echo "Mails successfully moved";
       break;
}




2.77. crmMoveCommonToProject

(Version >= 3.1.2566)

Syntax:

int crmMoveCommonToProject( string $session_id, string $mail_ids, int $pid )

Beschreibung:

Verschiebt die ausgewählten E-Mails von Kontakten Projekten oder Tickets zum angegebenen Projekt.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

pid ist die Projekt ID.

Zurück 1 bei Erfolg, 0 im Fehlerfall -1, wenn E-Mail bereits im Projekt vorhanden ist.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmMoveCommonToProject($session_id, $mail_ids, 107);
 
switch($success) {
  case 0:
       echo "Error moving mails to project";
       break;
    case -1:
       echo "Some of the Mails already exists at project.";
       break;
    case 1:
       echo "Mails successfully moved";
       break;
}




2.78. crmCopyToProject

Syntax:

int crmCopyToProject( string $session_id, string $mail_ids, int $pid )

Beschreibung:

Kopiert die ausgewählten E-Mails zum angegebenen Projekt.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

pid ist die Projekt ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1, wenn Mail bereits im Projekt existiert.

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmCopyToProject($session_id, $mail_ids, 107);
 
switch($success) {
  case 0:
       echo "Error copy mails to project";
       break;
    case -1:
       echo "Some of the Mails already exists at project.";
       break;
    case 1:
       echo "Mails successfully copied";
       break;
}




2.79. crmCopyCommonToProject

Syntax:

int crmCopyCommonToProject( string $session_id, string $mail_ids, int $pid )

Beschreibung:

Kopiert die ausgewählten E-Mails von Kontakten Projekten oder Tickets zum angegebenen Projekt.

mail_ids ist eine Zeichenfolge mit den mail_ids. Format: mail_id1:mail_id2:…:mail_idn.

pid ist die Projekt ID.

Liefert 1 bei Erfolg, 0 im Fehlerfall -1( wenn die Mail bereits auf Projektebene existiert).

Beispiel:

<?php
 
$mail_ids = "24173:24170:25344";
 
$success = $client_email->crmCopyCommonToProject($session_id, $mail_ids, 638);
 
switch($success) {
  case 0:
       echo "Error copy mails to project";
       break;
    case -1:
       echo "Some of the Mails already exists at project.";
       break;
    case 1:
       echo "Mails successfully copied";
       break;
}




2.80. crmparseMailSource

Syntax:

array crmparseMailSource( string $session_id, string $source, boolean $attachments, boolean $gzip )

Beschreibung:

Liefert eine Array mit nur einem Element eines E-MailObjekts.

source ist die base64-kodiert Mail. Wenn gzip auf 1 gesetzt ist muss die Mail gzencoded sein.

Stellen Sie Attachments auf 1, wenn Sie die Anhänge erhalten möchten.

Stellen Sie gzipauf 1, wenn Sie den Inhalt der E-Mail und Attachments mit GZIP komprimieren möchten.

Eigenschaften (E-Mail):

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
int             $id             Mail-Id
string(255)     $subject        Betreff
string(255)     $from           Von-Addresse
string(65535)   $to             An-Addresse(n)
int             $date           Datum der E-Mail, häufig Datum des Versendens, Unix-Timestamp
boolean         $is_html        E-Mail in HTML gesendet (0 = falsch, 1 = true)
binary          $text           Text-Inhalt, base64-kodiert 
binary          $html           HTML-Inhalt, base64-kodiert
array           $attachments    Array mit Attachment Objekte

Eigenschaften (Attachment):

Typ(Länge)      Eigenschaft     Beschreibung
-------------------------------------------------------------------
string          $name           Name des Anhangs, z. B. picture.jpg
string          $ctype          Content-Type des Anhangs, z. B. image/jpeg
string          $cid            Content-ID, für multipart / related , z. B. eingebettete Objekte
int             $size           Größe des Anhangs in Bytes
binary          $content        Binärer Inhalt des Anhangs, base64-kodiert

Beispiel :

<?php
 
$source	= base64_encode(gzencode($source_str));
$result = $client_email->crmparseMailSource($session_id, $source, 1, 1);
$email	= $result[0];
 
echo "";
echo "From: ".$email->from."<br/>";
echo "Subject: ".$email->subject."<br/>";
echo "To: ".$email->to."<br/>";
echo "Date: ".date("d.m.Y - H:i:s", $email->date)."<br/><br/>";
 
$content = $email->is_html ? gzdecode(base64_decode($email->html)) : gzdecode(base64_decode($email->text));
 
 
foreach ($email->attachments as $attachment) {
     
    $fp = fopen($attachment->name, "w");
    if (!$fp) continue;
    fwrite($fp, gzdecode(base64_decode($attachment->content)));
    fclose($fp); 
 
    if ($attachment->cid && $email->is_html) {
        $content = str_replace('cid:'.$attachment->cid, $attachment->name, $content);
    }
    else {
        echo "Attachment: <a href='{$attachment->name}' target=_blank>".$attachment->name."</a> (".$attachment->size.")<br/>";
    }
}
 
echo $content;



2.81. crmgetMailInfo

Syntax:

array crmgetMailInfo( string $session_id, int $mail_id )

Beschreibung:

Liefert eine Array mit nur einem Element eines E-Mail-Info-Objekts.

Eigenschaften der zurückgegebenen email-info object:

Typ(Länge)      Eigenschaft        Beschreibung
-------------------------------------------------------------------
int             $id             Mail-Id
string(255)     $answered       Wer hat diese Mail beantwortet
string(255)     $forwarded      Adressen zu denen die Mail weitergeleitet wurde
string(255)     $tocontact      Mail wurde gespeichert in Kontakt
string(255)     $toproject      Mail wurde gespeichert in Projekt
string(255)     $toticket       Mail wurde gespeichert in Ticket (Version >= 3.1.2566)
string(255)     $done           Mail wurde als erledigt markiert
string(255)     $flag           Mail wurde markiert

Beispiel:

<?php
 
$mail_info = $client_email->crmgetMailInfo($session_id, 24480);
if (count($mail_info)) $mail_info = $mail_info[0];
 
echo "Mail-Id:          {$mail_info->id}<br>";
echo "Answered:         {$mail_info->answered}<br>";
echo "Forwarded:        {$mail_info->forwarded}<br>";
echo "Saved to contact: {$mail_info->tocontact}<br>";
echo "Saved to project: {$mail_info->toproject}<br>";
echo "Saved to ticket:  {$mail_info->toticket}<br>";
echo "Done:             {$mail_info->done}<br>";
echo "Flag:             {$mail_info->flag}<br>";




2.82. crmgetCommonMailInfo

(Version >= 3.1.2566)

Syntax:

array crmgetCommonMailInfo( string $session_id, int $mail_id )

Beschreibung:

Liefert eine Array mit nur einem Element eines E-Mail-Info-Objekts.

Eigenschaften der zurückgegebenen email-info object:

sind die selben wie für crmgetMailInfo

Beispiel:

<?php
 
$mail_info = $client_email->crmgetCommonMailInfo($session_id, 6624);
if (count($mail_info)) $mail_info = $mail_info[0];
 
echo "Mail-Id:          {$mail_info->id}<br>";
echo "Answered:         {$mail_info->answered}<br>";
echo "Forwarded:        {$mail_info->forwarded}<br>";
echo "Saved to contact: {$mail_info->tocontact}<br>";
echo "Saved to project: {$mail_info->toproject}<br>";
echo "Saved to ticket:  {$mail_info->toticket}<br>";
echo "Done:             {$mail_info->done}<br>";
echo "Flag:             {$mail_info->flag}<br>";




2.83. crmDispositionNotification

Syntax:

boolean crmDispositionNotification( string $session_id, int $mail_id )

Beschreibung:

Sendet Lesebenachrichtigungen. Liefert true bei Erfolg, false im Fehlerfall.

Beispiel:

<?php
 
$success = $client_email->crmDispositionNotification($session_id, 24644);
echo $success ? "true" : "false";




2.84. crmgetPermissions

(Version >= 4.5.17365)

Syntax:

array crmgetPermissions( string $session_id, string $mail_ids ) 

Beschreibung:

Gibt ein Array mit Elementen des Typs crmPermission mit den Berechtigungen für die E-Mails mit den gegebenen $mail_ids zurück.

Setzt eine Lizenz mit Aktivitätenrechten und aktivierte Aktivitätenrechte für dieses Modul voraus.

Im Falle eines Fehlers wird eine SOAPFault mit mehr Fehlerdetails geworfen.

mail_ids ist eine mit Doppelpunkt getrennte Liste der IDs der Anrufe.

Eigenschaften von crmPermission:

Type(Length)	  Eigenschaft                    Beschreibung
-------------------------------------------------------------------------------
int               $id                            E-Mail ID
array             $crmUserPermissionElements     Array mit crmUserPermissionElement Objekte
array             $crmGroupPermissionElements    Array mit crmGroupPermissionElement Objekte

Eigenschaften von crmUserPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Userid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Eigenschaften von crmGroupPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Groupid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert 

Beispiel:

<?php

ini_set("soap.wsdl_cache_enabled", "0");

try {

$client_logon = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");

  $client_emails = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=emails&wsdl");
  $session_id    = $client_logon->crmLogin('test', 'test');
if (!$session_id) die("invalid login");

$result = $client_emails→crmgetPermissions($session_id, '81941:79331');

  print_r($result);
} catch (SOAPFault $f) {

  print $f->faultstring;
}

?>



2.85. crmsetPermissions

(Version >= 4.5.17365)

Syntax:

array crmsetPermissions( string $session_id, array $crmPermissions ) 

Beschreibung:

Setzt die Berechtigungen für mehrere E-Mails.

Setzt eine Lizenz mit Aktivitätenrechten und aktivierte Aktivitätenrechte für dieses Modul voraus.

Im Falle eines Fehlers wird eine SOAPFault mit mehr Fehlerdetails geworfen.

crmPermissions ist ein Array mit crmPermission Objekten.

Eigenschaften von crmPermission:

Type(Length)	  Eigenschaft                    Beschreibung
-------------------------------------------------------------------------------
int               $id                            E-Mail ID
array             $crmUserPermissionElements     Array mit crmUserPermissionElement Objekte
array             $crmGroupPermissionElements    Array mit crmGroupPermissionElement Objekte

Eigenschaften von crmUserPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Userid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Eigenschaften von crmGroupPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Groupid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert 

Beispiel:

<?php

ini_set("soap.wsdl_cache_enabled", "0");

try {

	$client_logon	= new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
	$client_emails	= new SOAPClient("https://test.tecart-system.de/soap/index.php?op=emails&wsdl");
	$session_id 	= $client_logon->crmLogin('test', 'test');
	if (!$session_id) {
		die("invalid login");
	}

	$permissions = array(
		array(
			'id'							=> 81941,
			'crmUserPermissionElements' 	=> array(array('id' => 56, 'read' => 1, 'write' => 1, 'delete' => 1)),
			'crmGroupPermissionElements' 	=> array(array('id' ⇒ 4, 'read' ⇒ -1, 'write' ⇒ -1, 'delete' ⇒ -1))
		),
		array(
			'id'							=> 79331,
			'crmGroupPermissionElements'	=> array(
				array('id' => 4, 'read' => 1, 'write' => 1, 'delete' => 1),
				array('id' => 6, 'read' => -1, 'write' => -1, 'delete' => -1) 
			)
		)
	);
	$client_emails->crmsetPermissions($session_id, array('crmPermissions' => $permissions));
} 
catch (SOAPFault $f) {

	print $f->faultstring;
}

?>
  • No labels