dolibarr 20.0.0
SMTPs Class Reference

Class to construct and send SMTP compliant email, even to a secure SMTP server, regardless of platform. More...

Public Member Functions

 setOptions ($_options=array())
 Set delivery receipt.
 
 setDeliveryReceipt ($_val=0)
 Set delivery receipt.
 
 getDeliveryReceipt ()
 get delivery receipt
 
 setTrackId ($_val='')
 Set trackid.
 
 setMoreInHeader ($_val='')
 Set moreInHeader.
 
 getTrackId ()
 get trackid
 
 getMoreInHeader ()
 get moreInHeader
 
 setErrorsTo ($_strErrorsTo)
 Set errors to.
 
 getErrorsTo ($_part=true)
 Get errors to.
 
 setDebug ($_vDebug=false)
 Set debug.
 
 buildRCPTlist ()
 build RECIPIENT List, all addresses who will receive this message
 
 sendMsg ()
 Now send the message.
 
 setConfig ($_strConfigPath=null)
 setConfig() is used to populate select class properties from either a user defined INI file or the systems 'php.ini' file
 
 setTransportType ($_type=0)
 Determines the method inwhich the messages are to be sent.
 
 getTransportType ()
 Return the method inwhich the message is to be sent.
 
 setMailPath ($_path)
 Path to the sendmail executable.
 
 setHost ($_strHost)
 Defines the Host Name or IP of the Mail Server to use.
 
 getHost ()
 Retrieves the Host Name or IP of the Mail Server to use This is used only with 'socket' based mail transmission.
 
 setPort ($_intPort)
 Defines the Port Number of the Mail Server to use The default is 25 This is used only with 'socket' based mail transmission.
 
 getPort ()
 Retrieves the Port Number of the Mail Server to use This is used only with 'socket' based mail transmission.
 
 setID ($_strID)
 User Name for authentication on Mail Server.
 
 getID ()
 Retrieves the User Name for authentication on Mail Server.
 
 setPW ($_strPW)
 User Password for authentication on Mail Server.
 
 getPW ()
 Retrieves the User Password for authentication on Mail Server.
 
 setToken ($_strToken)
 User token for OAUTH2.
 
 getToken ()
 Retrieves the User token for OAUTH2.
 
 setCharSet ($_strCharSet)
 Character set used for current message Character set is defaulted to 'iso-8859-1';.
 
 getCharSet ()
 Retrieves the Character set used for current message.
 
 setTransEncode ($_strTransEncode)
 Content-Transfer-Encoding, Defaulted to '7bit' This can be changed for 2byte characters sets Known Encode Types.
 
 getTransEncode ()
 Retrieves the Content-Transfer-Encoding.
 
 setTransEncodeType ($_strTransEncodeType)
 Content-Transfer-Encoding, Defaulted to '0' [ZERO] This can be changed for 2byte characters sets Known Encode Types.
 
 getTransEncodeType ()
 Retrieves the Content-Transfer-Encoding.
 
 setFrom ($_strFrom)
 FROM Address from which mail will be sent.
 
 getFrom ($_part=true)
 Retrieves the Address from which mail will be sent.
 
 setReplyTo ($_strReplyTo)
 Reply-To Address from which mail will be the reply-to.
 
 getReplyTo ($_part=true)
 Retrieves the Address from which mail will be the reply-to.
 
 setInReplyTo ($_strInReplyTo)
 Set References in the list of Msg-Id.
 
 getInReplyTo ()
 Retrieves the InReplyTo from which mail we reply to.
 
 setReferences ($_strReferences)
 Set References in the list of Msg-Id.
 
 getReferences ()
 Retrieves the References from which mail will be the reply-to.
 
 get_RCPT_list ()
 Returns an array of bares addresses for use with 'RCPT TO:' This is a "build as you go" method.
 
 get_email_list ($_which=null)
 Returns an array of addresses for a specific type; TO, CC or BCC.
 
 setTO ($_addrTo)
 TO Address[es] inwhich to send mail to.
 
 getTo ()
 Retrieves the TO Address[es] inwhich to send mail to.
 
 setCC ($_strCC)
 CC Address[es] inwhich to send mail to.
 
 getCC ()
 Retrieves the CC Address[es] inwhich to send mail to.
 
 setBCC ($_strBCC)
 BCC Address[es] inwhich to send mail to.
 
 getBCC ()
 Retrieves the BCC Address[es] inwhich to send mail to.
 
 setSubject ($_strSubject='')
 Message Subject.
 
 getSubject ()
 Retrieves the Message Subject.
 
 getHeader ()
 Constructs and returns message header.
 
 setBodyContent ($strContent, $strType='plain')
 Message Content.
 
 getBodyContent ()
 Retrieves the Message Content.
 
 setAttachment ($strContent, $strFileName='unknown', $strMimeType='unknown', $strCid='')
 File attachments are added to the content array as sub-arrays, allowing for multiple attachments for each outbound email.
 
 setImageInline ($strContent, $strImageName='unknown', $strMimeType='unknown', $strImageCid='unknown')
 Image attachments are added to the content array as sub-arrays, allowing for multiple images for each outbound email.
 
 setSensitivity ($_value=0)
 Message Content Sensitivity Message Sensitivity values:
 
 getSensitivity ()
 Returns Message Content Sensitivity string Message Sensitivity values:
 
 setPriority ($_value=3)
 Message Content Priority Message Priority values:
 
 getPriority ()
 Message Content Priority Message Priority values:
 
 setMD5flag ($_flag=false)
 Set flag which determines whether to calculate message MD5 checksum.
 
 getMD5flag ()
 Gets flag which determines whether to calculate message MD5 checksum.
 
 setXheader ($strXdata)
 Message X-Header Content This is a simple "insert".
 
 getXheader ()
 Retrieves the Message X-Header Content.
 
 server_parse ($socket, $response)
 This function has been modified as provided by SirSir to allow multiline responses when using SMTP Extensions.
 
 socket_send_str ($_strSend, $_returnCode=null, $CRLF="\r\n")
 Send str.
 
 getErrors ()
 Returns applicative errors codes and messages for Class (not the SMTP error code)
 

