Methods and Properties of BackupSet.Email Interface

• Enable - property, e-mail notification: on (true), off (false).

  Syntax:

  Object.Email.Enable

  {property[in, out] BOOL}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.Enable = true 'e-mail notification is on
• NotifyOnErrorOnly - property, to notify only about errors – on (true), off (false).

  Syntax:

  Object.Email.NotifyOnErrorOnly

  {property[in, out] BOOL}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.NotifyOnErrorOnly = true 'notify about errors only
• AttachLogFile - property, including the log file in the e-mail notification: log file is attached (true), no log (false).

  Syntax:

  Object.Email.AttachLogFile

  {property[in, out] BOOL}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.AttachLogFile = true 'attach log file to e-mail
• SMTPServerAddress - property, SMTP server address.

  Syntax:

  Object.Email.SMTPServerAddress

  {property[in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.SMTPServerAddress = "example.com" 'SMTP server address is “example.com”
• SMTPServerPort - property, SMTP server port.

  Syntax:

  Object.Email.SMTPServerPort

  {property[in, out] LONG}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.SMTPServerPort = 25 'use port 25
• SMTPServerUseSSL - property, using SSL Smtp connection: yes (true), no (false).

  Syntax:

  Object.Email.SMTPServerUseSSL

  {property[in, out] BOOL}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.SMTPServerUseSSL = true 'use SSL Smtp connection
• From - property, e-mail to notification sending.

  Syntax:

  Object.Email.From

  {property[in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.From = "leobackup@example.com" 'receive notification from leobackup@example.com
• To - property, e-mail of receiver.

  Syntax:

  Object.Email.To

  {property[in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.To = "to@example.com" 'receive notification on "to@example.com" address
• Subject - property, notification subject.

  Syntax:

  Object.Email.Subject

  {property[in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.Subject = "Example Subject" 'notification subject is "Example Subject"
• SMTPUserName - property, login of SMTP server user (if SMTP server doesn’t require the authentication).

  Syntax:

  Object.Email.SMTPUserName

  {property[in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.SMTPUserName = "ExampleLogin" 'apply "ExampleLogin" as a login of SMTP server user
• SMTPUserPassword - property, password of SMTP server user (if SMTP server doesn’t require the authentication).

  Syntax:

  Object.Email.SMTPUserPassword

  {property[in] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Email.SMTPUserPassword = "ExamplePassword" 'apply "ExamplePasswor" as a password of SMTP server user