SMIMEEmail Tasks

Properties   Configuration Settings  

The SMIMEEmail Task adds S/MIME-protected email capability to the SSIS Package.

Remarks

The SMIMEEmail Task adds support for sending and receiving S/MIME-protected emails to BizTalk Server. The task allows you to encrypt and sign emails before sending and decrypt and verify signatures on received emails.

SMIMEEmail Receiver Task

The SMIMEEmail Receiver task is the S/MIME enabled equivalent of the Email Receive task. In addition to standard IMAP and POP3 functions, the SMIMEEmail Receiver task can decrypt and/or verify message signatures. In order to use the SMIMEEmail Receiver task, you must first select a ServerType. You must also enter a MailServer and User. For servers that require authentication, you will also have to enter a Password. To activate SSL, you must also set the SSLAcceptServerCert and SSLStartMode. The adapter will attempt to determine the correct port to connect to based on the server type and SSL settings. However, you may override the default by directly setting the MailPort in the property pages.

Once you have your port set up, the task will connect to the server once every PollingInterval and download messages. To control how the messages are downloaded, or to prevent duplicate messages from being fetched from the mail server, you may set the DeleteMode to an appropriate value. For IMAP connections, you may also set a Filter.

The task will populate the MessageList property with the information retrieved from the downloaded emails.

When it receives an email, the SMIMEEmail Reciever task will detect if the message is encrypted and attempt to decrypt it using the certificate in the Certificate property. If the message is signed, it will also attempt to verify the signature using the certificate in the SignerCert property.

SMIMEEmail Sender Task

The SMIMEEmail Sender Task is a complete SMTP client that can also encrypt and sign emails. To send emails from the task you must set at a minimum your SMTPServer, as well as your From and SendTo email addresses. Should you need to guarantee a secure transmission, you may set the SSLCert and SSLStartMode properties, as well as a specific SSLAcceptServerCert.

You may also add carbon copy and blind carbon copy recipients via the Cc and BCc properties. If you wish to receive delivery or read notifications, you can set the DeliveryReceipt and ReadReceipt properties. You may set the Subject of your message. The contents of the outbound message will be sent as the body of the email.

If you want to encrypt an email you are sending, set the RecipientCert property to the receiver's certificate, set the EncryptData property to true, and set EncryptingAlgorithm to the encryption algorithm you want to use. To sign an email, set the Certificate property to your certificate, set the SignData property to true, and set the SigningAlgorithm property to the hash algorithm you want to use for signing.

Receiver Property List


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

AttachmentDirectorySpecifies the directory to which attachments are saved.
AuthModeThe authentication mode to be used when connecting to the MailServer .
CertificateThe Certificate used to sign (Encoder) and decrypt (Decoder) messages.
DeleteControls if the email is deleted after download.
FilterA filter to be applied to the inbox when selecting messages.
FirewallA set of properties related to firewall access.
IncludeHeadersInstructs the task to include or ignore message headers.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
MailFolderName of the mailbox selected on the server.
MailPortThe port of the mail server (IMAP or POP3).
MailServerThe name or address of the mail server (IMAP or POP3).
MessageListString denoting the name of the variable which contains the last message listing entries.
OAuthAuthorizationOAuth Authorization Information.
OperationThe operation which will be executed by the Email task.
OtherDefines a set of configuration settings to be used by the task.
PasswordA password for login.
PersistentConnectionInstructs the task whether to keep the connection to the server open.
RequireEncryptionWhether an error should be thrown if a received message is not encrypted.
RequireOAEPWhether an error should be thrown if OAEP was not used to encrypt the incoming message.
RequirePSSWhether an error should be thrown if RSA-PSS was not used to encrypt the incoming message.
RequireSignatureWhether an error should be thrown if a received message is not signed.
RuntimeLicenseSpecifies the task runtime license key.
ServerTypeThe type of server for your email account.
SignerCertContains the certificate of the message signer.
SSLAcceptServerCertInstructs the task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the task to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the task starts the SSL negotiation.
TempPathThe path to which temporary files are written at runtime.
TimeoutA timeout for the task.
UserA user id for login.

Sender Property List


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

AttachmentsSpecifies which files the task should include as attachments in the outgoing message.
AuthModeThe authentication mode to be used when connecting to the MailServer .
BCcA comma separated list of addresses for blind carbon copies (optional).
CcA comma separated list of addresses for carbon copies (optional).
CertificateThe Certificate used to sign (Encoder) and decrypt (Decoder) messages.
DeliveryReceiptWhether or not a delivery receipt should be returned to the sender.
EncryptDataWhether to encrypt the MIME data.
EncryptingAlgorithmThe algorithm to use for encryption.
FirewallA set of properties related to firewall access.
FromThe email address of the sender (required).
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.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
MessageHeadersMessage headers associated with the current email message.
MessageHTMLThe HTML text of the message.
MessageTextThe text of the mail message (optional).
OAuthAuthorizationOAuth Authorization Information.
OtherDefines a set of configuration settings to be used by the task.
PasswordA password for login.
PersistentConnectionInstructs the task whether to keep the connection to the server open.
ReadReceiptWhether or not a receipt should be sent when the email has been read.
RecipientCertThe certificate used to encrypt the MIME data.
ReplyToA mail address to reply to (optional).
RuntimeLicenseSpecifies the task runtime license key.
SendToA comma separated list of addresses for destinations (required).
SignDataWhether to sign the MIME data.
SigningAlgorithmTextual description of the signature hash algorithm.
SMTPMessageIdThe id of the mail message (optional).
SMTPPortThe server port for SMTP (default 25).
SMTPServerThe name or address of a mail server (mail relay).
SSLAcceptServerCertInstructs the task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the task to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the task starts the SSL negotiation.
SubjectThe subject of the mail message (optional).
TempPathThe path to which temporary files are written at runtime.
TimeoutA timeout for the task.
UseOAEPWhether to use OAEP when encrypting the MIME data.
UsePSSWhether to use RSA-PSS when signing.
UserA user id for login.

Configuration Settings


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

AddAttachmentsAsMessagePartsIncludes attachments as additional parts on the message.
AttachmentNameSourceSpecifies the source location in the MIME entity from which the filename is retrieved.
AttachmentName[index]Filename for the attached file (at index).
AutoDecodeHeadersWhether to decode headers.
AutoDecodeMessageTextWhether to decode non-MIME message text.
DuplicateAttachmentActionSpecifies what action to take when a duplicate filename is encountered.
FoldHeadersWhether incoming message headers should be folded.
LogoffWhether or not to logoff from the server after execution.
MaskSensitiveWhether sensitive properties should be masked when logging.
MessageHTMLFileSpecifies a file that will be included as the email's HTML content.
MoveToSpecifies the IMAP folder on the server to which messages will be moved.
ReturnOnlyPlainTextPartSpecifies if the task should return the first plain text part or the entire message.
ReturnPathSets the Return-Path to be used for sending email.
UIDModeIf True, permanent message identifiers will be used instead of temporary identifiers.
ReuseSSLSessionDetermines if the SSL session is reused.
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.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLSNamedGroupsThe supported (EC)DHE groups.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the task whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2020 /n software inc. - All rights reserved.
/n software Tasks for SSIS - Version 20.0 [Build 7527]