|
<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > JamioPlug > JamioPlug Message > Spedizione tramite posta elettronica transazionale > SendTransactionalEmail |
Invia un'informazione da Jamio openwork ad uno o più corrispondenti tramite trasporto email transazionale.
Metodo
PlugMessage/SendTransactionalEmail
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 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 |
|
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. |
Y |
|
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 |
|
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 |
|
testMode |
True se il messaggio non deve essere inviato realmente. Il valore di default è False. |
Boolean |
|
Descrizione
Il metodo SendTransactionalEmail è utile ad avviare il processo di spedizione tramite trasporto Email Transazionale utilizzando come carrier un indirizzo di posta elettronica 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 email 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;
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.
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.