Módulo google.appengine.api.mail

Resumo

Envia e-mail em nome do aplicativo.

Este módulo fornece funções para que desenvolvedores de aplicativos forneçam serviços de e-mail nos aplicativos deles. O módulo também fornece alguns métodos utilitários.

Conteúdo

class google.appengine.api.mail.AdminEmailMessage(mime_message=None, **kw)source

Bases: google.appengine.api.mail._EmailMessageBase

Interface que envia mensagens de e-mail para todos os administradores por meio da Mail API.

Essa classe é usada para criar, de maneira programática, uma mensagem de e-mail do administrador para ser enviada por meio da Mail API. Para usar a classe, crie uma instância, preencha os campos dela e chame Send().

Ao contrário das mensagens de e-mail normais, os endereços nos campos do destinatário são ignorados e não são usados para enviar a mensagem.

Uma AdminEmailMessage pode ser criada completamente pelo construtor:

AdminEmailMessage(sender='sender@nowhere.com',
                  subject='a subject',
                  body='This is an email to you').Send()

Você pode querer que seu aplicativo crie um e-mail de administrador em locais diferentes em todo o código. Para isso, a AdminEmailMessage é mutável:

message = AdminEmailMessage()
message.sender = 'sender@nowhere.com'
message.subject = 'a subject'
message.body = 'This is an email to you'
message.check_initialized()
message.send()
class google.appengine.api.mail.Attachment(*args, **kwds)source

Bases: object

Objeto Attachment.

Um objeto Attachment é amplamente intercambiável com uma tupla (filename, payload).

filename

O nome do anexo.

payload

Os dados do anexo.

content_id

Opcional. O código do conteúdo desse anexo. Apenas palavra-chave.

google.appengine.api.mail.CheckEmailValid(email_address, field)source

Verifica se um e-mail é válido.

Parâmetros
  • email_address: endereço de e-mail a verificar.

  • field: campo a verificar.

Gera

InvalidEmailError: se email_address é inválido.

class google.appengine.api.mail.EmailMessage(mime_message=None, **kw)source

Bases: google.appengine.api.mail._EmailMessageBase

Interface principal do serviço da Mail API.

Essa classe é usada para criar, de maneira programática, uma mensagem de e-mail para enviar por meio da Mail API. Para usar essa classe, crie uma instância, preencha os campos dela e chame Send().

Uma EmailMessage pode ser criada completamente pelo construtor:

EmailMessage(sender='sender@nowhere.com',
             to='recipient@nowhere.com',
             subject='a subject',
             body='This is an email to you').Send()

Você pode querer que seu aplicativo crie um e-mail em locais diferentes em todo o código. Para isso, EmailMessage é mutável:

message = EmailMessage()
message.sender = 'sender@nowhere.com'
message.to = ['recipient1@nowhere.com', 'recipient2@nowhere.com']
message.subject = 'a subject'
message.body = 'This is an email to you'
message.check_initialized()
message.send()
CheckInitialized()source

Garante que os destinatários tenham sido especificados.

PROPRIEDADES = set(['body', 'amp_html', 'sender', 'to', 'cc', 'bcc', 'attachments', 'headers', 'html', 'reply_to', 'subject'])
ToProto()source

Executa mais conversão de campos de destinatários no buffer de protocolo.

Retorna

A versão do protocolo MailMessage da mensagem de e-mail, incluindo os campos do remetente.

check_initialized()source

Fornece verificações adicionais para garantir que os destinatários tenham sido especificados.

Gera

MissingRecipientError: se nenhum destinatário for especificado em "To", "Cc" ou "Bcc".

update_from_mime_message(mime_message)source

Copia informações de destinatários a partir de uma mensagem MIME.

Parâmetros

mime_message: a instância email.Message de onde as informações serão copiadas.

class google.appengine.api.mail.EncodedPayload(payload, charset=None, encoding=None)source

Bases: object

Wrapper para um payload que contém informações de codificação.

Quando um e-mail é recebido, ele geralmente é codificado usando um determinado conjunto de caracteres e, em seguida, possivelmente codificado mais uma vez usando uma codificação de transferência nesse conjunto de caracteres. Na maioria das vezes, é possível decodificar o payload codificado no estado em que se encontra. No entanto, quando não for possível, o payload codificado e as informações da codificação original precisam ser preservados.

payload

O payload codificado original.

charset

O conjunto de caracteres do payload codificado. Para especificar que você quer usar o conjunto de caracteres padrão, defina esse argumento como None.

encoding

A codificação de transferência do payload codificado. Para especificar que você não quer que o conteúdo seja codificado, defina esse argumento como None.

copy_to(mime_message)source

Copia o conteúdo de uma mensagem para um payload de mensagem MIME.

