ICIAS2OutboundSettings Interface

The ICIAS2OutboundSettings interface is used to define the AS2 outbound (send) transaction settings for a partner account.

interface ICIAS2OutboundSettings : IDispatch

See also:

NOTE: "Sub" indicates that the member is a method; "Property" indicates that it is a property.

Members

Property AS2ID As String

Specifies or retrieves the AS2 ID of the file sender.

HRESULT AS2ID([out, retval] BSTR* pVal);
HRESULT AS2ID([in] BSTR newVal);

Example (VBScript)

Retrieving:

MsgBox "My AS2 ID is: " & oAS2O.AS2ID

Specifying:

oAS2O.AS2ID = "my_as2_id"

EFT v6.3 and later

Property AsyncReceiptTimeoutMin As Long

Specifies or retrieves the maximum wait time (in minutes) for asynchronous AS2 receipt. This property is applicable only if asynchronous receipt is requested (i.e., ReceiptPolicy property is not set to NoReceipt and ReceiptDelivery property is set to Async).

HRESULT AsyncReceiptTimeoutMin[out, retval] LONG* pVal);
HRESULT AsyncReceiptTimeoutMin([in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 asynchronous receipt timeout: " & CStr(oAS2O.AsyncReceiptTimeoutMin)

Specifying:

oAS2O.AsyncReceiptTimeoutMin = 6000

EFT v6.3 and later

Property Compress As Boolean

Specifies or retrieves whether an AS2 file will be compressed before sending.

HRESULT Compress([out, retval] VARIANT_BOOL* pVal);
HRESULT Compress([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 compress message: " & CStr(oAS2O.Compress)

Specifying:

oAS2O.Compress = False

EFT v6.3 and later

Property ContentType As AS2ContentType

Specifies or retrieves content type of AS2 message to send.

HRESULT ContentType([out,retval] AS2ContentType* pVal);
HRESULT ContentType([in] AS2ContentType newVal);

Example (VBScript):

Retrieving:

if XML = oAS2O.ContentType then
MsgBox "AS2 content type: XML"
end if

Specifying:

oAS2O.ContentType = Plaintext

EFT v6.3 and later

Property CustomHeaders As String

HRESULT CustomHeaders([out, retval] BSTR* pVal);
HRESULT CustomHeaders([in] BSTR newVal);

EFT v7.4.11 and later

Property DeleteSourceFile As Boolean

Specifies or retrieves whether source file will be removed after successful delivery to AS2 partner.

HRESULT DeleteSourceFile([out, retval] VARIANT_BOOL* pVal);
HRESULT DeleteSourceFile([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 delete source file: " & oAS2O.DeleteSourceFile

Specifying:

oAS2O.DeleteSourceFile = False

EFT v6.3 and later

Property Encrypt As Boolean

Specifies or retrieves whether an AS2 message will be encrypted with the AS2 partner certificate.

HRESULT Encrypt([out, retval] VARIANT_BOOL* pVal);
HRESULT Encrypt([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 encrypt message: " & CStr(oAS2O.Encrypt)

Specifying:

oAS2O.Encrypt = True

EFT v6.3 and later

Property EncryptionAlgorithm As AS2EncryptionAlgorithm

Used to specify the encryption algorithm for outbound AS2 transfers.

EFT v7.4.9 and later.

Property FileExcludeMask As String

Specifies or retrieves which of the files must NOT be sent using the file mask.

HRESULT FileExcludeMask([out, retval] BSTR* pVal);
HRESULT FileExcludeMask([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 exclude mask is: " & oAS2O.FileExcludeMask

Specifying:

oAS2O.FileExcludeMask = "*.*"

EFT v6.3 and later

Property FileIncludeMask As String

Specifies or retrieves which of the files must be sent using the file mask.

HRESULT FileIncludeMask([out, retval] BSTR* pVal);
HRESULT FileIncludeMask([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 include mask is: " & oAS2O.FileIncludeMask

Specifying:

oAS2O.FileIncludeMask = "*.* "

EFT v6.3 and later

Function GetFailureCommand() As Object

Retrieve ICICommandActionParams interface, which specified the custom command to occur upon failure.

HRESULT GetFailureCommand([out, retval] IDispatch** ppdispCommandParams);

Example (VBScript):

Set oCmd = oAS2O.GetFailureCommand()

EFT v6.3 and later

Function GetFailureEmail() As Object

Retrieves the ICIMailActionParams interface, which specified e-mail notification parameters that will be sent after the failed transaction happens.

HRESULT GetFailureEmail([out, retval] IDispatch** ppdispEmailParams);

Example (VBScript):

Set oMailParams = oAS2O.GetFailureEmail()

EFT v6.3 and later

Function GetSuccessCommand() As Object

Retrieves ICICommandActionParams interface, which specified a custom command to occur upon successful transaction.

HRESULT GetSuccessCommand([out, retval] IDispatch** ppdispCommandParams);

Example (VBScript):

Set oCmd = oAS2O.GetSuccessCommand()

EFT v6.3 and later

Function GetSuccessEmail() As Object

Retrieves the ICIMailActionParams interface, which specified e-mail notification parameters that will be sent after successful transaction happened.

HRESULT GetSuccessEmail([out, retval] IDispatch** ppdispEmailParams);

Example (VBScript):

Set oMailParams = oAS2O.GetSuccessEmail()

EFT v6.3 and later

Property Host As String

Specifies or retrieves the remote host to which you are sending an AS2 file, and the protocol prefix, http:// or https://. If no protocol prefix is specified, plain HTTP protocol will be used.

HRESULT Host([out, retval] BSTR* pVal);
HRESULT Host([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 destination host: " & oAS2O.Host

Specifying:

oAS2O.Host = "192.168.0.88"

EFT v6.3 and later

Property MailboxPath As String

(EFT v6.3.0.57 only; see RemotePath.)

Retrieves or specifies a destination directory path.

HRESULT MailboxPath([out, retval] BSTR* pVal);
HRESULT MailboxPath([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 destination path: " & oAS2O.MailboxPath

Specifying:

oAS2O.MailboxPath = "/"

EFT v6.3.0.57 only (see RemotePath)

Property MessageSendAttemptRetries As Long

(EFT v6.3.0.57 only; Removed in EFT v6.3.1; See Retries Count.)

Retrieves or specifies the number of message send attempts retries.

HRESULT MessageSendAttemptRetries([out, retval] LONG* pVal);
HRESULT MessageSendAttemptRetries([in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 retries count is: " & CStr(oAS2O.MessageSendAttemptRetries)

Specifying:

oAS2O.MessageSendAttemptRetries = 80

EFT v6.3.0.57 only; Removed in EFT v6.3.1

Property MessageSendAttemptTimeout As Long

(EFT v6.3.0.57 only; Removed in EFT v6.3.1; See SendAttemptDelayBetweenRetries)

HRESULT MessageSendAttemptTimeout([out, retval] LONG* pVal);
HRESULT MessageSendAttemptTimeout([in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 Timeout is: " & CStr(oAS2O.MessageSendAttemptTimeout)

Specifying:

oAS2O.MessageSendAttemptTimeout = 10

EFT v6.3.0.57 only; Removed in EFT v6.3.1

Property MonitoredHotFolder As String

Specifies or retrieves the monitored hot folder path. Newly created/added files will be sent in the AS2 message.

HRESULT MonitoredHotFolder([out, retval] BSTR* pVal);
HRESULT MonitoredHotFolder([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 hot folder: " & oAS2O.MonitoredHotFolder

Specifying:

oAS2O.MonitoredHotFolder = "C:\HotFolder "

EFT v6.3 and later

Property PartnerAS2ID As String

Specifies or retrieves the AS2 ID of the AS2 partner to which you are sending an AS2 file.

HRESULT PartnerAS2ID([out, retval] BSTR* pVal);
HRESULT PartnerAS2ID([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "Her AS2 ID is: " & oAS2O.PartnerAS2ID

Specifying:

oAS2O.PartnerAS2ID = "her_as2_id"

EFT v6.3 and later

Property PartnerCertificatePath As String

Specifies or retrieves the path to the AS2 partner certificate for AS2 message encrypting.

HRESULT PartnerCertificate([out, retval] BSTR* pVal);
HRESULT PartnerCertificatePath([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 partner certificate path: " & CStr(oAS2O.PartnerCertificatePath)

Specifying:

oAS2O.PartnerCertificatePath = "C:\Certs\Ivan.crt"

EFT v6.3 and later

Property Password As String

Specifies or retrieves the password used for authentication on the AS2 Server to which you are sending an AS2 file.

HRESULT Password([out, retval] BSTR* pVal);
HRESULT Password([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 password: " & oAS2O.Password

Specifying:

oAS2O.Password = "swordfish"

EFT v6.3 and later

Property Port As Long

Specifies or retrieves the remote port.

HRESULT Port([out, retval] LONG* pVal);
HRESULT Port([in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 destination port: " & oAS2O.Port

Specifying:

oAS2O.ort = 80

EFT v6.3 and later

Property ProxyHostName As String

Specifies or retrieves the proxy host.

HRESULT ProxyHostName([out, retval] BSTR* pVal);
HRESULT ProxyHostName([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "Proxy hostname is: " & oAS2O.ProxyHostName

Specifying:

oAS2O.ProxyHostName = "192.168.0.89"

EFT v6.3 and later

Property ProxyPassword As String

Specifies or retrieves the proxy password.

HRESULT ProxyPassword([out, retval] BSTR* pVal);
HRESULT ProxyPassword([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "Proxy password is: " & oAS2O.ProxyPassword

Specifying:

oAS2O.ProxyPassword = "swordfish"

EFT v6.3 and later

Property ProxyPort As Long

Specifies or retrieves the proxy port.

HRESULT ProxyPort([out, retval] LONG* pVal);
HRESULT ProxyPort([in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "Proxy port is: " & CStr(oAS2O.ProxyPort)

Specifying:

oAS2O.ProxyPort = 8080

EFT v6.3 and later

Property ProxyType As AS2ProxyType

Specifies or retrieves the proxy type.

HRESULT ProxyType([out, retval] AS2ProxyType* pVal);
HRESULT ProxyType([in] AS2ProxyType newVal);

Example (VBScript):

Retrieving:

if AS2ProxyHTTP = oAS2O.ProxyType then
MsgBox "AS2 using HTTP proxy"
end if

Specifying:

oAS2O.ProxyType = AS2ProxyDMZ

EFT v6.3 and later

Property ProxyUserName As String

Specifies or retrieves the proxy username.

HRESULT ProxyUserName([out, retval] BSTR* pVal);
HRESULT ProxyUserName([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "Proxy user name is: " & oAS2O.ProxyUserName

Specifying:

oAS2O.ProxyUserName = "User_1"

EFT v6.3 and later

Property ReceiptDelivery As AS2ReceiptDelivery

Specifies or retrieves the mechanism of receipt delivery required for an AS2 message.

This property is applicable only if ReceiptPolicy property is not set to NoReceipt.

HRESULT ReceiptDelivery([out, retval] AS2ReceiptDelivery* pVal);
HRESULT ReceiptDelivery([in] AS2ReceiptDelivery newVal);

Example (VBScript):

Retrieving:

if Sync = oAS2O.ReceiptDelivery then
MsgBox "Synchronous"
end if

Specifying:

oAS2O.ReceiptDelivery = Async

EFT v6.3 and later

Property ReceiptPolicy As AS2ReceiptPolicy

Specifies or retrieves the type of the receipt required for an AS2 message.

HRESULT ReceiptPolicy([out, retval] AS2ReceiptPolicy* pVal);
HRESULT ReceiptPolicy([in] AS2ReceiptPolicy newVal);

Example (VBScript):

Retrieving:

if NoReceipt = oAS2O.ReceiptPolicy then
MsgBox "Do not request a receipt"
end if

Specifying:

oAS2O.ReceiptPolicy = UnsignedReceipt

EFT v6.3 and later

Property RemotePath As String

Retrieve/specify a destination directory path.

HRESULT RemotePath([out, retval] BSTR* pVal);
HRESULT RemotePath([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 destination path: " & oAS2O.RemotePath

Specifying:

oAS2O.RemotePath = "/"

EFT v6.3.1 and later

Property RetriesCount As Long

Specifies or retrieves the remote path to which you are sending an AS2 file.

HRESULT RetriesCount([out, retval] LONG* pVal);
HRESULT RetriesCount([in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 retries count is: " & CStr(oAS2O.RetriesCount)

Specifying:

oAS2O.RetriesCount = 80

EFT v6.3.1 and later

Property RetryDelaySec As Long

Specifies or retrieves the interval between successive sending retries (in seconds) when a send fails. This property is applicable only if RetriesCount property is not set to 0.

HRESULT RetryDelaySec([out, retval] LONG* pVal);
HRESULT RetryDelaySec([in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 delay between retries: " & CStr(oAS2O.RetryDelaySec)

Specifying:

oAS2O.RetryDelaySec = 60

EFT v6.3.1 and later

Property SendAttemptDelayBetweenRetries As Long

Retrieves or specifies the delay between retries, in seconds.

HRESULT SendAttemptDelayBetweenRetries([out, retval] LONG* pVal);
HRESULT SendAttemptDelayBetweenRetries([in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 delay between retries: " & CStr(oAS2O.SendAttemptDelayBetweenRetries)

Specifying:

oAS2O.SendAttemptDelayBetweenRetries = 60

EFT v6.3.0

Sub SetFailureCommand(pdispCommandParams As Object)

Specifies ICICommandActionParams interface, which specified a custom command to occur upon failed.

HRESULT SetFailureCommand(IDispatch* pdispCommandParams);

Example (VBScript):

oAS2O.SetFailureCommand oCmd

EFT v6.3 and later

Sub SetFailureEmail(pdispEmailParamsAs Object)

Specifies the ICIMailActionParams interface for e-mail notification parameters that will be sent after a failed transaction.

HRESULT SetFailureEmail(IDispatch* pdispEmailParams);

Example (VBScript):

oAS2O.SetFailureEmail oMailParams

EFT v6.3 and later

Sub SetSuccessCommand(pdispCommandParams As Object)

Specifies the ICICommandActionParams interface, which specified a custom command to occur upon successful transaction.

HRESULT SetSuccessCommand(IDispatch* pdispCommandParams);

Example (VBScript):

oAS2O.SetSuccessCommand oCmd

EFT v6.3 and later

Sub SetSuccessEmail(pdispEmailParams As Object)

Specifies the ICIMailActionParams interface for e-mail notification parameters that will be sent after a successful transaction.

HRESULT SetSuccessEmail(IDispatch* pdispEmailParams);

Example (VBScript):

oAS2O.SetSuccessEmail oMailParams

EFT v6.3 and later

Property Sign As Boolean

Specifies or retrieves whether an AS2 message will be signed with the certificate specified in the Site’s AS2 Settings.

HRESULT Sign([out, retval] VARIANT_BOOL* pVal);
HRESULT Sign([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 sign message: " & CStr(oAS2O.Sign)

Specifying:

oAS2O.Sign = True

EFT v6.3 and later

Property SignatureAlgorithm As AS2SignatureAlgorithm

Used to specify the signature algorithm for outbound AS2 transfers.

EFT v7.4.9 and later.

Property Subject As String

Specifies or retrieves the AS2 message subject.

HRESULT Subject([out, retval] BSTR* pVal);
HRESULT Subject([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 message subject: " & oAS2O.Subject

Specifying:

oAS2O.Subject = "Some subject "

EFT v6.3 and later

Property TimeoutSec As Long

Specifies or retrieves the timeout (in seconds) while sending a file.

HRESULT TimeoutSec([out, retval] LONG* pVal);
HRESULT TimeoutSec([in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 Timeout is: " & CStr(oAS2O.TimeoutSec)

Specifying:

oAS2O.TimeoutSec = 10

EFT v6.3.1 and later

Property UseProxy As Boolean

Specifies or retrieves whether the proxy will be used when sending a file.

HRESULT UseProxy([out, retval] VARIANT_BOOL* pVal);
HRESULT UseProxy([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 using proxy: " & CStr(oAS2O.UseProxy)

Specifying:

oAS2O.UseProxy = False

EFT v6.3 and later

Property User As String

Specifies or retrieves the username for authentication on the AS2 Server to which you are sending an AS2 file.

HRESULT User([out, retval] BSTR* pVal);
HRESULT Username([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 user: " & oAS2O.User

Specifying:

oAS2O.User = "User_1"

EFT v6.3.1 and later

Dialog Box Equivalents

Copyright © Fortra, LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.
8.1 | 202404030947 | April 2024