Mail

4 min

Resumo

Realiza o envio de emails.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
attach	list / elements=path	Default: - []	Uma lista de nomes de caminho de arquivos a serem anexados à mensagem. Os arquivos anexados terão seu tipo de conteúdo definido como application/octet-stream.
bcc	list / elements=string		O (s) endereço (s) de e-mail para os quais o e-mail está sendo copiado 'às cegas'. Esta é uma lista, que pode conter porções de endereço e frase.
body	string		O corpo do e-mail enviado.
cc	list / elements=string		Os endereços de e-mail para os quais o e-mail está sendo copiado. Esta é uma lista, que pode conter porções de endereço e frase.
charset	string	Default: - "utf-8"	O conjunto de caracteres do e-mail enviado.
headers	list / elements=string	Default: - []	Uma lista de cabeçalhos que devem ser adicionados à mensagem. Cada cabeçalho individual é especificado como header=value(veja o exemplo abaixo).
host	string	Default: - "localhost"	O servidor de correio.
password	string		Se o SMTP requer senha.
port	integer	Default: - 25	A porta do servidor de correio. Deve ser um número inteiro válido entre 1 e 65534.
secure	string	Escolhas: - try (default) - always - never -starttls	Se always, a conexão só enviará e-mail se a conexão for criptografada. Se o servidor não aceitar a conexão criptografada, ele falhará. Se try, a conexão tentará configurar uma sessão SSL / TLS segura, antes de tentar enviar.Se never, a conexão não tentará configurar uma sessão SSL / TLS segura, antes de enviar. Se starttls, a conexão tentará atualizar para uma conexão SSL / TLS segura, antes de enviar. Se não for possível fazer isso, ele falhará.
sender aliases: from	string	Default: - "root"	O endereço de e-mail de onde o e-mail é enviado. Pode conter endereço e frase.
subject aliases: msg	string		O assunto do e-mail enviado.
subtype - required	string	Escolhas: - plain (default) - html	O tipo mime secundário pode ser plain ou html.O tipo principal é sempre text.
timeout	integer	Default: - 20	Define o tempo limite em segundos para tentativas de conexão.
to aliases: destinatários	list / elements=string	Default: - "raiz"	Os endereços de e-mail para os quais o e-mail está sendo enviado.Esta é uma lista, que pode conter porções de endereço e frase.
username	string		Se o SMTP requer nome de usuário.

Exemplos

# Exemplo de manual de envio de email para root
  mail:
    subject: System {{ atmosphere_hostname }} has been successfully provisioned.
  delegate_to: localhost

# Enviar um e-mail usando servidores SMTP do Gmail
  mail:
    host: smtp.gmail.com
    port: 587
    username: [email protected]
    password: mysecret
    to: John Smith <[email protected]>
    subject: atmosphere-report
    body: System {{ atmosphere_hostname }} has been successfully provisioned.
  delegate_to: localhost

# Enviar e-mail para vários usuários, anexando arquivos
  mail:
    host: 127.0.0.1
    port: 2025
    subject: atmosphere-report
    body: Hello, this is an e-mail. I hope you like it ;-)
    from: [email protected] (Jane Jolie)
    to:
    - John Doe <[email protected]>
    - Suzie Something <[email protected]>
    cc: Charlie Root <root@localhost>
    attach:
    - /etc/group
    - /tmp/avatar2.png
    headers:
    - [email protected]
    - X-Special="Something or other"
    charset: us-ascii
  delegate_to: localhost

# Enviar um e-mail usando a máquina remota, não o node do controlador atmosphere
  mail:
    host: localhost
    port: 25atmosphereample.com>
    subject: atmosphere-report
    body: System {{ atmosphere_hostname }} has been successfully provisioned.

# Enviando um e-mail usando SSL legado para a máquina remota
  mail:
    host: localhost
    port: 25
    to: John Smith <[email protected]>
    subject: atmosphere-report
    body: System {{ atmosphere_hostname }} has been successfully provisioned.
    secure: always

# Enviando um e-mail usando StartTLS para a máquina remota
  mail:
    host: localhost
    port: 25
    to: John Smith <[email protected]>
    subject: atmosphere-report
    body: System {{ atmosphere_hostname }} has been successfully provisioned.
    secure: starttls

Valores retornados

Parâmetro	Tipo	Retornado quando	Comentários
Changed	bool	Sempre	Situação da execução do módulo
msg	string	Sempre	A mensagem que você tentou enviar