Se nenhuma codificação de transferência de conteúdo for especificada e o conjunto de caracteres não for igual à codificação geral da mensagem, o payload será codificado em base64.

Parâmetros

mime_message: instância de mensagem que receberá o novo payload.

decode()source

Tenta decodificar os dados codificados.

Essa função tenta usar a biblioteca de codecs do Python para decodificar o payload. Todas as exceções são passadas de volta para o chamador.

Retorna

A versão binária ou Unicode do conteúdo do payload.

to_mime_message()source

Converte uma mensagem em uma mensagem MIME.

Retorna

A instância da mensagem MIME do payload.

class google.appengine.api.mail.InboundEmailMessage(mime_message=None, **kw)source

Bases: google.appengine.api.mail.EmailMessage

Recebe um e-mail analisado da maneira em que é recebido de uma fonte externa.

Essa classe faz uso de um campo date e pode armazenar qualquer número de corpos adicionais. Esses atributos adicionais tornam o e-mail mais flexível conforme exigido para o recebimento de e-mails em que o desenvolvedor tem menos controle sobre o conteúdo.

Exemplo:

# Read mail message from CGI input.
message = InboundEmailMessage(sys.stdin.read())
logging.info('Received email message from %s at %s',
             message.sender,
             message.date)
enriched_body = list(message.bodies('text/enriched'))[0]
# ... Do something with body ...
ALLOW_BLANK_EMAIL = True
PROPRIEDADES = frozenset(['body', 'amp_html', 'sender', 'alternate_bodies', 'cc', 'bcc', 'to', 'html', 'reply_to', 'date', 'subject', 'message_id', 'attachments'])
bodies(content_type=None)source

Itera em todos os corpos.

Parâmetros

content_type –

Tipo de conteúdo usado para filtrar. Esse argumento permite que você selecione apenas tipos específicos de conteúdo. Você pode usar o tipo base ou o tipo de conteúdo.

Por exemplo:

content_type = 'text/html'  # Matches only HTML content.
content_type = 'text'       # Matches text of any kind.

Gera

Uma tupla (content_type, payload) para todos os corpos de uma mensagem, incluindo o corpo, o HTML e todos os alternate_bodies, nessa ordem.

to_mime_message()source

Converte uma mensagem em uma mensagem MIME.

Essa função adiciona outros cabeçalhos do e-mail recebido.

Retorna

A instância da mensagem MIME de um payload.

update_from_mime_message(mime_message)source

Atualiza os valores de uma mensagem MIME.

Essa função copia os valores de data.

Parâmetros

mime_message: a instância email.Message de onde você quer copiar informações.

google.appengine.api.mail.InvalidEmailReason(email_address, field)source

Determina por que um e-mail é inválido.

Parâmetros
  • email_address: endereço de e-mail a verificar.

  • field: campo inválido.

Retorna

Uma string que indica por que um e-mail é inválido. Caso contrário, retorna None.

google.appengine.api.mail.IsEmailValid(email_address)source

Determina se um endereço de e-mail é inválido.

Parâmetros

email_address: endereço de e-mail a verificar.

Retorna

True se o endereço de e-mail especificado for válido. Caso contrário, retorna False.

google.appengine.api.mail.MailMessageToMIMEMessage(protocol_message)source

Gera uma mensagem MIMEMultipart de um buffer de protocolo MailMessage.

Essa função gera um objeto de e-mail MIMEMultipart completo de um buffer de protocolo MailMessage. Os campos do corpo são enviados como alternativas individuais, se os dois estiverem presentes. Caso contrário, apenas uma parte do corpo é enviada.

Os campos de vários e-mails recebidos, como "To", "Cc" e "Bcc" são convertidos em uma lista de endereços de e-mail separados por vírgula.

Parâmetros

protocol_message: buffer de protocolo de mensagem para converter em uma mensagem MIMEMultipart.

Retorna

Uma mensagem MIMEMultipart que representa o MailMessage fornecido.

Gera

InvalidAttachmentTypeError: se o tipo de arquivo do anexo for inválido.

google.appengine.api.mail.SendMail(sender, to, subject, body, make_sync_call=MakeSyncCall, **kw)source

Envia e-mails em nome do aplicativo.

Parâmetros
  • sender: endereço de e-mail do remetente como aparece na linha de e-mail "De".

  • to: lista de um ou mais endereços "Para".

  • subject: string do assunto da mensagem.

  • body: corpo de texto simples.

  • make_sync_call: função usada para fazer uma chamada de sincronização para um proxy de API.

  • **kw: argumentos de palavras-chave compatíveis com o construtor baseado na palavra-chave EmailMessage.

Gera

InvalidEmailError: se um endereço de e-mail inválido foi especificado.

