ICIMailActionParams Interface

You can create an e-mail notification action for Event Rule and AS2 Transaction success and failure notifications.

NOTE: On Sites using AD authentication, EFT must have "Log On as a domain user" permission in order for e-mail notifications to work.

The ICIMailActionParams interface allows you to make changes to the MailAction settings. Access the ICIMailActionParams interface with ICIEventAction when its EventActionType property returns MailAction.

interface ICIMailActionParams : IDispatch

Example:

If action.Type = 2 then 'MailAction
Set mailParams = action.Params
EndIf

VB script example:

'Add Mail action to the conditional statement's IF section
Set IfEventActionParams = CreateObject("SFTPCOMInterface.CIBackupActionParams")
IfEventActionParams.TOAddresses = foobar@com;"
IfEventActionParams.Subject = "Subj"
IfEventActionParams.Template = "<b>text</b>"
Set pMailAction = pIfStatement.IfSection.Add(0, MailAction, IfEventActionParams)

Properties

  • Property Attach As String

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

    EFT v7.4.6 and later

  • Property BCCAddresses As String

    • Retrieves or specifies BCC addresses.

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

    Example (VBScript):

    mailParams.BCCAddresses = "rob@globalscape.com;foo@bar.com;"

    EFT v5.2 and later

  • Property Body As String

    • For an example using this property, refer to the EventRuleCreation script in Script Examples.

    Retrieves or specifies the body of the message.

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

    Example (VBScript):

    mailParams.Body = "<HTML>This message was sent to you automatically by the GlobalSCAPE EFT</HTML>"

    Example (C#):

    mail.Body = "Test email";

    EFT v5.2 and later

  • Property CCAddresses As String

    • Retrieves or specifies CC addresses.

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

    Example (VBScript):

    mailParams.CCAddresses = "rob@globalscape.com;foo@bar.com;"

    EFT v5.2 and later

  • Property CopyToClient As Boolean

    • Retrieves or specifies whether to send a copy to the sender.

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

    Example (VBScript):

    mailParams. CopyToClient = True

    EFT v5.2 and later

  • Property CustomFromAddress As String

    • Retrieves or specifies custom a FROM address. (See UseCustomFromAddress below.)

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

    Example (VBScript):

    Retrieving:

    FROMAddr = Server.SMTPSenderAddr 'default
If MailParams.UseCustomFromAddress Then
FROMAddr = MailParams.CustomFromAddress
End If

    Specifying:

    MailParams.UseCustomFromAddress = True
MailParams.CustomFromAddress = "custom_email@smtpserver.org"

    EFT v6.1 and later

  • Property Subject As String

    • For an example using this property, refer to the EventRuleCreation script in Script Examples.

    Retrieves or specifies the subject line of the message.

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

    Example (VBScript):

    mailParams.Subject = "Important! Need to talk"

    Example (C#):

    mail.Subject = "Test";

    EFT v5.2 and later

  • Property TOAddresses As String

    • For an example using this property, refer to the EventRuleCreation script in Script Examples.

    Retrieves or specifies the TO addresses.

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

    Example (VBScript):

    mailParams.TOAddresses = "rob@globalscape.com;foo@bar.com;"

    Example (C#):

    mail.TOAddresses = "youremail@yourdomain.com";

    EFT v5.2 and later

  • Property UseCustomFromAddress As Boolean

    • Retrieves or specifies whether to use a custom FROM address. (See CustomFromAddress above.)

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

    Example (VBScript):

    Retrieving:

    FROMAddr = Server.SMTPSenderAddr 'default
If MailParams.UseCustomFromAddress Then
FROMAddr = MailParams.CustomFromAddress
End If

    Specifying:

    MailParams.UseCustomFromAddress = False

    EFT v6.1 and later

  • Property WaitUntilCompletes As Boolean

    • Specify whether the Event Rule should wait for this action to complete.

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

    EFT v8.0.5