AP&C API Reference
Protected Member Functions | Properties | List of all members
Apac.Messaging.Handlers.SmtpMessageHandler Class Reference

This handler uses the .NET framework built-in features for configuring and sending emails using SMTP. The system.net/mailsettings configuration section should be set up properly for this work correctly. This affords the most flexibility when having to route emails internally through a designated mail server. More...

Inheritance diagram for Apac.Messaging.Handlers.SmtpMessageHandler:
Apac.Messaging.Handlers.MessageHandler Apac.Messaging.IMessageHandler

Protected Member Functions

override DeliveryStatus OnDeliver (Message message, MessagingAddress sender, IEnumerable< MessagingAddress > recipients)
 Makes an attempt to deliver message using SMTP (email as configured on the hosting machine). More...
 
- Protected Member Functions inherited from Apac.Messaging.Handlers.MessageHandler
 MessageHandler ()
 Creates a new MessageHandler. More...
 

Properties

override MessagingProtocols SupportedProtocol [get]
 Indicates the one MessagingProtocols that this handler is written to support. More...
 
- Properties inherited from Apac.Messaging.Handlers.MessageHandler
abstract MessagingProtocols SupportedProtocol [get]
 When overridden by subclasses, this property indicates the single protocol supported by the message handler. More...
 
log4net.ILog Log [get]
 Internaly accessible logger. More...
 
- Properties inherited from Apac.Messaging.IMessageHandler
MessagingProtocols SupportedProtocol [get]
 Gets the MessagingProtocols implemented by the handler. More...
 

Additional Inherited Members

- Public Member Functions inherited from Apac.Messaging.Handlers.MessageHandler
DeliveryStatus Deliver (Message message, MessagingAddress sender, IEnumerable< MessagingAddress > recipients)
 Delivers the message according to the message contents and the system's configured messaging participants. More...
 

Detailed Description

This handler uses the .NET framework built-in features for configuring and sending emails using SMTP. The system.net/mailsettings configuration section should be set up properly for this work correctly. This affords the most flexibility when having to route emails internally through a designated mail server.

Member Function Documentation

◆ OnDeliver()

override DeliveryStatus Apac.Messaging.Handlers.SmtpMessageHandler.OnDeliver ( Message  message,
MessagingAddress  sender,
IEnumerable< MessagingAddress recipients 
)
inlineprotectedvirtual

Makes an attempt to deliver message using SMTP (email as configured on the hosting machine).

Parameters
messageThe Message to be delivered.
senderThe entity sending the message.
recipientsThe entities receiving the message.
Returns
Returns the DeliveryStatus containing information about the success or failure of the messaging operation.

Implements Apac.Messaging.Handlers.MessageHandler.

Property Documentation

◆ SupportedProtocol

override MessagingProtocols Apac.Messaging.Handlers.SmtpMessageHandler.SupportedProtocol
get

Indicates the one MessagingProtocols that this handler is written to support.


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