IMessage
in
Interface IMessage
Tags
Table of Contents
Methods
- attach() : IMessage
- attachInline() : IMessage
- Can be used to "attach content inline" as message parts with specific MIME type and encoding.
- setAutoSubmitted() : IMessage
- Add the Auto-Submitted header to the email, preventing most automated responses to automated messages.
- setBcc() : IMessage
- Set the BCC recipients of this message.
- setCc() : IMessage
- Set the CC recipients of this message.
- setFrom() : IMessage
- Set the from address of this message.
- setHtmlBody() : self
- Set the HTML body of this message. Consider also sending a plain-text body instead of only an HTML one.
- setPlainBody() : self
- Set the plain-text body of this message
- setReplyTo() : IMessage
- Set the Reply-To address of this message
- setSubject() : self
- Set the subject of this message
- setTo() : IMessage
- Set the to addresses of this message.
- useTemplate() : IMessage
Methods
attach()
public
attach(IAttachment $attachment) : IMessage
Parameters
- $attachment : IAttachment
Tags
Return values
IMessageattachInline()
Can be used to "attach content inline" as message parts with specific MIME type and encoding.
public
attachInline(string $body, string $name[, string|null $contentType = null ]) : IMessage
Parameters
- $body : string
-
body of the MIME part
- $name : string
-
the file name
- $contentType : string|null = null
-
MIME Content-Type (e.g. text/plain or text/calendar)
Tags
Return values
IMessagesetAutoSubmitted()
Add the Auto-Submitted header to the email, preventing most automated responses to automated messages.
public
setAutoSubmitted(AutoSubmitted::VALUE_* $value) : IMessage
Parameters
- $value : AutoSubmitted::VALUE_*
-
(one of AutoSubmitted::VALUE_NO, AutoSubmitted::VALUE_AUTO_GENERATED, AutoSubmitted::VALUE_AUTO_REPLIED)
Tags
Return values
IMessagesetBcc()
Set the BCC recipients of this message.
public
setBcc(array<string|int, mixed> $recipients) : IMessage
Parameters
- $recipients : array<string|int, mixed>
-
Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
Tags
Return values
IMessagesetCc()
Set the CC recipients of this message.
public
setCc(array<string|int, mixed> $recipients) : IMessage
Parameters
- $recipients : array<string|int, mixed>
-
Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
Tags
Return values
IMessagesetFrom()
Set the from address of this message.
public
setFrom(array<string|int, mixed> $addresses) : IMessage
If no "From" address is used \OC\Mail\Mailer will use mail_from_address and mail_domain from config.php
Parameters
- $addresses : array<string|int, mixed>
-
Example: array('sender@domain.org', 'other@domain.org' => 'A name')
Tags
Return values
IMessagesetHtmlBody()
Set the HTML body of this message. Consider also sending a plain-text body instead of only an HTML one.
public
setHtmlBody(string $body) : self
Parameters
- $body : string
Tags
Return values
selfsetPlainBody()
Set the plain-text body of this message
public
setPlainBody(string $body) : self
Parameters
- $body : string
Tags
Return values
selfsetReplyTo()
Set the Reply-To address of this message
public
setReplyTo(array<string|int, mixed> $addresses) : IMessage
Parameters
- $addresses : array<string|int, mixed>
Tags
Return values
IMessagesetSubject()
Set the subject of this message
public
setSubject(string $subject) : self
Parameters
- $subject : string
Tags
Return values
selfsetTo()
Set the to addresses of this message.
public
setTo(array<string|int, mixed> $recipients) : IMessage
Parameters
- $recipients : array<string|int, mixed>
-
Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
Tags
Return values
IMessageuseTemplate()
public
useTemplate(IEMailTemplate $emailTemplate) : IMessage
Parameters
- $emailTemplate : IEMailTemplate