Private Member Functions

 _server_connect ()
 Attempt a connection to mail server.
 
 _server_authenticate ()
 Attempt mail server authentication for a secure connection.
 
 _buildAddrList ($_type, $_addrList)
 Inserts given addresses into structured format.
 
 _strip_email ($_strAddr)
 Returns an array of the various parts of an email address This assumes a well formed address:
 
 _setBoundary ()
 Generates Random string for MIME message Boundary.
 
 _getBoundary ($type='mixed')
 Retrieves the MIME message Boundary.
 
 _setErr ($_errNum, $_errMsg)
 Defines errors codes and messages for Class.
 

Private Attributes

 $_smtpsHost = 'localhost'
 Host Name or IP of SMTP Server to use.
 
 $_smtpsID = null
 Secure SMTP Server access ID This can be defined via a INI file or via a setter method.
 
 $_smtpsPW = null
 Secure SMTP Server access Password This can be defined via a INI file or via a setter method.
 
 $_smtpsToken = null
 Token in case we use OAUTH2.
 
 $_msgFrom = null
 Who sent the Message This can be defined via a INI file or via a setter method.
 
 $_msgReplyTo = null
 Where are replies and errors to be sent to This can be defined via a INI file or via a setter method.
 
 $_msgInReplyTo = null
 List of In-Reply-To.
 
 $_msgReferences = null
 List of Msg-Id.
 
 $_msgRecipients = null
 Who will the Message be sent to; TO, CC, BCC Multi-diminsional array containing addresses the message will be sent TO, CC or BCC.
 
 $_msgSubject = null
 Message Subject.
 
 $_msgXheader = null
 Custom X-Headers.
 
 $_smtpsCharSet = 'iso-8859-1'
 Character set Defaulted to 'iso-8859-1'.
 
 $_msgSensitivity = 0
 Message Sensitivity Defaults to ZERO - None.
 
 $_arySensitivity
 Message Sensitivity.
 
 $_msgPriority = 3
 Message Sensitivity Defaults to 3 - Normal.
 
 $_aryPriority
 Message Priority.
 
 $_smtpsTransEncodeType = 0
 Content-Transfer-Encoding Defaulted to 0 - 7bit.
 
 $_smtpsTransEncodeTypes
 Content-Transfer-Encoding.
 
 $_smtpsTransEncode = '7bit'
 Content-Transfer-Encoding Defaulted to '7bit'.
 
 $_smtpsBoundary = null
 Boundary String for MIME separation.
 
 $_smtpsRelatedBoundary = null
 Related Boundary.
 
 $_smtpsAlternativeBoundary = null
 Alternative Boundary.
 
 $_transportType = 0
 Determines the method inwhich the message are to be sent.
 
 $_mailPath = '/usr/lib/sendmail'
 If '$_transportType' is set to '1', then this variable is used to define the UNIX file system path to the sendmail executable.
 
 $_smtpTimeout = 10
 Sets the SMTP server timeout in seconds.
 
 $_smtpMD5 = false
 Determines whether to calculate message MD5 checksum.
 
 $_smtpsErrors = null
 Class error codes and messages.
 
 $_log_level = 0
 Defines log level 0 - no logging 1 - connectivity logging 2 - message generation logging 3 - detail logging.
 
 $_debug = false
 Place Class in" debug" mode.
 
 $_options = array()
 An array of options for stream_context_create()
 

