Class | EventMachine::Protocols::SmtpClient
In: | lib/protocols/smtpclient.rb
Parent: | Connection

### Methods

connection_completed invoke_auth invoke_data invoke_error invoke_internal_error invoke_mail_from invoke_rcpt_to invoke_starttls post_init receive_auth_response receive_data_response receive_ehlo_response receive_line receive_mail_from_response receive_message_response receive_rcpt_to_response receive_signon receive_starttls_response send unbind

### Included Modules

EventMachine::Deferrable EventMachine::Protocols::LineText2

### Attributes

args | [W] |

### Public Class methods

send(args={})

This is the external entry point.

The argument is a hash containing these values: :host => a string containing the IP address or host name of the SMTP server to connect to. :port => optional, defaults to 25. :domain => required String. This is passed as the argument to the EHLO command. :starttls => optional. If it evaluates true, then the client will initiate STARTTLS with

      the server, and abort the connection if the negotiation doesn't succeed.
      TODO, need to be able to pass certificate parameters with this option.

:auth => optional hash of auth parameters. If not given, then no auth will be attempted.

      (In that case, the connection will be aborted if the server requires auth.)
      Specify the hash value :type to determine the auth type, along with additional parameters
      depending on the type.
      Currently only :type => :plain is supported. Pass additional parameters :username (String),
      and :password (either a String or a Proc that will be called at auth-time).
      Example: :auth => {:type=>:plain, :username=>"mickey@disney.com", :password=>"mouse"}

:from => required String. Specifies the sender of the message. Will be passed as the argument

      to the MAIL FROM. Do NOT enclose the argument in angle-bracket (<>) characters.
      The connection will abort if the server rejects the value.

:to => required String or Array of Strings. The recipient(s) of the message. Do NOT enclose

      any of the values in angle-brackets (<>) characters. It's NOT a fatal error if one or more
      recipients are rejected by the server. (Of course, if ALL of them are, the server will most
      likely trigger an error when we try to send data.) An array of codes containing the status
      of each requested recipient is available after the call completes. TODO, we should define
      an overridable stub that will be called on rejection of a recipient or a sender, giving
      user code the chance to try again or abort the connection.

:header => Required hash of values to be transmitted in the header of the message. The hash

      keys are the names of the headers (do NOT append a trailing colon), and the values are strings
      containing the header values. TODO, support Arrays of header values, which would cause us to
      send that specific header line more than once.
      Example: :header => {"Subject" => "Bogus", "CC" => "myboss@example.com"}

:body => Optional string, defaults blank. This will be passed as the body of the email message.

      TODO, this needs to be significantly beefed up. As currently written, this requires the caller
      to properly format the input into CRLF-delimited lines of 7-bit characters in the standard
      SMTP transmission format. We need to be able to automatically convert binary data, and add
      correct line-breaks to text data. I think the :body parameter should remain as it is, and we
      should add a :content parameter that contains autoconversions and/or conversion parameters.
      Then we can check if either :body or :content is present and do the right thing.

:verbose => Optional. If true, will cause a lot of information (including the server-side of the

      conversation) to be dumped to $>.

### Public Instance methods

connection_completed()
invoke_auth()

Perform an authentication. If the caller didn‘t request one, then fall through to the mail-from state.

invoke_data()
invoke_error()

We encountered an error from the server and will close the connection. Use the error and message the server returned.

invoke_internal_error(msg = "???")

We encountered an error on our side of the protocol and will close the connection. Use an extra-protocol error code (900) and use the message from the caller.

invoke_mail_from()
invoke_rcpt_to()
invoke_starttls()
post_init()
receive_auth_response()
receive_data_response()
receive_ehlo_response()
receive_line(ln)
receive_mail_from_response()
receive_message_response()
receive_rcpt_to_response()
receive_signon()
receive_starttls_response()
unbind()

We can get here in a variety of ways, all of them being failures unless the @succeeded flag is set. If a protocol success was recorded, then don‘t set a deferred success because the caller will already have done it (no need to wait until the connection closes to invoke the callbacks).

[Validate]