SendEmail

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Message > Spedizione tramite posta elettronica >

SendEmail

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

 

Metodo

PlugMessage/SendEmail

 

Input

Nome

Descrizione

Tipo

Opzionale

token

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

String

Y

dataReference

Riferimento della risorsa dati che traccia la spedizione.

Reference

 

carrier

Riferimento alla casella di posta elettronica da utilizzare per la spedizione. Il riferimento può essere il collegamento alla scheda di configurazione della casella di posta ordinaria o in alternativa un collegamento con proprietà Name valorizzata con l'indirizzo di posta elettronica, URL e Type nulli.

Reference

 

to

Lista dei destinatari del messaggio di posta elettronica.

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. 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 di posta elettronica.

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. Per ulteriori dettagli consultare l'argomento Logica risoluzione corrispondenti.

List of reference or

List of extended reference

Y

bcc

Lista dei destinatari nascosti non mostrati ai destinatari principali del messaggio di posta elettronica.

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 CCN 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. Per ulteriori dettagli consultare l'argomento Logica risoluzione corrispondenti.

List of reference or

List of extended reference

Y

subject

Oggetto del messaggio di posta elettronica.

String

 

body

Testo o testo HTML del messaggio di posta elettronica.

String

 

priority

Priorità da assegnare al messaggio di posta elettronica. 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 di posta elettronica 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 SendingPathTimeoutEvent. Questo parametro sovrascrive quanto specificato di default per la casella di posta elettronica. Il valore 0 indica che non viene applicato un leadTime.

Integer

Y

applySignature

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

Boolean

Y

correspondentField

Nome del campo del collegamento esteso, di to o cc o bcc, da utilizzare come corrispondente; se vuoto sono utilizzate le proprietà del collegamento (Name,Type e URL) del collegamento esteso.

String

Y

addressField

Nome del campo del collegamento esteso, di to o cc o bcc, da utilizzare come indirizzo; se vuoto sono utilizzate le proprietà del collegamento (Name,Type e URL) del collegamento esteso.

String

Y

 

Descrizione

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

il riferimento della risorsa Dati che deve tracciare la spedizione;

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

la casella di posta elettronica 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.

 

Il metodo crea:

un corrispondente (con relative informazioni di CorrespondentInfo) per ogni elemento estratto dalla lista dei dei destinatari del messaggio di posta elettronica e degli eventuali destinatari in CC e BCC secondo una logica di risoluzione determinata. Lo stato dei corrispondenti (SendingStatus) è impostato a pending. Per ogni corrispondente inserisce nella lista dei percorsi di spedizione un percorso di spedizione, SendingPath, con obiettivo (TargetSendingStatus) Inviato (Sent). 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.

 

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 Dati che traccia la spedizione.

 

Stato della risorsa

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