flexideo

Požadavek test-imap

Požadavek pro ověření funkčnosti a zjištění základních vlastností určitého IMAP serveru.

syntax 
<request>
<test-imap
server="{string}"
config="{string}"
port="{number}"
uid="{number}"
password="{string}"
verbose="{boolean}"
/>
</request>

Atributy

server - Obsahuje název SMTP serveru, host-name nebo IP adresu.(typ: string) TYP HODNOTY: string;

config - Konfigurační parametry, má smysl zadávat pouze text ENC (pokud požadujete šifrování).(typ: string) TYP HODNOTY: string;

port - Číslo portu, pokud je třeba testovat některý konkrétní. Jde o port k jakému se má flexideo připojit, pokud není zadán nebo je 0, otestuje všechny obvyklé porty.(typ: number) TYP HODNOTY: number;

uid - Identifikátor uživatele, při neuvedení je testován pouze server, jeho připojvací vlastnosti a dostupnost. Pokud je uid zadáno, pokusí se flexideo také přihlásit pro ověření správnosti.(typ: number) TYP HODNOTY: number;

password - Heslo uživatele při testování konkrétního uživatele (uid).(typ: string) TYP HODNOTY: string;

verbose - Volba vracení detailnější odpovědi jednotlivých provedených kroků testu.(typ: boolean) TYP HODNOTY: boolean;


Potomci

Požadavek test-imap neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty. Uzel nemá povolen prázdný obsah.


Odpověď

Struktura odpovědi na požadavek test-imap vrácená v obálce response:

syntax 
<response>
<test-imap
status="ok|error"
login-method="LOGIN|PLAIN"
login="{boolean}"
config="{string}"
ip="{string}"
port="{number}"
encryption="none|startls|tls/ssl"
>
<step ... /> ?
</test-imap>
</response>

Atributy

status - Obsahuje hodnoty ok nebo error

Možnosti obsahu:

» ok ~ Požadavek proveden bez chyb.

» error ~ Při provádění požadavku došlo k chybě.

login-method - Doporučený způsob přihlašování(typ: string)

TYP HODNOTY: string;

Možnosti obsahu:

» LOGIN ~ Metoda login

» PLAIN ~ Metoda plain

login - popis neuveden(typ: boolean) TYP HODNOTY: boolean;

config - Doporučené nastavení spojení; struktura parametru konfig je: {{LOGIN|PLAIN}{;STLS|SSL|NOCR}}

ip - IP adresa(typ: string) TYP HODNOTY: string;

port - Číslo portu.(typ: number) TYP HODNOTY: number;

encryption - Indikace šífrování a použité metody.(typ: string)

TYP HODNOTY: string;

Možnosti obsahu:

» none ~ Bez šifrování.

» startls ~ Šifrováno metodou startls.

» tls/ssl ~ Šifrováno metodou tls/ssl.


Potomci


Uzel step

Jeden dílčí test.

syntax 
<step
number="{number}"
severity="error|warning|information|success"
detail="{string}"
/>

Atributy

number - Číslo typu logovací položky.(typ: number) TYP HODNOTY: number;

severity - Charakter logovací položky(typ: string)

TYP HODNOTY: string;

Možnosti obsahu:

» error ~ Došlo k chybě při provádění operace.

» warning ~ Upozornění na existující či potenciální problém.

» information ~ Informativní položka o stavu.

» success ~ Úspěšné provedení operace.

detail - Detailnější popis chyby, upozornění či informace.(typ: string) TYP HODNOTY: string;


Potomci

Uzel step neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty. Uzel nemá povolen prázdný obsah.

Výraz pro identifikaci chyb v odpovědi serveru: test-imap[@status='error'] (odkaz na popis detailu: step/@detail).

Požadavek test-smtpPožadavek test-imapPožadavek send-email