Detailed Description

Class to construct and send SMTP compliant email, even to a secure SMTP server, regardless of platform.

Definition at line 48 of file smtps.class.php.

Member Function Documentation

◆ _buildAddrList()

SMTPs::_buildAddrList ( $_type,
$_addrList )
private

Inserts given addresses into structured format.

This method takes a list of given addresses, via an array or a COMMA delimited string, and inserts them into a highly structured array. This array is designed to remove duplicate addresses and to sort them by Domain.

Parameters
string$_typeTO, CC, or BCC lists to add addrresses into
mixed$_addrListArray or COMMA delimited string of addresses
Returns
void

Definition at line 1213 of file smtps.class.php.

References $_msgRecipients.

Referenced by setBCC(), setCC(), and setTO().

◆ _getBoundary()

SMTPs::_getBoundary ( $type = 'mixed')
private

Retrieves the MIME message Boundary.

Parameters
string$typeType of boundary
Returns
string $_smtpsBoundary MIME message Boundary

Definition at line 1954 of file smtps.class.php.

References $_smtpsAlternativeBoundary, $_smtpsBoundary, and $_smtpsRelatedBoundary.

◆ _server_authenticate()

SMTPs::_server_authenticate ( )
private

Attempt mail server authentication for a secure connection.

Returns
boolean|null $_retVal Boolean indicating success or failure of authentication

Definition at line 486 of file smtps.class.php.

References $_smtpsID, $_smtpsToken, _setErr(), getDolGlobalInt(), getDolGlobalString(), getDomainFromURL(), getFrom(), getHost(), and socket_send_str().

Referenced by sendMsg().

◆ _server_connect()

SMTPs::_server_connect ( )
private

Attempt a connection to mail server.

Returns
mixed $_retVal Boolean indicating success or failure on connection

Definition at line 408 of file smtps.class.php.

References _setErr(), getHost(), getPort(), is_ip(), and server_parse().

Referenced by sendMsg().

◆ _setBoundary()

SMTPs::_setBoundary ( )
private

Generates Random string for MIME message Boundary.

Returns
void

Definition at line 1941 of file smtps.class.php.

Referenced by getBodyContent().

◆ _setErr()

SMTPs::_setErr ( $_errNum,
$_errMsg )
private

Defines errors codes and messages for Class.

Parameters
int$_errNumError Code Number
string$_errMsgError Message
Returns
void

Definition at line 2048 of file smtps.class.php.

Referenced by _server_authenticate(), _server_connect(), get_email_list(), server_parse(), and setConfig().

◆ _strip_email()

SMTPs::_strip_email ( $_strAddr)
private

Returns an array of the various parts of an email address This assumes a well formed address:

  • "Real name" usern.nosp@m.ame@.nosp@m.domai.nosp@m.n.tl.nosp@m.d
  • "Real Name" is optional
  • if "Real Name" does not exist, the angle brackets are optional This will split an email address into 4 or 5 parts.
  • $_aryEmail[org] = original string
  • $_aryEmail[real] = "real name" - if there is one
  • $_aryEmail[addr] = address part "username@domain.tld"
  • $_aryEmail[host] = "domain.tld"
  • $_aryEmail[user] = "userName"
Parameters
string$_strAddrEmail address
Returns
array{org:string,real?:string,addr:string,user:string,host:string} An array of the various parts of an email address

Definition at line 1280 of file smtps.class.php.

