flexideo

Požadavek send-email

Požadavek pro odeslání e-mailu pomocí prostřednictvím poštovního serveru nastaveného v uživatelském profilu protokolem SMTP.

Požadavek pro odeslání e-mailu pomocí prostřednictvím poštovního serveru nastaveného v uživatelském profilu protokolem SMTP.

syntax 
<request>
<send-email
profile="{number}"
folder="{string}"
all-or-nothing="{boolean}"
verbose="{boolean}"
>
<{element} ... > ... </{element}>*
</send-email>
</request>

Atributy

profile - Číslo (pdk) požadovaného profilu (x_mail_profile)(typ: number) TYP HODNOTY: number;

folder - IMAP složka, kam má být případně zpráva po odeslání uložena (např. »/Sent Items« nebo »/[sent]«) . Při neuvedení se zpráva do schránky neukládá.(typ: string) TYP HODNOTY: string;

all-or-nothing - Je-li nastaven na hodnotu true pak, pokud se u jednoho z příjemců vyskytne chyba, je odesílání emailu zastaveno - není tedy odeslán ani ostatním příjemcům. Je-li v těle požadavku send-email uvedeno více potomků email, tato chyba se jich nedotýká - tyto jsou tedy řádně odeslány. Volba all-or-nothing se tedy vztahuje ke každému odesílanému emailu jednotlivě, nikoli k celé odesílané skupině.(typ: boolean) TYP HODNOTY: boolean;

verbose - Uvádět v odpovědi jednotlivé příjemce.(typ: boolean) TYP HODNOTY: boolean;


Potomci

Požadavek send-email umožňuje uvést nepovinný, ale opakovatelný element - Uzly email s jednotlivými zprávami


Poznámka k request

Popis struktury uzlu email s obsahem e-mailových zpráv viz. popis asi:email.


Odpověď

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

syntax 
<response>
<send-email
status="ok|error"
>
<email ... /> *
</send-email>
</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ě.


Potomci


Uzel email

Uzel s informací o odeslání e-mailu na vstupu požadavku.

syntax 
<email
store="failed|append|stored"
mkey="{number}"
msg-id="{number}"
status="ok|error"
dkey="{string}"
/>

Atributy

store - Indikace uložení zprávy pomocí IMAP, pokud je požadováno; Možnosti: »faild« - selhání při komunikaci s IMAP serverem; »append« - zpráva úspěšně přidána pomocí IMAP do složky poštovního serveru; »stored« - momentálně se nepodařilo přidat do složky, zpráva byla zaznamenána k dodatečnému přidání do IMAP složky;(typ: string) TYP HODNOTY: string; (možnosti obsahu: failed | append | stored)

mkey - Interní (flexideo) celočíselný identifikátor zprávy.(typ: number) TYP HODNOTY: number;

msg-id - Alfanumerický identifikátor zprávy sdílený s IMAP uložištěm.(typ: number) TYP HODNOTY: number;

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ě.

dkey - klíč dokumentu - Celočíselný klíč dokumentu nebo řetězec se znakem '#' pro nové instance.(typ: string)


Potomci

Uzel email neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.

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

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