Module z_email

Send e-mail to a recipient.

Copyright © 2009-2017 Marc Worrell

Authors: Marc Worrell (marc@worrell.nl).

Description

Send e-mail to a recipient. Optionally queue low priority messages.

Function Index

bounce_domain/1
combine_name_email/2Combine a name and an email address to the format jan janssen <jan@example.com>
email_domain/1
ensure_domain/2
get_admin_email/1Fetch the e-mail address of the site administrator.
get_email_from/1Fetch the default From e-mail address.
send/2Send an email message defined by the email record.
send/3
send/4Send a simple text message to an email address.
send_admin/3Send a simple text message to the administrator.
send_page/3Send a page to an e-mail address, assumes the correct template "mailing_page.tpl" is available.
send_render/4Send a html message to an email address, render the message using a template.
send_render/5Send a html and text message to an email address, render the message using two templates.
sendq/4Queue a simple text message to an email address.
sendq_render/4Queue a html message to an email address, render the message using a template.
sendq_render/5Queue a html and text message to an email address, render the message using two templates.
split_name_email/1Split the name and email from the format jan janssen <jan@example.com>

Function Details

bounce_domain/1

bounce_domain(Context::z:context()) -> binary()

combine_name_email/2

combine_name_email(Name::binary() | string(), Email::binary() | string()) -> binary()

Combine a name and an email address to the format jan janssen <jan@example.com>

email_domain/1

email_domain(Context::z:context()) -> binary()

ensure_domain/2

ensure_domain(Email::binary() | string(), Context::z:context()) -> binary()

get_admin_email/1

get_admin_email(Context::z:context()) -> binary()

Fetch the e-mail address of the site administrator

get_email_from/1

get_email_from(Context::z:context()) -> binary()

Fetch the default From e-mail address. Defaults to noreply@hostname

send/2

send(Email, Context) -> any()

Send an email message defined by the email record.

send/3

send(MsgId, Email, Context) -> any()

send/4

send(To, Subject, Message, Context) -> any()

Send a simple text message to an email address

send_admin/3

send_admin(Subject::iodata(), Message::iodata(), Context::z:context()) -> {ok, MsgId::binary()} | {error, sender_disabled | term()}

Send a simple text message to the administrator

send_page/3

send_page(Email, Id, Context) -> any()

Send a page to an e-mail address, assumes the correct template "mailing_page.tpl" is available. Defaults for these pages are supplied by mod_mailinglist.

send_render/4

send_render(To, HtmlTemplate, Vars, Context) -> any()

Send a html message to an email address, render the message using a template.

send_render/5

send_render(To, HtmlTemplate, TextTemplate, Vars, Context) -> any()

Send a html and text message to an email address, render the message using two templates.

sendq/4

sendq(To, Subject, Message, Context) -> any()

Queue a simple text message to an email address

sendq_render/4

sendq_render(To, HtmlTemplate, Vars, Context) -> any()

Queue a html message to an email address, render the message using a template.

sendq_render/5

sendq_render(To, HtmlTemplate, TextTemplate, Vars, Context) -> any()

Queue a html and text message to an email address, render the message using two templates.

split_name_email/1

split_name_email(Email::binary() | string()) -> {binary(), binary()}

Split the name and email from the format jan janssen <jan@example.com>


Generated by EDoc