Referenced by setErrorsTo(), setFrom(), and setReplyTo().

◆ buildRCPTlist()

SMTPs::buildRCPTlist ( )

build RECIPIENT List, all addresses who will receive this message

Returns
void

Definition at line 396 of file smtps.class.php.

References getTo().

◆ get_email_list()

SMTPs::get_email_list ( $_which = null)

Returns an array of addresses for a specific type; TO, CC or BCC.

Parameters
string$_whichWhich collection of addresses to return ('to', 'cc', 'bcc')
Returns
string|false Array of emaill address

Definition at line 1355 of file smtps.class.php.

References _setErr().

Referenced by getBCC(), getCC(), and getTo().

◆ get_RCPT_list()

SMTPs::get_RCPT_list ( )

Returns an array of bares addresses for use with 'RCPT TO:' This is a "build as you go" method.

Each time this method is called the underlying array is destroyed and reconstructed.

Returns
array Returns an array of bares addresses

An array of bares addresses for use with 'RCPT TO:'

Definition at line 1327 of file smtps.class.php.

Referenced by sendMsg().

◆ getBCC()

SMTPs::getBCC ( )

Retrieves the BCC Address[es] inwhich to send mail to.

Returns
string BCC Address[es] inwhich to send mail to

Definition at line 1452 of file smtps.class.php.

References get_email_list().

◆ getBodyContent()

SMTPs::getBodyContent ( )

Retrieves the Message Content.

Returns
string Message Content

Definition at line 1612 of file smtps.class.php.

References _setBoundary(), getCharSet(), getDolGlobalString(), and getMD5flag().

Referenced by sendMsg().

◆ getCC()

SMTPs::getCC ( )

Retrieves the CC Address[es] inwhich to send mail to.

Returns
string CC Address[es] inwhich to send mail to

Definition at line 1429 of file smtps.class.php.

References get_email_list().

Referenced by getHeader().

◆ getCharSet()

SMTPs::getCharSet ( )

Retrieves the Character set used for current message.

Returns
string $_smtpsCharSet Character set used for current message

Definition at line 1016 of file smtps.class.php.

References $_smtpsCharSet.

Referenced by getBodyContent().

◆ getDeliveryReceipt()

SMTPs::getDeliveryReceipt ( )

get delivery receipt

Returns
int Delivery receipt

Definition at line 301 of file smtps.class.php.

Referenced by getHeader().

◆ getErrors()

SMTPs::getErrors ( )

Returns applicative errors codes and messages for Class (not the SMTP error code)

Returns
string $_errMsg Error Message

Definition at line 2061 of file smtps.class.php.

◆ getErrorsTo()

SMTPs::getErrorsTo ( $_part = true)

Get errors to.

Parameters
boolean$_partVariant
Returns
string Errors to

Definition at line 367 of file smtps.class.php.

Referenced by getHeader().

◆ getFrom()

SMTPs::getFrom ( $_part = true)

Retrieves the Address from which mail will be sent.

Parameters
boolean$_partTo "strip" 'Real name' from address
Returns
string Address from which mail will be sent

Definition at line 1108 of file smtps.class.php.

References $_msgFrom.

Referenced by _server_authenticate(), and sendMsg().

◆ getHeader()

SMTPs::getHeader ( )

Constructs and returns message header.

Returns
string Complete message header

Definition at line 1485 of file smtps.class.php.

References getCC(), getDeliveryReceipt(), getErrorsTo(), getInReplyTo(), getMoreInHeader(), getPriority(), getReferences(), getReplyTo(), getSensitivity(), and getTrackId().

Referenced by sendMsg().

◆ getHost()

SMTPs::getHost ( )

Retrieves the Host Name or IP of the Mail Server to use This is used only with 'socket' based mail transmission.

Returns
string $_strHost Host Name or IP of the Mail Server to use

Definition at line 902 of file smtps.class.php.

References $_smtpsHost.

Referenced by _server_authenticate(), _server_connect(), and sendMsg().

◆ getID()

SMTPs::getID ( )

Retrieves the User Name for authentication on Mail Server.

Returns
string User Name for authentication on Mail Server

Definition at line 950 of file smtps.class.php.

References $_smtpsID.

◆ getInReplyTo()

SMTPs::getInReplyTo ( )

Retrieves the InReplyTo from which mail we reply to.

Returns
string Msg-Id of email we reply to

