Input

Nome

Descrizione

Tipo

Opzionale

token

Il token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

tenantId

Identificativo dell'area in cui verrà creata la risorsa Dati, istanza del modello resourceModelReference, con cui tracciare la spedizione del singolo messaggio. Se non valorizzato viene utilizzato l'identificativo dell'area dove disponibile la risorsa template.

String

Y

resourceModelReference

Riferimento al modello della risorsa di tipo Dati da utilizzare per la creazione della risorsa che traccia la spedizione.

Reference

carrier

Riferimento alla casella email da utilizzare per spedizione. Il riferimento può essere il collegamento alla Configurazione o in alternativa un collegamento con proprietà Name valorizzata con il Nickname della Configurazione, URL e Type nulli.

Reference

to

Lista dei destinatari del messaggio email.

La lista deve essere popolata con almeno un collegamento utile al metodo a reperire le informazioni relative al corrispondente e l'indirizzo della spedizione. La lista dei destinatari può essere di tipo collegamento o di tipo collegamento esteso. Se di tipo lista di collegamento, la proprietà Name del collegamento deve corrispondere all'indirizzo di posta elettronica altrimenti sarà generato errore.

Opzionalmente, il collegamento della lista può essere di tipo Collegamento esteso e contenere nella sua definizione i campi che rappresentano il corrispondente e l'indirizzo della spedizione specificati con i parametri correspondentField e addressField. Per ulteriori dettagli consultare l'argomento Logica risoluzione corrispondenti.

List of reference or

List of extended reference

cc

Lista dei destinatari in copia conoscenza del messaggio email.

La lista deve essere popolata con almeno un collegamento utile al metodo a reperire le informazioni relative al corrispondente e l'indirizzo della spedizione. La lista dei destinatari in CC può essere di tipo collegamento o di tipo collegamento esteso. Se di tipo lista di collegamento, la proprietà Name del collegamento deve corrispondere all'indirizzo di posta elettronica altrimenti sarà generato errore.

Opzionalmente, il collegamento della lista può essere di tipo Collegamento esteso e contenere nella sua definizione i campi che rappresentano il corrispondente e l'indirizzo della spedizione specificati con i parametri correspondentField e addressField. Per ulteriori dettagli consultare l'argomento Logica risoluzione corrispondenti.

List of reference or

List of extended reference

Y

bcc

Lista dei destinatari in copia conoscenza nascosta del messaggio email.

La lista deve essere popolata con almeno un collegamento utile al metodo a reperire le informazioni relative al corrispondente e l'indirizzo della spedizione. La lista dei destinatari in BCC può essere di tipo collegamento o di tipo collegamento esteso. Se di tipo lista di collegamento, la proprietà Name del collegamento deve corrispondere all'indirizzo di posta elettronica altrimenti sarà generato errore.

Opzionalmente, il collegamento della lista può essere di tipo Collegamento esteso e contenere nella sua definizione i campi che rappresentano il corrispondente e l'indirizzo della spedizione specificati con i parametri correspondentField e addressField. Per ulteriori dettagli consultare l'argomento Logica risoluzione corrispondenti.

List of reference or

List of extended reference

Y

replyTo

Lista degli indirizzi cui il destinatario della email può rispondere.

List of reference or

List of extended reference

Y

applySignature

Indica se applicare o meno la firma di default al messaggio email, definita in Configurazione. Il valore true applica la firma di default.

Boolean

Y

subject

Oggetto del messaggio email.

String

Y

body

Testo o testo HTML del messaggio email.

String

inputDataset

Dato strutturato che consente di sostituire eventuali placeholder presenti nel testo del messaggio o dell'oggetto.

Il nome dei campi del dato strutturato corrisponde al placeholder (senza ##) e il valore al contenuto da riportare nel subject e nel body del messaggio.

I placeholder devono essere riportati nel subject e nel body con la forma ##Nome Campo## e vengono sostituiti nel messaggio inviato con i rispettivi valori riportati in InputDataSet.

Dataset

Y

messageAttachments

Lista dei file da inviare in allegato al messaggio email, riportata come lista di collegamenti ad allegati di risorse o componenti di documenti.

List of reference

Y

linkedResource

Collegamento ad una eventuale risorsa significativa per la spedizione.

Reference

Y

targetSendingStatus

Obiettivo di monitoraggio per considerare un percorso concluso con successo. Può assumere i valori Processing o Processed. Se non specificato viene valorizzato con Processing.

SendingStatus

Y

correspondentField

Nome del campo del collegamento esteso, appartenente alla lista contenuta nei parametri to, cc o bcc, da utilizzare come corrispondente; se vuoto sono utilizzate le proprietà del collegamento (Name,Type e URL) del collegamento esteso. Se specificato, i valori to, cc o bcc devono essere liste di tipo collegamento esteso.

String

Y

addressField

Nome del campo del collegamento esteso, appartenente alla lista contenuta nei parametri to, cc o bcc, da utilizzare come indirizzo; se vuoto sono utilizzate le proprietà del collegamento (Name,Type e URL) del collegamento esteso. Se specificato, i valori to, cc o bcc devono essere liste di tipo collegamento esteso.

String

Y

fieldMapping

Nome dei campi disponibili nel modello resourceModelReference nei quali, nell'istanza della risorsa che traccia la spedizione del messaggio, devono essere riportati i valori notevoli del messaggio Email (ad esempio Carrier, To, CC, Subject, Body, etc.) .

Il dato strutturato ammette come chiave dei campi i seguenti valori: 'Carrier', 'To', 'CC', 'BCC', 'Subject', 'Body', 'Priority', 'ReplyTo', 'LeadTime', 'ApplySignature', 'CorrespondentField', 'AddressField' and 'MessageAttachments'.

I valori del dato strutturato sono i nomi dei campi nel modello resourceModelReference.

Dataset

Y

resourceFieldValues

Valori da assegnare ai campi della risorsa che sarà creata a partire dal modello resourceModelReference.

La chiave del campo del dato strutturato corrisponde al nome del campo disponibile nel modello resourceModelReference. Il valore del campo corrisponde al valore che si vuole assegnare nel campo della risorsa che traccia la spedizione del messaggio. Se il valore del campo è di un tipo diverso da quello definito nel modello resourceModelReference, sarà eseguita una conversione. Se la conversione del valore nel nuovo tipo non è attuabile, sarà restituito errore. Inoltre se in resourceFieldValues viene specificato un campo che corrisponde ad un campo 'notevole' (per es. "Subject" o "Oggetto", se così rimappato), prevale il valore specificato in resourceFieldValues rispetto ai valori specificati nei parametri specifici (per es. subject o body.)

Dataset

Y

testMode

True se il messaggio non deve essere inviato realmente. Il valore di default è False.

Boolean

Restituisce

Condizione

Errore

Se tra i campi di fieldMapping viene passato un campo diverso da quelli notevoli previsti.

Errore

Se tra i campi di fieldMapping viene passato un campo non presente nel modello resourceModelReference.

Errore

Se tra i campi di resourceFieldValues viene specificato un campo non presente nel modello resourceModelReference.

Errore

Se tra i campi di resourceFieldValues viene specificato un campo presente nel modello resourceModelReference, ma non assegnabile al tipo previsto nel modello.