DOCUMENTATION

List Valid Email

Name:EvListarEmailValido

This function is intended to list Valid Email by subject and/or date of receipt and/or date of delivery and/or Status.

Input format: 

<?xml version="1.0" encoding="ISO-8859-1" ?> 
<EmailValido>
        <IDCliente>999</IDCliente>
        <CNPJCliente>99999999999999</CNPJCliente>
        <Assunto>{*EVS:minhachave*}XXXX</Assunto> 
        <datarecebimento>XX</datarecebimento>
        <dataentrega>XX</dataentrega>
        <status>XX</status>
        <DetalheAnexo>XX</DetalheAnexo>
        <ParGestao>XX</ParGestao>    
</EmailValido>
Parameter Format Required Description
EmailValido   Y Node to define emails to be queried
IDCliente Numeric Y Client code
CNPJCliente Numeric Y CNPJ of the client without dashes, bars or dots
Assunto Text N Subject or part of the subject of the email to be searched. If the first 6 bytes of the SUB tag is the constant "{* EVS: XXXXXXX *} the EVS search will be performed, a constant entered in the body of the email that is removed when sending to the recipient. The purpose is to use a client ID for subsequent location of EVs in the QualiSign Portal.
datarecebimento Numeric N Initial search date in DD/MM/YYYY format, considering the data received from the email by QualiSign.
dataentrega Numeric N Initial search date in DD/MM/YYYY format, considering the date of sending the email to the recipient by QualiSign
status Text N Status code as per table below:
  • Code 1 - received, but not delivered – 1st cycle
  • Code 2 – received and delivered to recipient
  • Code 3 – received,but not delivered-  2nd cycle  
  • Code 4 – received,but not delivered-  final position  
DetalheAnexo String N Indicates that you want to receive attachment reading information.

Possible values: S - Yes, N - No.

If the option is N, the Attachments Node is not returned
ParGestao Numeric N Filter by management code:

0 - filters emails that have management charged

N - filter emails that will have management charged in n months

Output format: 

                                    <?xml version="1.0" encoding="ISO-8859-1" ?> 
<EmailValido>
    <CodErro></CodErro>
    <MsgErro></MsgErro>
    <EV>
        <EmailRemetente></EmailRemetente>
        <EmailDestinatario></EmailDestinatario>
        <Assunto></Assunto>
        <DataEnviado></DataEnviado>
        <Entregue></Entregue>
        <DataEntregue></ DataEntregue>
        <TentativasRestantes></TentativasRestantes>
        <Lido></Lido>
        <LidoData1Leitura></LidoData1Leitura>
        <Status></Status>
        <MensagemErro></MensagemErro>
        <EVS></EVS>
        <SeloClicado></SeloClicado>
        <SeloClicadoData1Leitura></SeloClicadoData1Leitura>
        <EVID></EVID>
        <EV_TamMsg></EV_TamMsg>
            <Anexos>
                <Anexo>                                
                    <NomeAnexo></NomeAnexo>
                    <AnexoLido></AnexoLido>
                    <AnexoLidoData1Leitura></AnexoLidoData1Leitura>
                </Anexo>
            </Anexos>
    </EV>
</EmailValido>
Parameter Format Description
EmailValido   Node to define emails to be queried
CodErro Numeric Error Code (See Valid Email Error Codes)
MsgErro Text Error message
EV   Node to define emails to be queried.For each email returned in the query a new EV node will be created. If no email returns in the query, this node will not exist.
EmailRemetente Text Sender's email address
EmailDestinatario Text Recipient's email address
Assunto Text Full email Subject
DataEnviado Text Send date in DD/MM/YYYY HH:MM:SS + (HLB) format
Entregue Text S for delivered or N for not delivered
DataEntregue Text Date of delivery of the email in DD/MM/YYYY HH:MM:SS + (HLB) format
TentativasRestantes Text The amount of attempts remaining in the descending delivery. If already delivered show 0 (ZERO)
Lido Text S for email read by recipient and N for unread
LidoData1Leitura Text Date of first reading in DD/MM/YYYY HH:MM:SS + (HLB) format
Status Text Valid Email status
MensagemErro Text Error Message
EVS Text EVS
SeloClicado Text S for stamp clicked by recipient and N for not clicked
SeloClicadoData1Leitura Text Date of first stamp in DD/MM/YYYY HH:MM:SS + (HLB) format
EVID Text Valid Email ID for this email
Anexos   Node for defining attached files. If it does not exist, it means that the email does not contain any attachments
 Anexo   Node for attachment file definition. For each file, a node like this will be created.
NomeAnexo Text Attachment Filename
AnexoLido Text S for attachment read by recipient and N for unread.
AnexoLidoData1Leitura Text Date of the first reading of the attachment in DD/MM/YYYY HH:MM:SS + (HLB) format
Back to Audit Log Inquiry Send Valid Email