DOCUMENTAÇÃO

Lista E-mail Válido

Chamada: EvListarEmailValido

Esta função tem por objetivo listar E-mail Valido por assunto e/ou data de recebimento e /ou data de entrega e/ou Status.

Formato de entrada:

<?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>
Parâmetro Formato Obrigatório Descrição
EmailValido   S Node para definir os e-mails a serem consultados
IDCliente Numérico S Código do cliente
CNPJCliente Numérico S CNPJ do cliente sem traços, barras ou pontos
Assunto Texto N Assunto ou parte do assunto do e-mail a ser pesquisado. Se o os 6 primeiros bytes da tag ASSUNTO for a constante “{*EVS:XXXXXXX*} será realizada a pesquisa por EVS, uma constante inserida no corpo do e-mail que é removida ao enviar para o destinatário. Serve para que um ID do cliente seja utilizado para posterior localização de EVs no Portal QualiSign.
datarecebimento Numérico N Data inicial da pesquisa no formato DD/MM/AAAA, considerando a data de recebimento do e-mail pela QualiSign.
dataentrega Numérico N Data inicial da pesquisa no formato DD/MM/AAAA, considerando a data de envio do e-mail ao destinatário pela QualiSign
status Texto N

Código do status conforme tabela abaixo:

  • Código 1 - recebido, porém não entregues - 1º ciclo
  • Código 2 - recebido e entregue ao destinatário
  • Código 3 - recebido, porém não entregues - 2º ciclo
  • Código 4 - recebido, porém não entregues - posição final
DetalheAnexo String N

Indica que ser quer receber informações sobre leitura de anexo.

Valores possíveis: S – sim, N-Não.

Caso a opção seja N, não será retornada o Node Anexos

ParGestao Numérico N

Indicativo de filtro por gestão:

0 – filtra e-mails que têm gestão cobrada

N – filtra e-mails que terão gestão cobrada daqui a n meses

Formato de saída:

                                    <?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>
Parâmetro Formato Descrição
EmailValido   Node para definir os E-mails a serem consultados
CodErro Numérico Código de Erro (ver Códigos de Erros do E-mail Válido)
MsgErro Texto Mensagem de Erro
EV   Node para definir o E-mail retornado. Para cada e-mail retornado na consulta um novo node EV será criado. Se nenhum e-mail retornar na consulta não existirá este node.
EmailRemetente Texto Endereço de e-mail do remetente
EmailDestinatario Texto Endereço de e-mail do destinatário
Assunto Texto Assunto do E-mail completo
DataEnviado Texto Data de envio no formato DD/MM/AAAA HH:MM:SS + (HLB)
Entregue Texto S para Entregue ou N para não entregue
DataEntregue Texto Data da entrega do e-mail no formato DD/MM/AAAA HH:MM:SS + (HLB)
TentativasRestantes Texto Quantidade de tentativas que restam na entrega. Se já entregue mostrar 0 (ZERO)
Lido Texto S para e-mail lido pelo destinatário e N para não lido
LidoData1Leitura Texto Data da primeira leitura no formato DD/MM/AAAA HH:MM:SS + (HLB)
Status Texto Status do EmailValido
MensagemErro Texto Mensagem de erro
EVS Texto EVS
SeloClicado Texto S para selo clicado pelo destinatário e N para não clicado
SeloClicadoData1Leitura Texto Data do primeiro clique no selo no formato DD/MM/AAAA HH:MM:SS + (HLB)
EVID Texto ID do E-mail Válido para este e-mail
Anexos   Node para definição de arquivos anexos. Caso não exista, significa que o e-mail não contém arquivos anexos
Anexo   Node para definição do arquivo anexo. Para cada arquivo, um node igual a este será criado
NomeAnexo Texto Nome do arquivo Anexo
AnexoLido Texto S para anexo lido pelo destinatário e N para Não lido.
AnexoLidoData1Leitrua Texto Data da primeira leitura do anexo no formato DD/MM/AAAA HH:MM:SS + (HLB)