Definition at line 1171 of file smtps.class.php.

References $_msgInReplyTo.

Referenced by getHeader().

◆ getMD5flag()

SMTPs::getMD5flag ( )

Gets flag which determines whether to calculate message MD5 checksum.

Returns
boolean MD5flag

Definition at line 1906 of file smtps.class.php.

References $_smtpMD5.

Referenced by getBodyContent(), setAttachment(), setBodyContent(), and setImageInline().

◆ getMoreInHeader()

SMTPs::getMoreInHeader ( )

get moreInHeader

Returns
string moreInHeader

Definition at line 343 of file smtps.class.php.

Referenced by getHeader().

◆ getPort()

SMTPs::getPort ( )

Retrieves the Port Number of the Mail Server to use This is used only with 'socket' based mail transmission.

Returns
int Port Number of the Mail Server to use

Definition at line 929 of file smtps.class.php.

Referenced by _server_connect().

◆ getPriority()

SMTPs::getPriority ( )

Message Content Priority Message Priority values:

  • [0] 'Bulk'
  • [1] 'Highest'
  • [2] 'High'
  • [3] 'Normal' - default
  • [4] 'Low'
  • [5] 'Lowest'
Returns
string

Definition at line 1883 of file smtps.class.php.

References $_msgPriority.

Referenced by getHeader().

◆ getPW()

SMTPs::getPW ( )

Retrieves the User Password for authentication on Mail Server.

Returns
string User Password for authentication on Mail Server

Definition at line 971 of file smtps.class.php.

References $_smtpsPW.

◆ getReferences()

SMTPs::getReferences ( )

Retrieves the References from which mail will be the reply-to.

Returns
string List of Msg-Id

Definition at line 1196 of file smtps.class.php.

References $_msgReferences.

Referenced by getHeader().

◆ getReplyTo()

SMTPs::getReplyTo ( $_part = true)

Retrieves the Address from which mail will be the reply-to.

Parameters
boolean$_partTo "strip" 'Real name' from address
Returns
string Address from which mail will be the reply-to

Definition at line 1140 of file smtps.class.php.

References $_msgReplyTo.

Referenced by getHeader().

◆ getSensitivity()

SMTPs::getSensitivity ( )

Returns Message Content Sensitivity string Message Sensitivity values:

  • [0] None - default
  • [1] Personal
  • [2] Private
  • [3] Company Confidential
Returns
string|boolean

Definition at line 1845 of file smtps.class.php.

References $_msgSensitivity.

Referenced by getHeader().

◆ getSubject()

SMTPs::getSubject ( )

Retrieves the Message Subject.

Returns
string Message Subject

Definition at line 1475 of file smtps.class.php.

References $_msgSubject.

◆ getTo()

SMTPs::getTo ( )

Retrieves the TO Address[es] inwhich to send mail to.

Returns
string TO Address[es] inwhich to send mail to

Definition at line 1406 of file smtps.class.php.

References get_email_list().

Referenced by buildRCPTlist().

◆ getToken()

SMTPs::getToken ( )

Retrieves the User token for OAUTH2.

Returns
string User token for OAUTH2

Definition at line 992 of file smtps.class.php.

References $_smtpsToken.

◆ getTrackId()

SMTPs::getTrackId ( )

get trackid

Returns
string Track id

Definition at line 333 of file smtps.class.php.

Referenced by getHeader().

◆ getTransEncode()

SMTPs::getTransEncode ( )

Retrieves the Content-Transfer-Encoding.

Returns
string $_smtpsTransEncode Content-Transfer-Encoding

Definition at line 1048 of file smtps.class.php.

References $_smtpsTransEncode.

◆ getTransEncodeType()

SMTPs::getTransEncodeType ( )

Retrieves the Content-Transfer-Encoding.

Returns
string Content-Transfer-Encoding

Definition at line 1081 of file smtps.class.php.

References $_smtpsTransEncodeType.

◆ getTransportType()

SMTPs::getTransportType ( )

Return the method inwhich the message is to be sent.

  • 'sockets' [0] - connect via network to SMTP server
  • 'pipe [1] - use UNIX path to EXE
  • 'phpmail [2] - use the PHP built-in mail function
Returns
int $_strHost Host Name or IP of the Mail Server to use

Definition at line 861 of file smtps.class.php.

