Docs For 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 PHP4.4
JSON extension vagy PEAR Services_JSON osztály
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

Variable Summary

mixed $api_url

mixed $errors

mixed $fields

mixed $form_id

mixed $json

mixed $list_id

mixed $pass

mixed $status

mixed $url

mixed $user

Method Summary

MailMaster MailMaster (int $list_id, int $form_id, string $user, string $pass)

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

stdClass get ([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])

Variables

mixed $api_url = '' (line 89)

mixed $errors = array(
0 => 'Ismeretlen hiba',
401 => 'Sikertelen authentikáció',
404 => 'Ismeretlen erőforrás',
405 => 'Érvénytelen metódus',
406 => 'Hibás paraméterek',
) (line 96)

mixed $fields = array() (line 48)

mixed $form_id = 0 (line 79)

mixed $json = NULL (line 91)

mixed $list_id = 0 (line 74)

mixed $pass = '' (line 69)

mixed $status = 0 (line 55)

mixed $url = '' (line 57)

mixed $user = '' (line 67)

Methods

Constructor MailMaster (line 117)

Konstruktor.

MailMaster MailMaster (int $list_id, int $form_id, string $user, string $pass)

int $list_id: Listaazonosító
int $form_id: Űrlapazonosító
string $user: Felhasználónév
string $pass: Jelszó

delete (line 189)

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.

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 259)

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.

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.

send_request (line 292)

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 144)

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 feliratkozáskor aktív.

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.

int subscribe (array $fields)

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

unsubscribe (line 164)

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

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 216)

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.

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.