mailkit.email.revalidate

Funkce mailkit.email.revalidate znovu přihlásí odhlášeného příjemce.

Tato funkce bude k 31. 12. 2020 zrušena ve prospěch funkce mailkit.mailinglist.adduser, která slouží jako jednotná metoda pro přidávání příjemců do seznamu i pro reaktivaci odhlášených příjemců a umožňuje kompletní parametrizaci konfirmačního procesu.

Ukázka API volání:

JSON 

{  
   "id":"client_id",
   "md5":"client_md5",
   "function":"mailkit.email.revalidate",
   "parameters":{  
      "email":"example@example.cz",
      "language":"CZ",
      "ID_message":"ID_message",
      "ID_email":"ID_email",
      "channel":"channel",
      "agreement":"FALSE"
   }
}

XML 

<?xml version="1.0"?>
<methodCall>
    <methodName>mailkit.email.revalidate</methodName>
    <params>
        <param>
            <value>
                <int>client_id</int>
            </value>
        </param>
        <param>
            <value>
                <string>client_md5</string>
            </value>
        </param>
        <param>
            <value>
                <int>ID_email</int>
            </value>
        </param>
        <param>
            <value>
                <int>ID_message</int>
            </value>
        </param>
        <param>
            <value>
                <boolean>agreement</boolean>
            </value>
        </param>
        <param>
            <value>
                <string>channel</string>
            </value>
        </param>
        <param>
            <value>
                <int>dummy</int>
            </value>
        </param>
        <param>
            <value>
                <string>language</string>
            </value>
        </param>
    </params>
</methodCall>

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil/Integrace.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil/Integrace.
ID_email * = Pro XML volání může obsahovat buď konkrétní ID e-mailu (vrací např. funkce mailkit.mailinglist.adduser), nebo e-mailovou adresu.
email * = emailová adresa
V JSON volání může být použit bud parametr email, nebo parametr ID_email.
ID_message = ID kampaně, volitelný parametr. Z šablony této kampaně bude použit Soubor šablony přihlašovacího e-mailu - vzhled a obsah ověřovacího e-mailu, který bude zaslán znovu přihlašovanému příjemci.
ID_template = ID šablony, volitelný parametr, pouze u JSON. Z této šablony bude použit Soubor šablony přihlašovacího e-mailu - vzhled a obsah ověřovacího e-mailu, který bude zaslán znovu přihlašovanému příjemci.
agreement * = může nabývat hodnot TRUE / FALSE

  • TRUE = příjemce souhlasil se znovuzařazením do mailing listu. Nebude mu zaslán žádný další potvrzovací e-mail. Do parametru channel se může uložit, jakou cestou se příjemce znovu přihlásil (např. telefon)
  • FALSE = příjemci bude zaslán e-mail s verifikačním linkem a do seznamu bude znovu přidán až po kliknutí na ověřovací link (defaultní hodnota)

channel = kanál, jakým přišel souhlas s rozesíláním. V případě, že proměnná souhlas má hodnotu FALSE se doplní po přijetí potvrzení IP adresa.
dummy = prázdná hodnota, nutné zasílat pro zpětnou kompatibilitu (pouze pro XML)
language = jazyk, ve kterém má být příjemci zaslán e-mail s verifikačním linkem. Možné hodnoty jsou: cs, en
* povinný parametr

Po úspěšném volání se vrací:

JSON 

{
    "email": "email@example.cz",
    "error_status": 0,
    "ID_email": "123456789",
    "error": "Sent subscribe email"
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>Sent subscribe email</string>
      </value>
    </param>
  </params>
</methodResponse>

Hodnoty

Sent subscribe email = na daný e-mail byla zaslána zpráva s verifikačním linkem (JSON)
Email has been revalidated = e-mail byl znovupřihlášen (JSON)

Příklad neúspěšného volání:

JSON 

{
    "error_status": 0,
    "ID_email": "123456789",
    "error": "Email is not unsubscribed",
    "email": "sample@samplemail.com"
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>example@example.cz is not unsubscribed</string>
      </value>
    </param>
  </params>
</methodResponse>

Hodnoty

Email is not unsubscribed = e-mail není odhlášený, nelze ho tedy znovu přihlásit
Invalid ID_email or email = neplatné ID-email nebo e-mailová adresa