References $_transportType.

◆ getXheader()

SMTPs::getXheader ( )

Retrieves the Message X-Header Content.

Returns
array $_msgContent Message X-Header Content

Definition at line 1931 of file smtps.class.php.

References $_msgXheader.

◆ sendMsg()

SMTPs::sendMsg ( )

◆ server_parse()

SMTPs::server_parse ( $socket,
$response )

This function has been modified as provided by SirSir to allow multiline responses when using SMTP Extensions.

Parameters
resource$socketSocket handler
string$responseExpected response ('250', ...). Example of response we can get: "421 4.7.0 Try again later, closing connection. (EHLO) nb21-20020a1709071c9500b0093d0d964affsm869534ejc.73 - gsmtp" "550 5.7.1 https://support.google.com/a/answer/6140680#invalidcred j21sm814390wre.3"
Returns
boolean True or false

Returns constructed SELECT Object string or boolean upon failure Default value is set at true

Definition at line 1977 of file smtps.class.php.

References _setErr().

Referenced by _server_connect(), and socket_send_str().

◆ setAttachment()

SMTPs::setAttachment ( $strContent,
$strFileName = 'unknown',
$strMimeType = 'unknown',
$strCid = '' )

File attachments are added to the content array as sub-arrays, allowing for multiple attachments for each outbound email.

Parameters
string$strContentFile data to attach to message
string$strFileNameFile Name to give to attachment
string$strMimeTypeFile Mime Type of attachment
string$strCidFile Cid of attachment (if defined, to be shown inline)
Returns
void

Definition at line 1771 of file smtps.class.php.

References dol_hash(), and getMD5flag().

◆ setBCC()

SMTPs::setBCC ( $_strBCC)

BCC Address[es] inwhich to send mail to.

Parameters
string$_strBCCRecipients BCC Address[es] inwhich to send mail to
Returns
void

Definition at line 1440 of file smtps.class.php.

References _buildAddrList().

◆ setBodyContent()

SMTPs::setBodyContent ( $strContent,
$strType = 'plain' )

Message Content.

Parameters
string$strContentMessage Content
string$strTypeType
Returns
void

Definition at line 1569 of file smtps.class.php.

References dol_hash(), and getMD5flag().

◆ setCC()

SMTPs::setCC ( $_strCC)

CC Address[es] inwhich to send mail to.

Parameters
string$_strCCCC Address[es] inwhich to send mail to
Returns
void

Definition at line 1417 of file smtps.class.php.

References _buildAddrList().

◆ setCharSet()

SMTPs::setCharSet ( $_strCharSet)

Character set used for current message Character set is defaulted to 'iso-8859-1';.

Parameters
string$_strCharSetCharacter set used for current message
Returns
void

Definition at line 1004 of file smtps.class.php.

◆ setConfig()

SMTPs::setConfig ( $_strConfigPath = null)

setConfig() is used to populate select class properties from either a user defined INI file or the systems 'php.ini' file

If a user defined INI is to be used, the files complete path is passed as the method single parameter. The INI can define any class and/or user properties. Only properties defined within this file will be setter and/or orverwritten

If the systems 'php.ini' file is to be used, the method is called without parameters. In this case, only HOST, PORT and FROM properties will be set as they are the only properties that are defined within the 'php.ini'.

If secure SMTP is to be used, the user ID and Password can be defined with the user INI file, but the properties are not defined with the systems 'php.ini'file, they must be defined via their setter methods

This method can be called twice, if desired. Once without a parameter to load the properties as defined within the systems 'php.ini' file, and a second time, with a path to a user INI file for other properties to be defined.

Parameters
mixed$_strConfigPathpath to config file or VOID
Returns
boolean

Returns constructed SELECT Object string or boolean upon failure Default value is set at true

Definition at line 800 of file smtps.class.php.

References _setErr(), setFrom(), setHost(), and setPort().

◆ setDebug()

SMTPs::setDebug ( $_vDebug = false)

Set debug.

Parameters
boolean$_vDebugValue for debug
Returns
void

Definition at line 386 of file smtps.class.php.

◆ setDeliveryReceipt()

SMTPs::setDeliveryReceipt ( $_val = 0)

Set delivery receipt.

Parameters
int$_valValue
Returns
void

Definition at line 291 of file smtps.class.php.

◆ setErrorsTo()

