SendEmail(SessionCriteria,Boolean,String,String,String,String,Int32,Boolean,String,String) Method

In This Topic

Send the completed package overriding the server connection information stored in the configuration, including port and SSL.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Sub SendEmail( _
   ByVal sessions As SessionCriteria, _
   ByVal markAsRead As Boolean, _
   ByVal emailSubject As String, _
   ByVal fromAddress As String, _
   ByVal destinationAddress As String, _
   ByVal emailServer As String, _
   ByVal serverPort As Integer, _
   ByVal useSsl As Boolean, _
   ByVal emailServerUser As String, _
   ByVal emailServerPassword As String _
)

public void SendEmail( 
   SessionCriteria sessions,
   bool markAsRead,
   string emailSubject,
   string fromAddress,
   string destinationAddress,
   string emailServer,
   int serverPort,
   bool useSsl,
   string emailServerUser,
   string emailServerPassword
)

Parameters

sessions: The set of match rules to apply to sessions to determine what to send.
markAsRead: True to have every included session marked as read upon successful completion.
emailSubject: Optional. A subject line for the email. If left empty a subject line will be generated.
fromAddress: Optional. The email address the package will appear to come from. If empty the destination address will be used.
destinationAddress: Optional. The email address to send the package to. If empty the application configuration value will be used.
emailServer: The full DNS name of the SMTP server to use to relay the mail message.
serverPort: Optional. The TCP/IP Port number to connect to the server on. Use 0 for the default configured port.
useSsl: True to encrypt the server communication with Secure Sockets Layer.
emailServerUser: Optional. A user name to use instead of the current windows user credentials to communicate with the email server.
emailServerPassword: Optional. A password to use for the user name for credentials to communicate with the email server.

Exceptions

Exception	Description
Gibraltar.GibraltarException	Indicates a failure to generate the package.
System.Net.Mail.SmtpException	Indicates a failure to send the email once the package was created.

Remarks

Multiple criteria can be specified and all matching sessions will be sent. Sessions that match more than one item will be sent only once. All criteria are considered inclusive, adding the sessions they match.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Packager Class
Packager Members
Overload List

Send Feedback