IPWorks S/MIME 2020 PHP Edition

Questions / Feedback?

SSMTP Class

Properties   Methods   Events   Configuration Settings   Errors  

The SSMTP Class is used to send Internet mail using the SMTP protocol (the Internet mail standard).

Class Name

IPWorksSMIME_SSMTP

Procedural Interface

 ipworkssmime_ssmtp_open();
 ipworkssmime_ssmtp_close($res);
 ipworkssmime_ssmtp_register_callback($res, $id, $function);
 ipworkssmime_ssmtp_get_last_error($res);
 ipworkssmime_ssmtp_get_last_error_code($res);
 ipworkssmime_ssmtp_set($res, $id, $index, $value);
 ipworkssmime_ssmtp_get($res, $id, $index);
 ipworkssmime_ssmtp_do_addrecipientcert($res, $certencoded);
 ipworkssmime_ssmtp_do_config($res, $configurationstring);
 ipworkssmime_ssmtp_do_connect($res);
 ipworkssmime_ssmtp_do_disconnect($res);
 ipworkssmime_ssmtp_do_doevents($res);
 ipworkssmime_ssmtp_do_encrypt($res);
 ipworkssmime_ssmtp_do_expand($res, $emailaddress);
 ipworkssmime_ssmtp_do_interrupt($res);
 ipworkssmime_ssmtp_do_processqueue($res, $queuedir);
 ipworkssmime_ssmtp_do_queue($res, $queuedir);
 ipworkssmime_ssmtp_do_reset($res);
 ipworkssmime_ssmtp_do_resetheaders($res);
 ipworkssmime_ssmtp_do_send($res);
 ipworkssmime_ssmtp_do_sendtoterminalandemail($res);
 ipworkssmime_ssmtp_do_sendtoterminalonly($res);
 ipworkssmime_ssmtp_do_sendtoterminaloremail($res);
 ipworkssmime_ssmtp_do_sign($res);
 ipworkssmime_ssmtp_do_signandencrypt($res);
 ipworkssmime_ssmtp_do_verify($res, $emailaddress);

Remarks

The SSMTP Class is the S/MIME enabled equivalent of the IPWorks SMTP Class. In addition to standard SMTP functions the SSMTP class can sign and/or encrypt messages in a PKCS envelope. The methods and properties for encrypting and signing are identical to those provided with the S/MIME Class. After setting the certificate properties, and specifying MessageText, call the Encrypt, Sign or SignAndEncrypt method before sending and the result will be stored in MessageText.

The SSMTP Class implements a standard SMTP client as specified in RFC 821. It has a simple plug-and-play interface. It contains a number of properties like SendTo, Subject, From, Cc, BCc, etc. that map directly to the internet mail message headers with the same name (RFC 822). The message text is set in MessageText. Messages are sent by calling the Send method.

The class supports message delivery to multiple recipients through the SendTo, Cc, and BCc properties. Simply specify the destination email addresses separated by commas.

The interface of the class is open-ended. New features, including MIME attachments can be supported by using the OtherHeaders property.

