GetMailReportByCatalog

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Message >

GetMailReportByCatalog

Restituisce un report contenente l'elenco dei tracking message a partire da un catalogo di pec o email inviate.

 

Metodo

PlugMessage/GetMailReportByCatalog

 

Input

Nome

Descrizione

Tipo

Opzionale

token

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

String

Y

reference

Collegamento al catalogo che contiene i dati da esportare.

Reference

 

parameters

Parametri di filtro da applicare al catalogo, eventuali valori impostati per la paginazione vengono ignorati.

SearchParameters

Y

uncompressed

Indica se il file restituito deve essere compresso. Il valore False determina la restituzione del file compresso.

Boolean

Y

Output

 

Nome

Descrizione

Tipo

 

returnValue

Collegamento al file contenente i dati esportati.

Reference

 

 

Commenti

Il metodo produce in output un file CSV contenente una riga per ogni percorso di spedizione di ogni messaggio di posta inviata. Il file restituito presenta le seguenti intestazioni:

ResourceReference: collegamento (URL) alla risorsa di tipo Dati che rappresenta la spedizione;

Id: codice della spedizione;

Start: data di avvio del percorso di spedizione;

Sender: indirizzo del mittente;

Transport: tipo di trasporto (solo email o PEC);

Correspondent: nome del destinatario;

RecipientAddress: indirizzo del destinatario;

RecipientType: può assumere i valori "TO", "CC", "BCC" o "N/A";

AddressType: tipo di indirizzo del destinatario, può assumere i valori "Certified" o "Not certified"  o "N/A";

SendingStatus: stato della spedizione (SendingStatus);

TrackingStatus: migliore stato del tracciamento della spedizione sullo specifico percorso (TrackingStatus);

StatusDate: data del migliore stato raggiunto dal TrackingMessage.

 

Se nel catalogo sono presenti delle risorse di tipo Dati che non rappresentano messaggi in uscita o non hanno SendingPath o hanno SendingPath con trasporto diverso da pec e mail vengono ignorati.