SMTPs::setErrorsTo ( $_strErrorsTo)

Set errors to.

Parameters
string$_strErrorsToErrors to
Returns
void

Definition at line 354 of file smtps.class.php.

References _strip_email().

◆ setFrom()

SMTPs::setFrom ( $_strFrom)

FROM Address from which mail will be sent.

Parameters
string$_strFromAddress from which mail will be sent
Returns
void

Definition at line 1095 of file smtps.class.php.

References _strip_email().

Referenced by setConfig().

◆ setHost()

SMTPs::setHost ( $_strHost)

Defines the Host Name or IP of the Mail Server to use.

This is defaulted to 'localhost' This is used only with 'socket' based mail transmission

Parameters
string$_strHostHost Name or IP of the Mail Server to use
Returns
void

Definition at line 889 of file smtps.class.php.

Referenced by setConfig().

◆ setID()

SMTPs::setID ( $_strID)

User Name for authentication on Mail Server.

Parameters
string$_strIDUser Name for authentication on Mail Server
Returns
void

Definition at line 940 of file smtps.class.php.

◆ setImageInline()

SMTPs::setImageInline ( $strContent,
$strImageName = 'unknown',
$strMimeType = 'unknown',
$strImageCid = 'unknown' )

Image attachments are added to the content array as sub-arrays, allowing for multiple images for each outbound email.

Parameters
string$strContentImage data to attach to message
string$strImageNameImage Name to give to attachment
string$strMimeTypeImage Mime Type of attachment
string$strImageCidCID
Returns
void

Definition at line 1800 of file smtps.class.php.

References dol_hash(), and getMD5flag().

◆ setInReplyTo()

SMTPs::setInReplyTo ( $_strInReplyTo)

Set References in the list of Msg-Id.

Parameters
string$_strInReplyToList of Msg-Id
Returns
void

Definition at line 1159 of file smtps.class.php.

◆ setMailPath()

SMTPs::setMailPath ( $_path)

Path to the sendmail executable.

Parameters
string$_pathPath to the sendmail executable
Returns
boolean

Definition at line 873 of file smtps.class.php.

◆ setMD5flag()

SMTPs::setMD5flag ( $_flag = false)

Set flag which determines whether to calculate message MD5 checksum.

Parameters
boolean$_flagMD5flag
Returns
void

Definition at line 1896 of file smtps.class.php.

◆ setMoreInHeader()

SMTPs::setMoreInHeader ( $_val = '')

Set moreInHeader.

Parameters
string$_valValue
Returns
void

Definition at line 323 of file smtps.class.php.

◆ setOptions()

SMTPs::setOptions ( $_options = array())

Set delivery receipt.

Parameters
array$_optionsAn array of options for stream_context_create()
Returns
void

Definition at line 280 of file smtps.class.php.

References $_options.

◆ setPort()

SMTPs::setPort ( $_intPort)

Defines the Port Number of the Mail Server to use The default is 25 This is used only with 'socket' based mail transmission.

Parameters
int | string$_intPortPort Number of the Mail Server to use
Returns
void

Definition at line 915 of file smtps.class.php.

Referenced by setConfig().

◆ setPriority()

SMTPs::setPriority ( $_value = 3)

Message Content Priority Message Priority values:

  • [0] 'Bulk'
  • [1] 'Highest'
  • [2] 'High'
  • [3] 'Normal' - default
  • [4] 'Low'
  • [5] 'Lowest'
Parameters
integer$_valueMessage Priority
Returns
void

Definition at line 1863 of file smtps.class.php.

◆ setPW()

SMTPs::setPW ( $_strPW)

User Password for authentication on Mail Server.

Parameters
string$_strPWUser Password for authentication on Mail Server
Returns
void

Definition at line 961 of file smtps.class.php.

◆ setReferences()

SMTPs::setReferences ( $_strReferences)

Set References in the list of Msg-Id.

Parameters
string$_strReferencesList of Msg-Id
Returns
void

Definition at line 1184 of file smtps.class.php.

◆ setReplyTo()

SMTPs::setReplyTo ( $_strReplyTo)

Reply-To Address from which mail will be the reply-to.

Parameters
string$_strReplyToAddress from which mail will be the reply-to
Returns
void

Definition at line 1127 of file smtps.class.php.

References _strip_email().

◆ setSensitivity()

