File io/mail/MailService.class.php

 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 

<?php
/**
 * @package     IO
 * @subpackage  Mail
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Benoit SAUTEL <ben.popeye@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2014 12 22
 * @since       PHPBoost 3.0 - 2010 03 08
*/

interface MailService
{
    /**
     * Sends the mail. Throws an exception if the mail cannot be sent.
     * @param Mail $mail The mail to send
     * @throws IOException if the mail couldn't be sent
     */
    function send(Mail $mail);

    /**
     * Tries to send the mail but doesn't throw any error whether the mail cannot be sent,
     * it only returns false.
     * @param Mail $mail The mail to send
     * @return boolean True if the mail could be sent, false otherwise.
     */
    function try_to_send(Mail $mail);

    /**
     * @deprecated
     * Sends the mail.
     * @param string $mail_to The mail recipients' address.
     * @param string $mail_subject The mail subject.
     * @param string $mail_content content of the mail
     * @param string $mail_from The mail sender's address.
     * @param string $sender_name The mail sender's name. If you don't use this parameter, the name of the site administrator will be taken.
     * @return bool True if the mail could be sent, false otherwise.
     */
    function send_from_properties($mail_to, $mail_subject, $mail_content, $mail_from = '', $sender_name = 'admin');

    /**
     * Check whether the mail address is valid, it respects the mail RFC
     * @param string $mail_address
     * @return boolean true if the mail is valid, false otherwise
     */
    function is_mail_valid($mail_address);

    /**
     * Return the RFC mail regex.
     * @return string the mail regex
     */
    function get_mail_checking_regex();

    /**
     * Return the RFC mail regex without delimiters, it's commonly used for compatibility with javascript regex.
     * @return string the mail regex without delimiters
     */
    function get_mail_checking_raw_regex();
}
?>