Class: CliApplication::MailLib::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/cli_application/mail_lib/base.rb

Overview

:nodoc:

Direct Known Subclasses

Error, Log, SMTP, Sendmail

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, folders) ⇒ Base

:nodoc:



9
10
11
12
 
# File 'lib/cli_application/mail_lib/base.rb', line 9

def initialize(config, folders) # :nodoc:
  @config = config
  @folders = folders
end

Instance Attribute Details

#config_fail_message ⇒ Object (readonly)

Returns the value of attribute config_fail_message.



7
8
9
 
# File 'lib/cli_application/mail_lib/base.rb', line 7

def config_fail_message
  @config_fail_message
end

#delivery_method ⇒ Object (readonly)

Returns the value of attribute delivery_method.



6
7
8
 
# File 'lib/cli_application/mail_lib/base.rb', line 6

def delivery_method
  @delivery_method
end

Instance Method Details

#address ⇒ String

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp

Returns:

  • (String) —

    пустая строка



45
46
47
 
# File 'lib/cli_application/mail_lib/base.rb', line 45

def address
  ''
end

#authentication ⇒ String

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp

Returns:

  • (String) —

    пустая строка



87
88
89
 
# File 'lib/cli_application/mail_lib/base.rb', line 87

def authentication
  ''
end

#domain ⇒ String

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp

Returns:

  • (String) —

    пустая строка



52
53
54
 
# File 'lib/cli_application/mail_lib/base.rb', line 52

def domain
  ''
end

#log_filename ⇒ String

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Log

Returns:

  • (String) —

    пустая строка



38
39
40
 
# File 'lib/cli_application/mail_lib/base.rb', line 38

def log_filename
  ''
end

#password ⇒ String

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp

Returns:

  • (String) —

    пустая строка



94
95
96
 
# File 'lib/cli_application/mail_lib/base.rb', line 94

def password
  ''
end

#port ⇒ String

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp

Returns:

  • (String) —

    пустая строка



59
60
61
 
# File 'lib/cli_application/mail_lib/base.rb', line 59

def port
  ''
end

#sendmail_arguments ⇒ String

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Sendmail

Returns:

  • (String) —

    пустая строка



108
109
110
 
# File 'lib/cli_application/mail_lib/base.rb', line 108

def sendmail_arguments
  ''
end

#sendmail_location ⇒ String

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Sendmail

Returns:

  • (String) —

    пустая строка



101
102
103
 
# File 'lib/cli_application/mail_lib/base.rb', line 101

def sendmail_location
  ''
end

#simple_send(to, name, title, body) ⇒ Boolean

Метод является заглушкой функции, которая должна быть переписана в дочерних классах ::Log, ::Error, ::Smpt, ::Sendmail

Parameters:

  • электронная (String) —

    почта лица, которому отправляется сообщение, или массив адресов

  • name (String) —

    имя клиента, которому отправляется сообщение

  • title (String) —

    заголовок письма

  • body (String) —

    текст письма

Returns:

  • (Boolean) —

    true, если письмо отправлено



30
31
32
33
 
# File 'lib/cli_application/mail_lib/base.rb', line 30

def simple_send(to, name, title, body)
  warn "Необходимо переопределить функцию отправки электронной почты (simple_send)"
  warn "Обратитесь к разработчику данного скрипта"
end

#smpt_log? ⇒ Boolean

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp

Returns:

  • (Boolean) —

    необходимость использовать SSL/TLS



80
81
82
 
# File 'lib/cli_application/mail_lib/base.rb', line 80

def smpt_log?
  false
end

#tls? ⇒ Boolean

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp

Returns:

  • (Boolean) —

    необходимость использовать SSL/TLS



73
74
75
 
# File 'lib/cli_application/mail_lib/base.rb', line 73

def tls?
  false
end

#user_name ⇒ String

Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp

Returns:

  • (String) —

    пустая строка



66
67
68
 
# File 'lib/cli_application/mail_lib/base.rb', line 66

def user_name
  ''
end

#valid? ⇒ Boolean

Метод возвращает true, если подсистема отсылки почтовых сообщений настроена корректна и готова к рассылке сообщений

Returns:

  • (Boolean) —

    true - если подсистема почта настроена корректно



18
19
20
 
# File 'lib/cli_application/mail_lib/base.rb', line 18

def valid?
  @is_valid
end