google.appengine.api.mail.SendMailToAdmins(sender, subject, body, make_sync_call=MakeSyncCall, **kw)source

Envia e-mail para administradores em nome do aplicativo.

Parâmetros
  • sender: endereço de e-mail do remetente como aparece na linha de e-mail "De".

  • subject: string do assunto da mensagem.

  • body: corpo de texto simples.

  • make_sync_call: função usada para fazer uma chamada de sincronização para um proxy de API.

  • **kw: argumentos de palavras-chave compatíveis com o construtor baseado na palavra-chave EmailMessage.

Gera

InvalidEmailError: se um endereço de e-mail inválido foi especificado.

google.appengine.api.mail.check_email_valid(email_address, field)source

Verifica se um e-mail é válido.

Parâmetros
  • email_address: endereço de e-mail a verificar.

  • field: campo a verificar.

Gera

InvalidEmailError: se email_address é inválido.

google.appengine.api.mail.check_headers_valid(headers)source

Verifica se os headers são um dicionário válido para um cabeçalho.

Parâmetros

headers: o valor para verificar os cabeçalhos.

Gera

InvalidEmailError: se headers é inválido.

google.appengine.api.mail.invalid_email_reason(email_address, field)source

Determina por que um e-mail é inválido.

Parâmetros
  • email_address: endereço de e-mail a verificar.

  • field: campo inválido.

Retorna

Uma string que indica por que um e-mail é inválido. Caso contrário, retorna None.

google.appengine.api.mail.invalid_headers_reason(headers)source

Determina o motivo pelo qual um cabeçalho é inválido.

Parâmetros

headers: valor do cabeçalho a verificar.

Retorna

Uma string que indica o motivo da invalidade dos cabeçalhos se for possível determiná-lo. Caso contrário, retorna None.

google.appengine.api.mail.is_ascii(string)source

Retorna se uma string está em ASCII.

google.appengine.api.mail.is_email_valid(email_address)source

Determina se um endereço de e-mail é inválido.

Parâmetros

email_address: endereço de e-mail a verificar.

Retorna

True se o endereço de e-mail especificado for válido. Caso contrário, retorna False.

google.appengine.api.mail.mail_message_to_mime_message(protocol_message)source

Gera uma mensagem MIMEMultipart de um buffer de protocolo MailMessage.

Essa função gera um objeto de e-mail MIMEMultipart completo de um buffer de protocolo MailMessage. Os campos do corpo são enviados como alternativas individuais, se os dois estiverem presentes. Caso contrário, apenas uma parte do corpo é enviada.

Os campos de vários e-mails recebidos, como "To", "Cc" e "Bcc" são convertidos em uma lista de endereços de e-mail separados por vírgula.

Parâmetros

protocol_message: buffer de protocolo de mensagem para converter em uma mensagem MIMEMultipart.

Retorna

Uma mensagem MIMEMultipart que representa o MailMessage fornecido.

Gera

InvalidAttachmentTypeError: se o tipo de arquivo do anexo for inválido.

google.appengine.api.mail.send_mail(sender, to, subject, body, make_sync_call=MakeSyncCall, **kw)source

Envia e-mails em nome do aplicativo.

Parâmetros
  • sender: endereço de e-mail do remetente como aparece na linha de e-mail "De".

  • to: lista de um ou mais endereços "Para".

  • subject: string do assunto da mensagem.

  • body: corpo de texto simples.

  • make_sync_call: função usada para fazer uma chamada de sincronização para um proxy de API.

  • **kw: argumentos de palavras-chave compatíveis com o construtor baseado na palavra-chave EmailMessage.

Gera

InvalidEmailError: se um endereço de e-mail inválido foi especificado.

google.appengine.api.mail.send_mail_to_admins(sender, subject, body, make_sync_call=MakeSyncCall, **kw)source

Envia e-mail para administradores em nome do aplicativo.

Parâmetros
  • sender: endereço de e-mail do remetente como aparece na linha de e-mail "De".

  • subject: string do assunto da mensagem.

  • body: corpo de texto simples.

  • make_sync_call: função usada para fazer uma chamada de sincronização para um proxy de API.

  • **kw: argumentos de palavras-chave compatíveis com o construtor baseado na palavra-chave EmailMessage.

Gera

InvalidEmailError: se um endereço de e-mail inválido foi especificado.

google.appengine.api.mail.wrapping(wrapped)source

Um decorador para o wrapper de outro decorador.

Esse decorador facilita a depuração de um código fortemente decorado.

Parâmetros

wrapped: a função decorada que você está tentando depurar.

Retorna

Uma função com __name__, __doc__ e ___dict__ remapeada para as respectivas versões da função incorporada para facilitar a depuração.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Ambiente padrão do App Engine para Python 2