Métodos do conector de e-mail

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 6 min. de leitura

    • Os métodos no Conector de e-mail recuperam, enviam e respondem a mensagens de e-mail e podem baixar anexos. Use o método SetConfig primeiro para configurar a conexão com o servidor de e-mail.

    Use o método SetConfig para configurar as propriedades do servidor de e-mail e as credenciais de acesso. Este método deve preceder todos os outros métodos do conector de e-mail na automação.

    O método GetMails recupera mensagens do servidor de e-mail e as passa para outros métodos como um objeto que contém uma ou mais mensagens. Os métodos ReadMail, ReplyMail e SaveAllAttachments operam em uma única mensagem de cada vez. Quando esses métodos recebem um objeto que contém mais de uma mensagem, a automação deve usar um método Para cada ou Para loop para iterar cada mensagem na coleção.

    Definir configuração

    Configura a conexão com o servidor de e-mail para que a automação possa funcionar com mensagens.
    Nota:
    Você deve executar este método antes de executar qualquer outro método no conector de e-mail.

    Para obter informações sobre como definir os parâmetros, consulte Configurar propriedades da porta.

    Tabela 1. Parâmetros do método SetConfig
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório? Anotações
    Nome do usuário Nome de usuário para fazer login no servidor de e-mail Entrada de dados Cadeia de caracteres (nenhum) Sim
    Senha Senha para fazer login no servidor de e-mail Entrada de dados Cadeia de caracteres (nenhum) Sim
    UseDefaultCredentials Envia as credenciais padrão do usuário conectado no momento para o servidor SMTP. Entrada de dados Booliano Falso Não
    SmtpMailServer Nome do servidor SMTP Entrada de dados Cadeia de caracteres smtp.gmail.com Não O acesso ao Gmail usando o conector de e-mail não é compatível no momento. Certifique-se de alterar o valor padrão.
    ImapMailServer Nome do servidor IMAP Entrada de dados Cadeia de caracteres imap.gmail.com Não O acesso ao Gmail usando o conector de e-mail não é compatível no momento. Certifique-se de alterar o valor padrão.
    SSL Usar o protocolo Secure Socket Layer Entrada de dados Booliano Verdadeiro Não
    SmtpPort Número da porta SMTP Entrada de dados Números inteiros 587 Não
    ImapPort Número da porta IMAP Entrada de dados Números inteiros 993 Não

    GetMails

    Retorna mensagens do servidor de e-mail para uso por outros métodos. Você pode definir o método para recuperar mensagens lidas (vistas) ou não lidas (não vistas) e especificar a pasta em que elas estão coletadas.

    Para obter informações sobre como definir os parâmetros, consulte Configurar propriedades da porta.

    Tabela 2. Parâmetros do método GetMails
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório? Anotações
    FolderName Nome da pasta IMAP em que o método busca a coleção (por exemplo, Caixa de entrada) Dados em Cadeia de caracteres Caixa de entrada Sim Para especificar uma pasta IMAP aninhada, insira a hierarquia de pastas usando barras invertidas (por exemplo, Projeto\Reuniões)
    Filtro Defina para obter somente mensagens não lidas (Não vistas) ou lidas (Visto) Dados em FilterMode Não visto Sim
    Retornar Retorna a coleção de e-mails como um objeto Saída de dados Objeto Objeto Sim

    Marcar como lido

    Marca mensagens de uma pasta especificada como lidas.

    Para obter informações sobre como definir os parâmetros, consulte Configurar propriedades da porta.

    Tabela 3. Parâmetros do método MarkAsRead
    Parâmetro Descrição Tipo da porta Tipo de dados Valor padrão Obrigatório? Anotações
    MailObject O objeto de e-mail com base no qual a mensagem correspondente é marcada como lida Dados em Objeto Objeto Sim
    FolderName Nome da pasta IMAP em que o objeto de e-mail é obtido Dados em Cadeia de caracteres Caixa de entrada Sim Para especificar uma pasta IMAP aninhada, insira a hierarquia de pastas usando barras invertidas (por exemplo, Projeto\Reuniões)

    Marcar como Não Lido

    Marca mensagens de uma pasta especificada como não lidas.

    Para obter informações sobre como definir os parâmetros, consulte Configurar propriedades da porta.

    Tabela 4. Parâmetros do método MarkAsRead
    Parâmetro Descrição Tipo da porta Tipo de dados Valor padrão Obrigatório? Anotações
    MailObject O objeto de e-mail com base no e-mail correspondente que está marcado como não lido. Dados em Objeto Objeto Sim
    FolderName Nome da pasta IMAP em que o objeto de e-mail é obtido. Dados em Cadeia de caracteres Caixa de entrada Sim Para especificar uma pasta IMAP aninhada, insira a hierarquia de pastas usando barras invertidas (por exemplo, Projeto\Reuniões)

    ReadMail

    Lê uma mensagem e retorna seus detalhes, incluindo assunto, corpo, remetente (de), destinatários no campo CC, destinatários no campo Cco e o número de anexos.

    Para obter informações sobre como definir os parâmetros, consulte Configurar propriedades da porta.

    Tabela 5. Parâmetros do método ReadMail
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    MailObject MailObject que fornece os detalhes da última mensagem recebida Dados em Objeto Objeto Sim
    Assunto Assunto da mensagem Saída de dados Cadeia de caracteres Nenhum(a) Não
    Corpo da mensagem Corpo da mensagem Saída de dados Cadeia de caracteres Nenhum(a) Não
    Remetente Remetente da mensagem Saída de dados Cadeia de caracteres Nenhum(a) Não
    Cc Destinatários marcados em CC Saída de dados Cadeia de caracteres Nenhum(a) Não
    Cco Destinatários marcados em Cco Saída de dados Cadeia de caracteres Nenhum(a) Não
    Contagem de anexos Número de anexos na mensagem Saída de dados Números inteiros Nenhum(a) Não

    Responder e-mail

    Responde automaticamente a uma mensagem. Use os parâmetros para definir o corpo da mensagem e outros detalhes. Você pode incluir anexos.

    Para obter informações sobre como definir os parâmetros, consulte Configurar propriedades da porta.

    Tabela 6. Parâmetros do método ReplyMail
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório? Anotações
    MailObject Objeto de mensagem que contém os detalhes da mensagem Dados em Objeto Objeto Sim
    Responder a todos Responde a todos os destinatários nos campos Para e CC da mensagem Dados em Booliano Falso Não
    Cco Responde a todos os destinatários no campo Cco da mensagem Dados em Cadeia de caracteres Nenhum(a) Não
    Corpo da mensagem Corpo da mensagem de resposta Dados em Cadeia de caracteres Nenhum(a) Não
    IsHtmlBody Opção para indicar se o corpo da resposta está no formato HTML Dados em Booliano Falso Não
    Anexos Anexos à mensagem de resposta Dados em Cadeia de caracteres Nenhum(a) Não Para anexar um arquivo:
    1. Cole o caminho para o arquivo no campo.
    2. Remova as aspas que delimitam o caminho.

    Para incluir vários anexos, separe os caminhos por vírgulas.

    SalvarTodosAnexos

    Salva todos os anexos de uma mensagem na unidade local.

    Para obter informações sobre como definir os parâmetros, consulte Configurar propriedades da porta.

    Tabela 7. Parâmetros do método "SaveAllAttachments"
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório?
    MailObject Mensagem da qual o método baixa os anexos Entrada de dados Objeto Objeto Sim
    FolderPath Caminho do diretório para o qual os anexos são baixados Entrada de dados Cadeia de caracteres Nenhum(a) Sim

    SendMail

    Envia uma mensagem. Use os parâmetros para definir o corpo da mensagem e outros detalhes. Você pode incluir anexos.
    Nota:
    Use o método SetConfig para definir o endereço De.

    Para obter informações sobre como definir os parâmetros, consulte Configurar propriedades da porta.

    Tabela 8. Parâmetros do método SendMail
    Parâmetro Descrição Tipo de porta de dados Tipo de dados Valor padrão Obrigatório? Anotações
    Para endereço Endereço para o qual a mensagem será enviada Dados em Cadeia de caracteres Nenhum(a) Sim
    Cc Endereços a serem incluídos no campo CC Dados em Cadeia de caracteres Nenhum(a) Não
    Cco Endereços a serem incluídos no campo Cco Dados em Cadeia de caracteres Nenhum(a) Não
    Assunto Assunto da mensagem Dados em Cadeia de caracteres Nenhum(a) Não
    Corpo da mensagem Corpo da mensagem Dados em Cadeia de caracteres Nenhum(a) Não
    IsHtmlBody Opção para indicar se o corpo da resposta está no formato HTML Dados em Cadeia de caracteres Falso Não
    Anexos Anexos de mensagem Dados em Cadeia de caracteres Nenhum(a) Não Para anexar um arquivo:
    1. Cole o caminho para o arquivo no campo.
    2. Remova as aspas que delimitam o caminho.

    Para incluir vários anexos, separe os caminhos por vírgulas.