3. Exemplos¶
Este tópico tem como objetivo demostrar a utilização do módulo e seus métodos.
3.1. Configuração Inicial¶
from python_mail.Search import Search
search = Search("inbox")
id_messages = search.search_subject('Subject Message')
data_messages = search.result_message(id_messages)
for message in data_messages:
print(message)
Note
A configuração inicial consiste em passar a caixa na qual será feita a pesquisa das mensagens.
3.2. Métodos disponíveis¶
Os métodos disponíveis deste módulo são:
search_body(str)
filtra as mensagens pelo campo “Body”, ou seja, filtra no corpo da mensagem.
search_from(str)
filtra as mensagens pelo campo “From”, ou seja, faz uma pesquisa pelo remetente da mensagem.
search_subject(str)
filtra as mensagens pelo campo “Subject”, ou seja, filtra no assunto da mensagem.
Note
Todos os métodos de filtro de mensagens que estão listados acima devem receber como parâmetro uma string e retorna o ID das mensagens que foram encontradas.
result_message([list])
retorna o conteúdo completo das mensagens: data, from, to, subject e body.
result_date([list])
retorna a data das mensagens.
result_from([list])
retorna o remetente das mensagens.
result_to([list])
retorna o destinatário das mensagens.
Note
Todos os métodos para o retorno do conteúdo deve receber como parâmetro uma lista contendo um ou mais IDs das mensagens.