core/model/modx/mail/modmail.class.php

Show:

inherited

Classes
- \modMail

Table of Contents

This file contains the modMail email service interface definition.

Package: modx
Subpackage: mail

\modMail
jump to top

Package: modx\mail

Defines the interface for the modX email service.

Children: \modPHPMailer
Abstract: Implement a derivative of this class to define an actual email service implementation.

Constants

 
                MAIL_BODY
                = 'mail_body'

Const: An option for setting the mail body

 
                MAIL_BODY_TEXT
                = 'mail_body_text'

Const: An option for setting the mail body text

 
                MAIL_CHARSET
                = 'mail_charset'

Const: An option for setting the mail charset

 
                MAIL_CONTENT_TYPE
                = 'mail_content_type'

Const: An option for setting the mail content type

 
                MAIL_ENCODING
                = 'mail_encoding'

Const: An option for setting the mail encoding

 
                MAIL_ENGINE
                = 'mail_engine'

Const: An option for setting the mail engine

 
                MAIL_ENGINE_PATH
                = 'mail_engine_path'

Const: An option for setting the mail engine path

 
                MAIL_ERROR_INFO
                = 'mail_error_info'

Const: An option for setting the mail error information

 
                MAIL_FROM
                = 'mail_from'

Const: An option for setting the mail From address

 
                MAIL_FROM_NAME
                = 'mail_from_name'

Const: An option for setting the mail From name

 
                MAIL_HOSTNAME
                = 'mail_hostname'

Const: An option for setting the mail hostname

 
                MAIL_LANGUAGE
                = 'mail_language'

Const: An option for setting the mail language

 
                MAIL_PRIORITY
                = 'mail_priority'

Const: An option for setting the mail priority header

 
                MAIL_READ_TO
                = 'mail_read_to'

Const: An option for setting the mail read to header

 
                MAIL_SENDER
                = 'mail_sender'

Const: An option for setting the mail sender

 
                MAIL_SERVICE
                = 'mail_service'

Const: An option for setting the mail service

 
                MAIL_SMTP_AUTH
                = 'mail_smtp_auth'

Const: An option for setting the mail SMTP auth type

 
                MAIL_SMTP_HELO
                = 'mail_smtp_helo'

Const: An option for setting the mail SMTP HELO boolean

 
                MAIL_SMTP_HOSTS
                = 'mail_smtp_hosts'

Const: An option for setting the mail SMTP hosts

 
                MAIL_SMTP_KEEPALIVE
                = 'mail_smtp_keepalive'

Const: An option for setting the mail SMTP Keep-Alive boolean

 
                MAIL_SMTP_PASS
                = 'mail_smtp_pass'

Const: An option for setting the mail SMTP password

 
                MAIL_SMTP_PORT
                = 'mail_smtp_port'

Const: An option for setting the mail SMTP port

 
                MAIL_SMTP_PREFIX
                = 'mail_smtp_prefix'

Const: An option for setting the mail SMTP prefix

 
                MAIL_SMTP_SINGLE_TO
                = 'mail_smtp_single_to'

Const: An option for setting the mail SMTP Single-To option

 
                MAIL_SMTP_TIMEOUT
                = 'mail_smtp_timeout'

Const: An option for setting the mail SMTP timeout

 
                MAIL_SMTP_USER
                = 'mail_smtp_user'

Const: An option for setting the mail SMTP username

 
                MAIL_SUBJECT
                = 'mail_subject'

Const: An option for setting the mail subject

Properties

array
                 $addresses= 'array(
        'to' => array(),
        'cc' => array(),
        'bcc' => array(),
        'reply-to' => array(),
    )'

An array of address types: to, cc, bcc, reply-to

Default value

array(
        'to' => array(),
        'cc' => array(),
        'bcc' => array(),
        'reply-to' => array(),
    )

Details

Type: array

array
                 $attributes= 'array()'

A collection of attributes defining all of the details of email communication.

Default valuearray()Details

Type: array

array
                 $files= 'array()'

An array of attached files

Default valuearray()Details

Type: array

array
                 $headers= 'array()'

A collection of all the current headers for the object.

Default valuearray()Details

Type: array

object
                 $mailer= 'null'

The mailer object responsible for implementing the modMail methods.

Default valuenullDetails

Type: object

\modX
                 $modx= 'null'

A reference to the modX instance communicating with this service instance.

Default valuenullDetails

Type: \modX

Methods

__construct(
          \modX $modx, array $attributes
              =
              array()
          )
        
        :
          void

Constructs a new instance of the modMail class.

Parameters

Name	Type	Description
$modx	\modX	&$modx A reference to the modX instance
$attributes	array	An array of attributes to assign to the new mail instance

_getMailer(
          
          )
        
        :
          boolean

abstract

Get an instance of the email class responsible for sending emails from the modEmail service.

{@internal Implement this function in derivatives and call it in the constructor after all other dependencies have been satisfied.}

Returns

Type	Description
boolean	Indicates if the mailer class was instantiated successfully.

Details

Abstract
Access: protected

address(
          string $type, string $email, string $name
              =
              ''
          )
        
        :
          boolean

Add a new recipient email address to one of the valid address type buckets.

Parameters

Name	Type	Description
$type	string	The address type to add; to, cc, bcc, or reply-to.
$email	string	The email address.
$name	string	An optional name for the addressee.

Returns

Type	Description
boolean	Indicates if the address was set/unset successfully.

Details

Access: public

attach(
          string $file
          )
        
        :
          void

Attach a file to the attachments queue.

Parameters

Name	Type	Description
$file	string	The absolute path to the file

Details

Access: public

clearAttachments(
          
          )
        
        :
          void

Clear all existing attachments.

Details

Access: public

get(
          string $key
          )
        
        :
          mixed

Gets a reference to an attribute of the mail object.

Parameters

Name	Type	Description
$key	string	The attribute key.

Returns

Type	Description
mixed	A reference to the attribute, or null if no attribute value is set for the key.

Details

Access: public

getDefaultAttributes(
          array $attributes
              =
              array()
          )
        
        :
          array

Gets the default attributes for modMail based on system settings

Parameters

Name	Type	Description
$attributes	array	An optional array of default attributes to override with

Returns

Type	Description
array	An array of default attributes

header(
          string $header
          )
        
        :
          boolean

Adds a header to the mailer

Parameters

Name	Type	Description
$header	string	The HTTP header to send.

Returns

Type	Description
boolean	True if the header is valid and is set.

Details

Access: public

reset(
          array $attributes
              =
              array()
          )
        
        :
          void

Reset the mail service, clearing addresses and attributes.

Parameters

Name	Type	Description
$attributes	array	An optional array of attributes to apply after reset.

Details

Access: public

send(
          array $attributes
              =
              array()
          )
        
        :
          boolean

Send an email setting any supplied attributes before sending.

{@internal You should implement the rest of this method in a derivative class.}

Parameters

Name	Type	Description
$attributes	array	Attributes to override any existing attributes before sending.

Returns

Type	Description
boolean	Indicates if the email was sent successfully.

Details

Abstract
Access: public

set(
          string $key, mixed $value
          )
        
        :
          void

Sets the value of an attribute of the mail object.

{@internal Override this method in a derivative to set the appropriate attributes of the actual mailer implementation being used. Make sure to call this parent implementation first and then set the value of the corresponding mailer attribute as a reference to the attribute set in $this->attributes}

Parameters

Name	Type	Description
$key	string	The key of the attribute to set.
$value	mixed	The value of the attribute.

Details

Abstract
Access: public

core/model/modx/mail/modmail.class.php

\modMailjump to top

Constants

Properties

Methods

\modMail
jump to top