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

Invia un'informazione da Jamio openwork ad uno o più corrispondenti tramite trasporto PEC.

Metodo

Input
Nome	Descrizione	Tipo	Opzionale
token	Il token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).	String	Y
dataReference	Riferimento della risorsa dati che traccia la spedizione.	Reference
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
messageAttachments	Lista dei file da inviare in allegato al messaggio PEC riportata come lista di reference ad allegati di risorse o componenti di documenti.	List of 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, appartenente alla lista contenuta nei parametri 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, appartenente alla lista contenuta nei parametri 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
transportField	Nome del campo del collegamento esteso, appartenente alla lista contenuta nei parametri to o cc, in cui è indicata la tipologia di trasporto da utilizzare. Se si valorizza tale parametro, il campo dovrà essere presente nel collegamento esteso e valorizzato con un numerico intero riconducibile ad un valore dell'enumerativo Transport, diversamente verrà sollevata un'eccezione.	String	Y
trackProcessingField	Nome del campo del collegamento esteso, appartenente alla lista contenuta nei parametri to o cc, in cui è indicato il tipo di invio della PEC, se True indica che la PEC è interoperabile. Se si valorizza tale parametro, il campo dovrà essere presente nel collegamento esteso, il valore di default è False.	String	Y

Descrizione

Il metodo SendPEC è utile ad avviare il processo di spedizione tramite trasporto PEC utilizzando come carrier un indirizzo di posta elettronica certificata opportunamente configurato. Il metodo prevede in input:

oil riferimento della risorsa Dati che deve tracciare la spedizione;

ola lista degli indirizzi destinatari della spedizione specificati come lista di collegamenti o collegamenti estesi;

ola casella PEC da utilizzare come vettore della spedizione specificata come collegamento alla scheda di configurazione o in alternativa collegamento con valorizzata la sola proprietà Name con l'indirizzo di posta elettronica certificata;

Il metodo imposta sulla risorsa Dati che traccia la spedizione:

•lo stato della spedizione (proprietà SendingStatus) da none a pending, ad indicare che la trasmissione è stata avviata ed è in attesa di essere gestita;

•la percentuale di completamento della spedizione (proprietà SendingProgress) pari a zero;

•la direzione della spedizione (proprietà SendingDirection) pari a 2, ovvero spedizione in uscita.

Il metodo crea un corrispondente (con relative informazioni di CorrespondentInfo) per ogni elemento estratto dalla lista dei destinatari del messaggio PEC e degli eventuali destinatari in CC (parametri to e cc) secondo una logica di risoluzione. Lo stato dei corrispondenti (SendingStatus) viene impostato a pending. Quando:

•i parametri transportField e trackProcessingField non sono valorizzati, inserisce, nella lista dei percorsi di spedizione, un percorso di spedizione per ogni corrispondente, SendingPath, con obiettivo (TargetSendingStatus) Consegnato (Delivered). Eventuali corrispondenti duplicati (ovvero collegamenti con proprietà Name e URL uguali) saranno riportati in lista una sola volta. Se nella lista dei corrispondenti sono specificati collegamenti che possiedono la stessa URL, ma con proprietà Name distinte, il metodo genera un errore;

•il parametro transportField è valorizzato e il parametro trackProcessingField non è valorizzato, se il campo indicato contiene l'enumerativo:

o0, genera un'eccezione;

o1, inserisce nella lista dei percorsi di spedizione un percorso di spedizione, SendingPath, con obiettivo (TargetSendingStatus) Delivered per lo specifico destinatario;

o2, inserisce nella lista dei percorsi di spedizione un percorso di spedizione, SendingPath, con obiettivo (TargetSendingStatus) Sent per lo specifico destinatario;

odiverso da 1 e 2, non definisce alcun percorso di spedizione.

•il parametro trackProcessingField è valorizzato e il parametro transportField non è valorizzato, se il campo assume valore pari a:

oFalse, inserisce nella lista dei percorsi di spedizione un percorso di spedizione, SendingPath, con obiettivo (TargetSendingStatus) Delivered per lo specifico destinatario;

oTrue, inserisce nella lista dei percorsi di spedizione un percorso di spedizione, SendingPath, con obiettivo (TargetSendingStatus) Processed per lo specifico destinatario;

•i parametri trackProcessingField e transportField sono entrambi valorizzati:

ose il campo indicato da TransportField ha valore diverso da 1 o 2, non definisce alcun percorso di spedizione SendingPath, per lo specifico destinatario;

ose il campo indicato da TransportField è valorizzato a 1 e il campo indicato da TrackProcessingField è true, inserisce nella lista dei percorsi di spedizione un percorso di spedizione, SendingPath, con obiettivo (TargetSendingStatus) Processed (PEC interoperabe), per lo specifico destinatario;

ose il campo indicato da TransportField è valorizzato a 1 e il campo indicato da TrackProcessingField è false, inserisce nella lista dei percorsi di spedizione un percorso di spedizione, SendingPath, con obiettivo (TargetSendingStatus) Delivered (PEC non interoperabile), per lo specifico destinatario;

ose il campo indicato da TransportField è valorizzato a 2, inserisce nella lista dei percorsi di spedizione un percorso di spedizione, SendingPath, con obiettivo (TargetSendingStatus) Sent per lo specifico destinatario, il campo indicato da TrackProcessingField viene ignorato.

L'esecuzione del metodo avvia una spedizione pertanto genera:

•un evento di spedizione con proprietà action uguale a StartSend;

•un evento su percorso di spedizione per ogni percorso creato.

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di modifica sulla risorsa che monitora la spedizione.

Stato della risorsa

Il metodo può essere eseguito se la proprietà SendingStatus della risorsa è uguale a None o Pending e non esistono TrackingMessage associati ai SendingPath, diversamente il metodo restituisce un errore.