Docs For Class MailMaster

Class MailMaster

Description

MailMaster REST API.

A MailMaster REST API egy részének példa megvalósítása. Az kód szabadon felhasználható és módosítható. Az osztály jelenleg a következő API funkciókat valósítja meg:

subscribe
unsubscribe
list
update
delete

Használatához szükséges

legalább PHP5.2
JSON extension
cURL extension

Példa

$mailmaster = new MailMaster($list_id, $form_id, $user, $passw);
$fields = $db->get_row($query);
$mailmaster->fields = array('mail' => 'email', 'login' => 'user_name');
$row_id = $mailmaster->subscribe($fields);
$mailmaster->update($row_id, array('email' => 'foo@bar.com',));
$mailmaster->update('foo@bar.com', array('user_name' => 'foo',));
$mailmaster->update('user_name', 'bar', array('user_name' => 'foo'));
$list = $mailmaster->get();
$address = $mailmaster->get($row_id);
$address = $mailmaster->get('foo@bar.com');
$address = $mailmaster->get('user_name', 'foo');

author: Balogh Tibor <balti@aion.hu>
copyright: AionNext Kft. http://aion.hu
license: GPLv3

Method Summary

int delete (mixed $field, [mixed $value = NULL])

stdClass get ([mixed $field = NULL], [mixed $value = NULL])

stdClass list ([mixed $field = NULL], [mixed $value = NULL])

mixed send_request (string $url, [array $data = NULL], [string $method = 'POST'])

int subscribe (array $fields)

int unsubscribe (mixed $field, [mixed $value = NULL])

int update (mixed $field, mixed $value, [array $fields = NULL])

Methods

delete (line 220)

Felhasználó törlése.

A megadott felhasználó tényleges törlése a címlistáról. A metódus többféle paraméterrel is meghívható.

$mm->delete(52);
$mm->delete('bar@company.com');
$mm->delete('name', 'Csepregi Balázs');

return: 0 - sikertelen, 1 - sikeres törlés.
access: public

int delete (mixed $field, [mixed $value = NULL])

mixed $field: Int - címlista sorazonosító, String - emailcím vagy String - mezőnév.
mixed $value: Mezőnév megadásakor a mező értéke, egyébként elhagyandó.

get (line 302)

Cím vagy címlista lekérése.

A metódus visszaadja a teljes címlistát vagy a címlista kért rekordját. A metódus alias neve: list, többféle paraméterrel is meghívható.

$mm->get();
$mm->get('foo@company.com');
$mm->get('email', 'foo@company.com');
$mm->get(12);
$mm->get('id', 12);
$mm->get('name', 'Csepregi Balázs');

return: A rekord jellemzői, hiba esetén NULL.
access: public

stdClass get ([mixed $field = NULL], [mixed $value = NULL])

mixed $field: Int - Címazonosító, String - emailcím vagy String - mezőnév.
mixed $value: Mezőnév esetén az érték, ami alapján azonosítani lehet a kért rekordot.

list (line 281)

Cím vagy címlista lekérése.

A get metódus aliasa.

return: A rekord jellemzői, hiba esetén NULL.
see: MailMaster::get()
access: public

stdClass list ([mixed $field = NULL], [mixed $value = NULL])

mixed $field: Int - Címazonosító, String - emailcím vagy String - mezőnév.
mixed $value: Mezőnév esetén az érték, ami alapján azonosítani lehet a kért rekordot.

send_request (line 335)

Kérés küldése.

Kérés küldése a MailMaster szerver felé.

return: A válasz json dekódolt része.
access: protected

mixed send_request (string $url, [array $data = NULL], [string $method = 'POST'])

string $url: Kért erőforrás azonosító.
array $data: Küldendő adatok.
string $method: A kérés típusa, GET, POST, DELETE stb. NULL küldendő adat esetén mindig GET.

subscribe (line 175)

Feliratkozás.

Címadatok küldése a címlistára. Az 'email' mező megadása kötelező a feliratkozás megadásához. A rekord a feliratkozáskor aktív.

$mm->subscribe(array('email' => 'foo@company.com'));
$mm->subscribe(array(
'email' => 'foo@company.com',
'name' => 'Csepregi Balázs',
));

return: A rekord azonosítója, hiba esetén: -1 - létező emailcím, -2 - hibás email, 0 - egyéb hiba, NULL - hibás művelet.
access: public

int subscribe (array $fields)

array $fields: Név-érték párok.

unsubscribe (line 195)

Leíratkozás.

Az adott felhasználó inaktívvá tétele a címlistában. A metódus többféle paraméterrel is meghívható.

$mm->unsubscribe(52);
$mm->unsubscribe('foo@company.com');
$mm->unsubscribe('name', 'Csepregi Balázs');

return: 0 - sikertelen, 1 sikeres leiratkozás.
access: public

int unsubscribe (mixed $field, [mixed $value = NULL])

mixed $field: Int - címlista címazonosító, String - emailcím vagy String - mezőnév.
mixed $value: Mezőnév megadásakor a mező értéke, egyébként elhagyandó.

update (line 247)

Címlista rekordok módosítása.

A metódus az azonosított rekordban módosítja az átadott mezőket. A megadott paramétereknek pontosan egy rekordot kell azonosítaniuk.

A metódus többféle paraméterrel is meghívható.

$mm->update(52, array('email' => 'foo@company.com'));
$mm->update('bar@company.com', array('email' => 'foo@company.com'));
$mm->update('name', 'Csepregi Balázs', array('email' => 'foo@company.com'));

return: A módosított rekorodk száma, hiba esetén NULL.
access: public

int update (mixed $field, mixed $value, [array $fields = NULL])

mixed $field: Int - címlista sorazonosító, String - emailcím vagy String - mezőnév.
mixed $value: Mezőnév megadásakor, a mező értéke, egyébként elhagyható.
array $fields: Módosítandó név-érték párok.

Documentation generated on Sat, 28 May 2011 16:33:53 +0200 by phpDocumentor 1.4.3