SMTPs::setSensitivity ( $_value = 0)

Message Content Sensitivity Message Sensitivity values:

  • [0] None - default
  • [1] Personal
  • [2] Private
  • [3] Company Confidential
Parameters
integer$_valueMessage Sensitivity
Returns
void

Definition at line 1827 of file smtps.class.php.

◆ setSubject()

SMTPs::setSubject ( $_strSubject = '')

Message Subject.

Parameters
string$_strSubjectMessage Subject
Returns
void

Definition at line 1463 of file smtps.class.php.

◆ setTO()

SMTPs::setTO ( $_addrTo)

TO Address[es] inwhich to send mail to.

Parameters
string$_addrToTO Address[es] inwhich to send mail to
Returns
void

Definition at line 1394 of file smtps.class.php.

References _buildAddrList().

◆ setToken()

SMTPs::setToken ( $_strToken)

User token for OAUTH2.

Parameters
string$_strTokenUser token
Returns
void

Definition at line 982 of file smtps.class.php.

◆ setTrackId()

SMTPs::setTrackId ( $_val = '')

Set trackid.

Parameters
string$_valValue
Returns
void

Definition at line 312 of file smtps.class.php.

◆ setTransEncode()

SMTPs::setTransEncode ( $_strTransEncode)

Content-Transfer-Encoding, Defaulted to '7bit' This can be changed for 2byte characters sets Known Encode Types.

  • 7bit Simple 7-bit ASCII
  • 8bit 8-bit coding with line termination characters
  • base64 3 octets encoded into 4 sextets with offset
  • binary Arbitrary binary stream
  • mac-binhex40 Macintosh binary to hex encoding
  • quoted-printable Mostly 7-bit, with 8-bit characters encoded as "=HH"
  • uuencode UUENCODE encoding
Parameters
string$_strTransEncodeContent-Transfer-Encoding
Returns
void

Definition at line 1036 of file smtps.class.php.

◆ setTransEncodeType()

SMTPs::setTransEncodeType ( $_strTransEncodeType)

Content-Transfer-Encoding, Defaulted to '0' [ZERO] This can be changed for 2byte characters sets Known Encode Types.

  • [0] 7bit Simple 7-bit ASCII
  • [1] 8bit 8-bit coding with line termination characters
  • [2] base64 3 octets encoded into 4 sextets with offset
  • [3] binary Arbitrary binary stream
  • [4] mac-binhex40 Macintosh binary to hex encoding
  • [5] quoted-printable Mostly 7-bit, with 8-bit characters encoded as "=HH"
  • [6] uuencode UUENCODE encoding
Parameters
string$_strTransEncodeTypeContent-Transfer-Encoding
Returns
void

Definition at line 1069 of file smtps.class.php.

◆ setTransportType()

SMTPs::setTransportType ( $_type = 0)

Determines the method inwhich the messages are to be sent.

  • 'sockets' [0] - connect via network to SMTP server
  • 'pipe [1] - use UNIX path to EXE
  • 'phpmail [2] - use the PHP built-in mail function
Parameters
int$_typeInteger value representing Mail Transport Type
Returns
void

Definition at line 846 of file smtps.class.php.

◆ setXheader()

SMTPs::setXheader ( $strXdata)

Message X-Header Content This is a simple "insert".

Whatever is given will be placed "as is" into the Xheader array.

Parameters
string$strXdataMessage X-Header Content
Returns
void

Definition at line 1919 of file smtps.class.php.

◆ socket_send_str()

SMTPs::socket_send_str ( $_strSend,
$_returnCode = null,
$CRLF = "\r\n" )

Send str.

Parameters
string$_strSendString to send
string$_returnCodeExpected return code
string$CRLFCRLF
Returns
boolean|null True or false

Definition at line 2020 of file smtps.class.php.

References server_parse().

Referenced by _server_authenticate(), and sendMsg().

Member Data Documentation

◆ $_transportType

SMTPs::$_transportType = 0
private

Determines the method inwhich the message are to be sent.

  • 'sockets' [0] - connect via network to SMTP server - default
  • 'pipe [1] - use UNIX path to EXE
  • 'phpmail [2] - use the PHP built-in mail function NOTE: Only 'sockets' is implemented

Definition at line 207 of file smtps.class.php.

Referenced by getTransportType().


The documentation for this class was generated from the following file: