Class: Net::SMTP::Response
- Inherits:
-
Object
- Object
- Net::SMTP::Response
- Defined in:
- lib/net/smtp.rb
Overview
This class represents a response received by the SMTP server. Instances of this class are created by the SMTP class; they should not be directly created by the user. For more information on SMTP responses, view Section 4.2 of RFC 5321
Instance Attribute Summary collapse
-
#status ⇒ Object
readonly
The three digit reply code of the SMTP response.
-
#string ⇒ Object
readonly
The human readable reply text of the SMTP response.
Class Method Summary collapse
-
.parse(str) ⇒ Object
Parses the received response and separates the reply code and the human readable reply text.
Instance Method Summary collapse
-
#capabilities ⇒ Object
Returns a hash of the human readable reply text in the response if it is multiple lines.
-
#continue? ⇒ Boolean
Determines whether the response received was a Positive Intermediate reply (3xx reply code).
-
#cram_md5_challenge ⇒ Object
Creates a CRAM-MD5 challenge.
-
#exception_class ⇒ Object
Determines whether there was an error and raises the appropriate error based on the reply code of the response.
-
#initialize(status, string) ⇒ Response
constructor
Creates a new instance of the Response class and sets the status and string attributes.
-
#message ⇒ Object
The first line of the human readable reply text.
-
#status_type_char ⇒ Object
Takes the first digit of the reply code to determine the status type.
-
#success? ⇒ Boolean
Determines whether the response received was a Positive Completion reply (2xx reply code).
Constructor Details
#initialize(status, string) ⇒ Response
Creates a new instance of the Response class and sets the status and string attributes
998 999 1000 1001 |
# File 'lib/net/smtp.rb', line 998 def initialize(status, string) @status = status @string = string end |
Instance Attribute Details
#status ⇒ Object (readonly)
The three digit reply code of the SMTP response
1004 1005 1006 |
# File 'lib/net/smtp.rb', line 1004 def status @status end |
#string ⇒ Object (readonly)
The human readable reply text of the SMTP response
1007 1008 1009 |
# File 'lib/net/smtp.rb', line 1007 def string @string end |
Class Method Details
.parse(str) ⇒ Object
Parses the received response and separates the reply code and the human readable reply text
992 993 994 |
# File 'lib/net/smtp.rb', line 992 def self.parse(str) new(str[0,3], str) end |
Instance Method Details
#capabilities ⇒ Object
Returns a hash of the human readable reply text in the response if it is multiple lines. It does not return the first line. The key of the hash is the first word the value of the hash is an array with each word thereafter being a value in the array
1041 1042 1043 1044 1045 1046 1047 1048 1049 |
# File 'lib/net/smtp.rb', line 1041 def capabilities return {} unless @string[3, 1] == '-' h = {} @string.lines.drop(1).each do |line| k, *v = line[4..-1].chomp.split h[k] = v end h end |
#continue? ⇒ Boolean
Determines whether the response received was a Positive Intermediate reply (3xx reply code)
1022 1023 1024 |
# File 'lib/net/smtp.rb', line 1022 def continue? status_type_char() == '3' end |
#cram_md5_challenge ⇒ Object
Creates a CRAM-MD5 challenge. You can view more information on CRAM-MD5 on Wikipedia: en.wikipedia.org/wiki/CRAM-MD5
1033 1034 1035 |
# File 'lib/net/smtp.rb', line 1033 def cram_md5_challenge @string.split(/ /)[1].unpack1('m') end |
#exception_class ⇒ Object
Determines whether there was an error and raises the appropriate error based on the reply code of the response
1053 1054 1055 1056 1057 1058 1059 1060 1061 |
# File 'lib/net/smtp.rb', line 1053 def exception_class case @status when /\A4/ then SMTPServerBusy when /\A50/ then SMTPSyntaxError when /\A53/ then SMTPAuthenticationError when /\A5/ then SMTPFatalError else SMTPUnknownError end end |
#message ⇒ Object
The first line of the human readable reply text
1027 1028 1029 |
# File 'lib/net/smtp.rb', line 1027 def @string.lines.first end |
#status_type_char ⇒ Object
Takes the first digit of the reply code to determine the status type
1010 1011 1012 |
# File 'lib/net/smtp.rb', line 1010 def status_type_char @status[0, 1] end |
#success? ⇒ Boolean
Determines whether the response received was a Positive Completion reply (2xx reply code)
1016 1017 1018 |
# File 'lib/net/smtp.rb', line 1016 def success? status_type_char() == '2' end |