Microsoft Métodos do conector do Outlook

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

    • Os métodos do conector Microsoft do Outlook automatizam várias ações no Microsoft Outlook. Em um fluxo de automação, os métodos são conectados a outros métodos e componentes. Para usar os métodos, você deve primeiro expô-los.

    O conector do Microsoft Outlook permite a automação de tarefas de rotina na aplicação Microsoft do Outlook, integrando essas funções em fluxos de trabalho automatizados mais amplos.

    Você pode automatizar processos como enviar ou responder a e-mails sem intervenção manual. Este conector fornece vários métodos para facilitar a automação de ações no Microsoft Outlook. Esses métodos podem ser combinados perfeitamente com outros métodos ou componentes em uma estrutura de automação, permitindo designs de fluxo de trabalho mais complexos e eficientes.

    AdicionarPasta

    Adiciona uma nova pasta em uma hierarquia especificada e, opcionalmente, uma subpasta ao conjunto de contas do Outlook.

    Tabela 1. Parâmetros do método AddFolder
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Pastaprincipal Nome da pasta que o método adiciona à conta do Outlook.

    Este parâmetro especifica a pasta principal onde a nova pasta foi adicionada.

    		 Dados em Cadeia de caracteres
    SubFolderName Nome da subpasta que o método adiciona à pasta principal.

    Este parâmetro especifica o nome da nova pasta a ser criada.

    Se você usar este parâmetro, deverá usar o parâmetro IsSubFolder.

    		 Dados em Cadeia de caracteres
    ÉSubPasta Opção para indicar que a pasta criada no parâmetro SubFolderName é uma subpasta na pasta principal.

    Este parâmetro indica se o SubFolderName deve ser adicionado como uma subpasta dentro da pasta principal. O padrão é falso, o que significa que SubFolderName é adicionado diretamente na pasta principal.

    		 Dados em Booliano

    Encerrar

    Encerra o Microsoft Outlook Explorer especificando o nome do perfil.

    Este método pode ser usado como uma atividade de limpeza depois que todas as tarefas de automação são concluídas.

    Tabela 2. Parâmetros do método de fechamento
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Nome do perfil Este parâmetro especifica o nome do perfil do Outlook que você deseja fechar. Dados em Cadeia de caracteres

    Excluir pasta

    Exclui a pasta especificada e todas as subpastas contidas nela.

    Tabela 3. Parâmetros do método DeleteFolder
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    FolderName Nome da pasta que o método exclui. Dados em Cadeia de caracteres

    Excluir e-mail

    Exclui um ou mais e-mails. Exclui um e-mail com base em seu ID de entrada exclusivo.
    Dica:
    Use o método GetMails para fornecer os e-mails que o método DeleteMail excluirá.
    Tabela 4. Parâmetros do método DeleteMail
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Usa o e-mail do qual o método exclui os e-mails.

    Este parâmetro especifica o ID de entrada exclusivo do e-mail que precisa ser excluído.

    		 Dados em Cadeia de caracteres

    Encaminhar e-mail

    Encaminha um e-mail com base em seu ID de entrada exclusivo para um endereço de e-mail especificado (EmailID).

    Tabela 5. Parâmetros do método ForwardMail
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail que precisa ser encaminhado. Dados em Cadeia de caracteres
    EmailID Este parâmetro especifica o endereço de e-mail para o qual o e-mail deve ser encaminhado. Dados em Cadeia de caracteres
    Cc Este parâmetro especifica o endereço de e-mail para enviar uma cópia carbono (CC) do e-mail encaminhado. Dados em Cadeia de caracteres
    Cco Este parâmetro especifica o endereço de e-mail para enviar uma cópia oculta (Cco) do e-mail encaminhado. Dados em Cadeia de caracteres
    Assunto Este parâmetro especifica a linha de assunto do e-mail encaminhado. Dados em Cadeia de caracteres
    Retornar Este método retorna um valor booliano que indica se o e-mail foi encaminhado com sucesso.

    Um valor de retorno verdadeiro significa que a operação foi bem-sucedida.

    		 Saída de dados Booliano

    GetAttachmentNames

    Recupera uma lista de nomes de anexos associados a um e-mail especificado por seu ID de entrada exclusivo.

    Tabela 6. Parâmetros do método GetAttachmentNames
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail cujos nomes de anexo serão recuperados. Dados em Cadeia de caracteres

    ObterContasExistentes

    Recupera informações sobre contas configuradas, como uma lista de contas configuradas e sua contagem.

    Isso é útil quando há várias contas configuradas no Outlook.

    Tabela 7. Parâmetros do método GetExistingAccounts
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Contas Este parâmetro é passado por referência e deve ser uma lista (de cadeia de caracteres). Ao chamar este método, ele é preenchido com a lista de nomes de contas configuradas. Saída de dados Lista1
    Contagem Este parâmetro é passado por referência. Ao chamar este método, este parâmetro é preenchido com a contagem de contas configuradas. Saída de dados Int32

    GetFolderNames

    Recupera e retorna uma lista de nomes de pastas da conta ativa do Outlook.

    Tabela 8. Parâmetros do método GetFolderNames
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Retornar Retorna a lista de nomes de pastas da conta ativa do Outlook. Saída de dados Lista1

    GetMail

    Recupera todos os detalhes de um e-mail, especificados por seu ID de entrada exclusivo (MailId).

    Para especificar critérios adicionais para recuperar todos os detalhes de um e-mail, na barra de método GetMail, clique no ícone de configurações de método ( ícone de configurações de método), selecione os itens de e-mail necessários, como CC, CCO, Assunto, Corpo, Remetente, Para, AttachmentsCount , RecebidoTempo,EntradaId.

    Tabela 9. Parâmetros do método GetMail
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail do qual os detalhes serão recuperados. Dados em Cadeia de caracteres

    GetMails

    Recupera uma lista de IDs de entrada de e-mail de uma pasta especificada em um sistema de e-mail.

    O método GetMails recupera uma lista de IDs de entrada de e-mail de uma pasta especificada em um sistema de e-mail.

    Tabela 10. Parâmetros do método GetMails
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    FolderName Este parâmetro especifica o nome da pasta da qual os IDs de entrada de e-mail serão recuperados.

    O valor padrão é "Caixa de entrada".

    		 Dados em Cadeia de caracteres
    Filtro Este parâmetro especifica uma condição de filtro a ser aplicada ao recuperar IDs de entrada de e-mail. Dados em Cadeia de caracteres
    NoOfMails Este parâmetro especifica o número máximo de IDs de entrada de e-mail a serem recuperados. O valor padrão é 10. Dados em Int32
    UnreadOnly Este parâmetro indica se devem ser recuperados somente e-mails não lidos (verdadeiro) ou todos os e-mails (falso). O padrão é Verdadeiro. Dados em Booliano
    Eviteitensdereunião Este parâmetro especifica se os itens de reunião devem ser excluídos dos IDs de entrada de e-mail recuperados. O padrão é Verdadeiro. Dados em Booliano
    Buscando pedido Este parâmetro especifica a ordem na qual os e-mails são obtidos. Por exemplo, FIFO, LIFO. O padrão é FIFO. Dados em Buscando pedido
    Retornar Este parâmetro retorna uma lista de e-mails da pasta especificada. Saída de dados Lista1
    Contagem Este parâmetro especifica a contagem total de IDs de entrada de e-mail recuperados. Saída de dados Int32

    GetSenderName

    Recupera o endereço de e-mail do remetente associado a um e-mail especificado por seu ID de entrada exclusivo.

    Tabela 11. Parâmetros do método GetSenderName
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail cujo endereço de e-mail do remetente será recuperado. Dados em Cadeia de caracteres
    Retornar Este método retorna um valor de cadeia de caracteres indicando o nome do remetente. Saída de dados Cadeia de caracteres

    Marcar como lido

    Marca um e-mail como lido com base em seu ID de entrada exclusivo.

    Tabela 12. Parâmetros do método MarkAsRead
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail cujo endereço de e-mail do remetente será recuperado. Dados em Cadeia de caracteres
    Retornar Este método retorna um valor booliano que indica se o e-mail foi marcado como lido com sucesso.

    Um valor de retorno verdadeiro significa que a operação foi bem-sucedida.

    		 Saída de dados Booliano

    Marcar como Não Lido

    Marca um e-mail como não lido com base em seu ID de entrada exclusivo.

    Tabela 13. Parâmetros do método MarkAsUnread
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail que precisa ser marcado como não lido. Dados em Cadeia de caracteres
    Retornar Este método retorna um valor booliano que indica se o e-mail foi marcado como não lido com sucesso.

    Um valor de retorno verdadeiro significa que a operação foi bem-sucedida.

    		 Saída de dados Booliano

    MoveMail

    Move um e-mail com base em seu ID de entrada exclusivo de uma pasta para outra dentro do sistema de e-mail.

    Tabela 14. Parâmetros do método MoveMail
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail que deve ser movido. Dados em Cadeia de caracteres
    Pasta de destino Este parâmetro especifica o nome ou o caminho da pasta de destino para onde o e-mail deve ser movido. Dados em Cadeia de caracteres

    ReadMsgFile

    Lê o conteúdo de um arquivo .msg do sistema de arquivos.

    Tabela 15. Parâmetros do método ReadMsgFile
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    Caminho do arquivo Este parâmetro especifica o caminho para o arquivo .msg que deve ser lido. Dados em Cadeia de caracteres
    Corpo da mensagem Este parâmetro é passado por referência (ByRef) e preenchido com o conteúdo do corpo do arquivo .msg após a chamada do método. Saída de dados Cadeia de caracteres

    resposta

    Gera e envia uma resposta a um e-mail especificado por seu ID de entrada exclusivo.

    Tabela 16. Parâmetros do método de resposta
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    IsHtmlBody Este parâmetro indica se o conteúdo do corpo do e-mail de resposta está no formato HTML.

    O padrão é falso.

    		 Dados em Booliano
    Retornar Este método retorna um valor booliano que indica se a resposta foi enviada com sucesso.

    Um valor de retorno verdadeiro significa que a operação foi bem-sucedida.

    		 Saída de dados Booliano

    SalvarTodosAnexos

    Salva todos os anexos de um e-mail especificado por seu ID de entrada exclusivo em um caminho de pasta especificado.

    Tabela 17. Parâmetros do método "SaveAllAttachments"
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail do qual os anexos devem ser salvos. Dados em Cadeia de caracteres
    FolderPath Este parâmetro especifica o caminho da pasta em que os anexos devem ser salvos. Dados em Cadeia de caracteres

    SalvarAnexo

    Salva o anexo especificado de um e-mail com o ID de entrada fornecido em um determinado arquivo.

    Tabela 18. Parâmetros do método "SaveAttachment"
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail do qual o anexo deve ser salvo. Dados em Cadeia de caracteres
    AttachmentName Este parâmetro especifica o nome do anexo que deve ser salvo. Dados em Cadeia de caracteres
    Caminho do arquivo Este parâmetro especifica o caminho do arquivo em que o anexo deve ser salvo. Dados em Cadeia de caracteres

    Salvar e-mail

    Salva um e-mail especificado por seu ID de entrada exclusivo (MailId) em um arquivo em um caminho de arquivo especificado.

    Tabela 19. Parâmetros do método SaveMail
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    MailId Este parâmetro especifica o ID de entrada exclusivo do e-mail a ser salvo. Dados em Cadeia de caracteres
    Caminho do arquivo Este parâmetro especifica o caminho em que o e-mail deve ser salvo como um arquivo Dados em Cadeia de caracteres
    SalvarTipo Este parâmetro especifica o formato no qual o e-mail deve ser salvo.

    O padrão é MsgSaveType.olMSG, indicando o formato MSG do Microsoft Outlook.

    		 Dados em MsgSaveType

    SendMail

    Envia um e-mail para o destinatário. Ele oferece vários parâmetros opcionais para personalizar o e-mail, incluindo a capacidade de adicionar imagens, definir o endereço do remetente e especificar destinatários CC e CCO.

    Tabela 20. Parâmetros do método SendMail
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    ParaEmailId Este parâmetro especifica o endereço de e-mail do destinatário. Dados em Cadeia de caracteres
    Imagem Este parâmetro especifica uma imagem opcional a ser incluída no e-mail. Dados em Desenhar.Bitmap
    De Este parâmetro especifica o endereço de e-mail do remetente. Se não for especificado, o endereço do remetente padrão será usado. Dados em Cadeia de caracteres
    Cc Este parâmetro especifica o endereço de e-mail para o qual uma cópia (CC) será enviada. Dados em Cadeia de caracteres
    Cco Este parâmetro especifica o endereço de e-mail para o qual uma cópia oculta (Cco) será enviada. Dados em Cadeia de caracteres
    Assunto Este parâmetro especifica a linha de assunto do e-mail. Dados em Cadeia de caracteres
    Corpo da mensagem Este parâmetro especifica o conteúdo do corpo do e-mail. Dados em Cadeia de caracteres
    Anexos Este parâmetro especifica caminhos de arquivo dos anexos a serem incluídos no e-mail. Vários arquivos podem ser separados por ponto e vírgula. Dados em Cadeia de caracteres
    IsHtmlBody Este parâmetro indica se o corpo do e-mail está no formato HTML. O padrão é falso. Dados em Booliano
    Retornar Este método retorna um valor booliano que indica se o e-mail foi enviado com sucesso.

    Um valor de retorno verdadeiro significa que a operação foi bem-sucedida.

    		 Saída de dados Booliano

    Enviados como

    Envia um e-mail em nome de outra conta de e-mail.

    Tabela 21. Parâmetros do método SentAs
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    ParaEmailId Este parâmetro especifica o endereço de e-mail do destinatário. Dados em Cadeia de caracteres
    SentOnBehalfEmailID Este parâmetro especifica o endereço de e-mail em nome do qual o e-mail será enviado. Dados em Cadeia de caracteres
    Assunto Este parâmetro especifica a linha de assunto do e-mail. Dados em Cadeia de caracteres
    Corpo da mensagem Este parâmetro especifica o conteúdo do corpo do e-mail. Dados em Cadeia de caracteres
    Anexos Este parâmetro especifica caminhos de arquivo dos anexos a serem incluídos no e-mail. Dados em Cadeia de caracteres
    IsHtmlBody Este parâmetro indica se o corpo do e-mail está no formato HTML. O padrão é falso. Dados em Booliano

    Definir conta

    Especifica a conta do Outlook na qual você deseja executar operações para suas tarefas de automação.

    O método SetAccount deve ser usado inicialmente, antes de qualquer outro método deste conector, para especificar ou definir o contexto ou a conta de e-mail para os métodos subsequentes serem executados.

    Tabela 22. Parâmetros do método SetAccount
    Parâmetro Descrição Tipo de porta de dados Tipo de dados
    AccountName Este parâmetro especifica o ID da conta de e-mail do Outlook na qual você deseja executar operações. Dados em Cadeia de caracteres