SendPECAdvanced

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Message > Spedizione tramite trasporto PEC >

SendPECAdvanced

Invia un'informazione da Jamio openwork ad uno o più corrispondenti tramite trasporto PEC. A differenza del metodo SendPEC, utilizza specifiche informazioni per creare preventivamente la risorsa Dati necessaria per l'avvio della spedizione.

Il metodo è utile per supportare casi di invio massivo, in cui le risorse sono simili a livello tipologico ma si differenziano per il contenuto informativo.

 

Metodo

PlugMessage/SendPECAdvanced

 

Input

Nome

Descrizione

Tipo

Opzionale

token

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

String

Y

resourceModelReference

Riferimento al modello, personalizzato con il tipo Dati, da utilizzare per creare la risorsa con cui tracciare la spedizione del singolo messaggio. Il Name della risorsa creata viene posto di default uguale all'oggetto del messaggio PEC inviato.

E' possibile specificare il nome dei campi disponibili nel modello che rappresentano i valori notevoli del messaggio PEC (ad esempio Carrier, To, CC, Subject, Body, etc.) tramite il parametro resourceFieldMapping.

Reference

 

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

carrier

Riferimento alla casella PEC da utilizzare per spedizione.

Il riferimento può essere il collegamento alla scheda di configurazione della casella PEC o in alternativa un collegamento con proprietà Name valorizzata con l'indirizzo di posta elettronica certificata e URL e Type nulli.

Reference

 

to

Lista dei destinatari del messaggio PEC.

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

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

subject

Oggetto del messaggio PEC.

String

Y

body

Testo o testo HTML del messaggio PEC.

String

Y

priority

Priorità da assegnare al messaggio PEC. I valori possibili (-1,0,1).

Integer

Y

replyTo

Lista degli indirizzi cui il destinatario può rispondere.

List of reference or

List of extended reference

Y

leadTime

Tempo massimo, espresso in numero di ore, per il completamento del percorso di spedizione, trascorso il quale, in caso di mancato completamento, viene generato un evento di timeout percorso spedizione. Questo parametro sovrascrive quanto specificato di default per la casella PEC. Il valore 0 indica che non viene applicato un leadTime.

Integer

Y

applySignature

Indica se applicare o meno la firma di default al messaggio PEC. Il valore true applica la firma di default.

Boolean

Y

correspondentField

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

String

Y

addressField

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

String

Y

messageAttachments

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

List of reference

Y

inputDataset

Placeholder e corrispondenti valori utili a valorizzare il testo contenuto nei campi subject e body. Il nome dei campi del dato strutturato corrisponde al placeholder (senza ##) e il valore al contenuto da riportare nel subject e nel body del template.

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

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 PEC (ad esempio Carrier, To, CC, Subject, Body, etc.) .

Il dato strutturato ammette come chiave dei campi i seguenti valori: 'Carrier', 'To', 'CC', 'Subject', 'Body', 'Priority', 'ReplyTo', 'LeadTime', 'ApplySignature', 'CorrespondentField', 'AddressField' e 'AttachmentList'. 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

Output

Nome

Descrizione

Tipo

Opzionale

returnValue

Riferimento della risorsa Dati che traccia la spedizione del messaggio PEC.

Reference

 

 

Commenti

Il metodo SendPECAdvanced richiama il metodo SendPEC per inviare un messaggio PEC, costruendo il contenuto del messaggio a partire dalle informazioni in input al metodo. Inoltre crea in automatico la risorsa che traccia la spedizione delle informazioni a partire dal modello specificato in resourceModelReference. Nel creare la risorsa che traccia la spedizione del messaggio PEC, è possibile valorizzare dei dati in input, che possono essere dati in input e/o recuperati dalle informazioni specifiche del messaggio. Per quanto attiene gli allegati essi vengono sempre memorizzati nella risorsa Dati che traccia la spedizione, potrebbero essere referenziati da un controllo lista di reference se viene passato il campo di mapping 'AttachmentLis't nel parametro fieldMapping.

 

Il metodo si comporta come segue:

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.

 

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di creazione e il permesso di modifica sulla risorsa che deve essere istanziata per monitorare la spedizione.