A number of events provide feedback during the operation of the class. The Transfer event is fired during message delivery to show the number of bytes delivered. The PITrail event traces the commands that are sent to the server and the respective replies.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AllowExtensionsA switch allowing the class to use ESMTP features (SMTP extensions).
AuthMechanismUsed when connecting to the mail server.
BCcA comma separated list of addresses for blind carbon copies (optional).
CcA comma separated list of addresses for carbon copies (optional).
CertEncodedThe certificate (PEM/base64 encoded).
CertStoreThe name of the certificate store for the client certificate.
CertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
CertStoreTypeThe type of certificate store for this certificate.
CertSubjectThe subject of the certificate used for client authentication.
CommandUsed to send additional commands directly to the server.
ConnectedShows whether the class is connected.
DeliveryNotificationToEmail address to send to which to send a delivery notification.
EncryptingAlgorithmTextual description of the encrypting algorithm.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FromThe email address of the sender (required).
IdleThe current status of the class.
ImportanceImportance of the mail message (optional).
IncludeCertificateSpecifies whether to include the signer's certificate with the signed message.
IncludeChainSpecifies whether to include the signer's certificate chain with the signed message.
LastReplyThe last reply from the server.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPortThe server port for SMTP (default 25).
MailServerThe name or address of a mail server (mail relay).
MessageProvides a way to set the raw message content.
MessageDateDate of the mail message (optional).
MessageHeaderCountThe number of records in the MessageHeader arrays.
MessageHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
MessageHeaderValueThis property contains the header contents.
MessageHeadersStringString representation of RFC822-encoded headers of the message.
MessageIdThe Message Identifier for the message.
MessageRecipientCountThe number of records in the MessageRecipient arrays.
MessageRecipientAddressThis property contains the email address of the recipient.
MessageRecipientNameThis property contains name of the recipient.
MessageRecipientOptionsThis property contains the recipient sending options (used only by SMTP).
MessageRecipientTypeThis property contains the recipient type: To, Cc, or BCc.
MessageTextThe full text of the message to send (without headers).
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
PasswordA password for logon to the MailServer .
PriorityPriority of the mail message (optional).
ReadReceiptToEmail address to send a read receipt to.
ReplyToA mail address to which to reply (optional).
ReturnPathSets the Return-Path to be used for sending email.
SendToA comma separated list of addresses for destinations (required).
SensitivitySensitivity of the mail message (optional).
SigningAlgorithmTextual description of the signature hash algorithm.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
SSLStartModeDetermines how the class starts the SSL negotiation.
SubjectThe subject of the mail message (optional).
TimeoutA timeout for the class.
UserA user identifier to login as in the MailServer .

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddRecipientCertUsed to add recipient certificates used to encrypt messages.
ConfigSets or retrieves a configuration setting.
ConnectConnects to the mail relay and sends the SMTP HELO command.
DisconnectDisconnects from the SMTP server.
DoEventsProcesses events from the internal message queue.
EncryptEncrypts the message.
ExpandAsks the MailServer to expand a name or mailing list.
InterruptInterrupt the current method.
ProcessQueueSends the messages which have previously been queued into QueueDir .
QueueQueues the message into QueueDir .
ResetReset the class.
ResetHeadersResets all the message headers to empty.
SendSends the current message.
SendToTerminalAndEmailSends to terminal and email.
SendToTerminalOnlySends to terminal only.
SendToTerminalOrEmailSends to terminal or email.
SignSigns the current message.
SignAndEncryptSigns and encrypts the current message.
VerifySends a Verification request to the SMTP server.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ConnectionStatusFired to indicate changes in connection state.
EndTransferFired when the message text completes transferring.
ErrorInformation about errors during data delivery.
ExpandFired for every email address returned by the server when the Expand method is called.
PITrailTraces the commands sent to the mail server, and the respective replies.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when the message text starts transferring.
TransferFired while the message text gets transferred to MailServer .

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

AllowEmptyToIf set to True, then the SendTo property is not required.
AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
CharsetWhen set, the message headers will be encoded using the specified Charset.
HelloThe argument for HELO (herald) command to the server (defaults to local host name).
KeepQueueIf set to True, queued files are not deleted after a successful send.
MaxHeaderLengthMaximum length for headers to avoid line folding (default 80).
MessageHeadersStringString representation of RFC822-encoded headers of the message.
MessageIdAlgorithmDetermines the algorithm used to hash the random MessageId.
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
ReturnPathSets the Return-Path to be used for sending email.
SendRSETWhether to send RSET command.
StopOnBccErrorsInstructs the class to stop sending the message if the server does not acknowledge any of the BCCs.
StopOnCcErrorsInstructs the class to stop sending the message if the server does not acknowledge any of the CCs.
StopOnToErrorsInstructs the class to stop sending the message if the server does not acknowledge any of the TOs.
TransferTextThe current portion of the message being sent.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 PHP Edition - Version 20.0 [Build 7721]