A standalone Ruby client for the Purelymail API.
Add this to your Gemfile:
gem "purelymail"Then run bundle install.
Or install it yourself:
gem install purelymailclient = Purelymail::Client.new(api_token: "pm-live-xxxxxxxx")
client.create_domain(name: "example.com")Purelymail.configure do |config|
config.api_token = "pm-live-xxxxxxxx"
end
client = Purelymail::Client.new
client.create_user(name: "alice", domain: "example.com", password: "s3cret")You can mix both: pass an api_token to Client.new to override the global config for that instance.
client = Purelymail::Client.new(api_token: "pm-live-xxxxxxxx")
client.create_domain(name: "example.com")
client.create_user(name: "alice", domain: "example.com", password: "s3cret")
client.change_password(name: "alice", domain: "example.com", password: "newpass")
client.create_routing_rule(
domain_name: "example.com",
match_user: "alice",
target_addresses: ["alice@destination.com"],
prefix: false,
catchall: false
)
client.configured?
# => trueAll API errors raise Purelymail::ApiError:
begin
client.create_domain(name: "invalid@domain")
rescue Purelymail::ApiError => e
puts e.message # => "[Purelymail] addDomain failed: ..."
puts e.status # => 400
puts e.response # => {"type" => "error", "message" => "..."}
endAdd the gem to your Gemfile:
gem "purelymail"Configure via Rails credentials:
bin/rails credentials:editAdd:
purelymail:
api_token: pm-live-xxxxxxxxThe gem automatically picks up Rails.application.credentials.dig(:purelymail, :api_token) as a fallback, so you can use the client without any explicit configuration:
# config/initializers/purelymail.rb
Purelymail.configure do |config|
# config.api_token is optional here —
# it will fall back to Rails.application.credentials.purelymail.api_token
endThen anywhere in your app:
Purelymail::Client.new.create_domain(name: "example.com")If you need to override the token at the call site, pass it directly:
Purelymail::Client.new(api_token: "pm-live-yyyyyyyy")After checking out the repo, run:
bundle install
bundle exec rspecThe gem is available as open source under the terms of the MIT License.