unsubscribe

php

boolean  unsubscribe ( number $newStatus, number $shipmentId )

Funkcja wypisuje obecnie przetwarzany adres z listy subskrybentów oraz aktualizuje jego status dla konkretnej wysyłki na „wypisał się” lub "chce się wypisać".

Uwaga

wymaga adresu

Parametry

W parametrze $newStatus podajemy nowy status, jaki ma zostać przypisany adresowi w bazie danych:

3 - wypisał się.
4 - chce się wypisać

W parametrze $shipmentId podajemy identyfikator wysyłki, dla której status ma zostać zaktualizowany.

Zwracane wartości

Funkcja zwraca wartość logiczną true, jeśli status został poprawnie zaktualizowany. Funkcja zwraca false w sytuacjach, gdy:

Obecny status adresu w bazie jest mniejszy lub równy 4.
Przekazany parametr $newStatus ma nieprawidłową wartość.

Przykład

php


$newStatus = 3;
$shipmentId = 1234;

if (unsubscribe($newStatus, $shipmentId)) {
    print("Adres został pomyślnie wypisany.");
} else {
    print("Nie udało się zmienić statusu (prawdopodobnie adres był już wypisany).");
}

Wynik

Adres został pomyślnie wypisany.

unsubscribe ​

unsubscribe