Cách sử dụng MailHog để kiểm tra email cục bộ (Hướng dẫn từng bước)

Kiểm tra email trong môi trường phát triển cục bộ có thể là một thách thức. Thực sự rất khó để biết liệu các email gửi đi của trang web hoặc ứng dụng web của bạn có thực sự đến được hộp thư đến của người nhận hay không. Vào, MailHog!

MailHog là một công cụ kiểm tra email giúp cài đặt và cấu hình một máy chủ email cục bộ trở nên cực kỳ dễ dàng. MailHog thiết lập một máy chủ SMTP giả mạo. Bạn có thể định cấu hình các ứng dụng web ưa thích của mình để sử dụng máy chủ SMTP của MailHog để gửi và nhận email.

Ví dụ: bạn có thể định cấu hình một trang web WordPress cục bộ để sử dụng MailHog cho việc gửi email. Đó chính xác là những gì DevKinsta làm để cung cấp năng lượng cho máy chủ SMTP tích hợp của nó để kiểm tra email cục bộ.

Trong bài viết này, bạn sẽ tìm hiểu thông tin chi tiết về MailHog, bao gồm cài đặt, cấu hình, cách kiểm tra email cục bộ và hơn thế nữa!

Sẵn sàng tham gia? Đi nào!

Thích xem phiên bản video?

MailHog là gì?

MailHog là một công cụ kiểm tra email mã nguồn mở chủ yếu nhắm vào các nhà phát triển. Nó cho phép bạn kiểm tra khả năng gửi và nhận email của ứng dụng web một cách hiệu quả hơn.

Được xây dựng bằng ngôn ngữ lập trình Go, MailHog có thể chạy trên nhiều hệ điều hành, bao gồm Windows, Linux, FreeBSD và macOS. MailHog được duy trì bởi Ian Kent và được phát hành theo giấy phép MIT, vì vậy bạn có thể triển khai nó một cách tự do cho các mục đích sử dụng cá nhân và thương mại.

Nhưng tại sao bạn thậm chí cần MailHog ngay từ đầu?

Tại sao bạn cần MailHog

MailHog giải quyết nhiều vấn đề lớn của kiểm tra email.

Giả sử bạn đang phát triển một trang web WordPress trong một môi trường phát triển cục bộ. Nếu bạn muốn kiểm tra biểu mẫu liên hệ hoặc bất kỳ email gửi đi nào khác từ nó, đó có thể là một nhiệm vụ nghiêm trọng.

Thông thường, máy chủ SMTP mặc định của ứng dụng web sẽ đảm nhận nhiệm vụ này. Trong môi trường phát triển cục bộ, nó hầu như không bao giờ hoạt động do nhiều nguyên nhân.

Bạn có thể đọc hướng dẫn mở rộng của chúng tôi về máy chủ SMTP miễn phí để biết thêm về cách máy chủ SMTP hoạt động.

Trước tiên, bạn cần thiết lập hệ điều hành, máy chủ web và ứng dụng web để kích hoạt email trong môi trường cục bộ. Sau đó, bạn sẽ phải đảm bảo rằng các email đến thành công trong hộp thư đến của người nhận, điều này có thể làm lãng phí thời gian của bạn (và không gian hộp thư đến).

Và sau đó là vấn đề sử dụng địa chỉ email thực để thử nghiệm. Nó có thể làm ảnh hưởng đến uy tín của email riêng tư của bạn.

MailHog giải quyết tất cả các vấn đề trên. Nó thiết lập một máy chủ SMTP giả mà bạn có thể đặt ứng dụng web của mình để gửi và nhận email. Nó thậm chí còn lưu trữ các email đã gửi và đã nhận trong một giao diện người dùng web tiện lợi, vì vậy bạn có thể xem qua chúng giống như với một hộp thư email thực.

Cuối cùng, MaiilHog cũng cho phép bạn truy xuất những email đó bằng API để kiểm tra tự động. Đó là một tính năng mạnh mẽ và cách bạn sử dụng API là tùy thuộc vào bạn.

Các tính năng của MailHog

MailHog được trang bị nhiều tính năng vượt trội. Dưới đây là một số điểm nổi bật chính của nó:

• Nhẹ và di động: Bạn không cần cài đặt MailHog để sử dụng. Đó là một trong những lợi thế chính của MailHog. Điều đó làm cho nó có tính di động cao để chạy nó trên hầu hết mọi hệ điều hành hoặc máy chủ web.
• Hỗ trợ SMTP mở rộng: MailHog không chỉ hỗ trợ thiết lập máy chủ SMTP giả mạo mà bạn còn có thể sử dụng nó để thiết lập máy chủ ESMTP (Extended SMTP). Nó cũng bao gồm hỗ trợ cho SMTP AUTH và PIPELINING.
• Hỗ trợ API: Bạn có thể sử dụng API HTTP tích hợp của MailHog (hoặc API JSON) để truy xuất, liệt kê và xóa email.
• Kiểm tra thất bại: Bạn có thể mời Jim, Chaos Monkey của MailHog (vâng, nó thực sự được gọi như vậy), tham gia nhóm để kiểm tra khả năng gửi email của ứng dụng web của bạn. Nó thực hiện điều này bằng cách tạo ngẫu nhiên các vấn đề phổ biến về khả năng gửi email, chẳng hạn như các kết nối / xác thực bị từ chối và các kết nối giới hạn tốc độ.
• Cập nhật thời gian thực: MailHog sử dụng giao diện web EventSource để cung cấp các bản cập nhật tức thời.
• Thu thập và lưu trữ email: Các email đã chụp có thể được lưu trữ trong bộ nhớ thư trong bộ nhớ và vẫn tồn tại trong cơ sở dữ liệu MongoDB và hệ thống lưu trữ dựa trên tệp.
• Tải xuống Tệp đính kèm: MailHog hỗ trợ tải xuống các phần MIME riêng lẻ.
• Giao diện người dùng Web: Bạn có thể sử dụng Giao diện người dùng Web của MailHog để xem email dưới dạng văn bản thuần túy, HTML hoặc nguồn. Nó cũng hỗ trợ MIME nhiều phần và các tiêu đề được mã hóa.
• Xác thực: MailHog hỗ trợ xác thực cơ bản HTTP cho cả giao diện người dùng Web và API của nó.
• Phát hành các email đã chụp: Bạn có thể định cấu hình MailHog để giải phóng các email đã chụp tới các máy chủ SMTP thực để gửi.

Ngoài các tính năng trên, MailHog hiện có hai thư viện máy khách cho môi trường PHP và NodeJS để tương tác với API MailHog một cách dễ dàng.

Triển khai MailHog trên nhiều nền tảng khác nhau

Như đã đề cập trước đây, MailHog không cần phải được cài đặt. Tuy nhiên, bạn vẫn phải tải xuống và thiết lập nó trong môi trường phát triển của mình.

Hãy bắt đầu với việc tải xuống MailHog. Sau đó, chúng tôi sẽ chỉ cho bạn cách thiết lập nó trên các nền tảng khác nhau. Có nhiều cách bạn có thể thực hiện.

MailHog trên Windows

Đầu tiên, hãy truy cập trang phát hành MailHog trên GitHub để tải xuống phiên bản ổn định mới nhất dành cho Windows. Sau khi tải xuống MailHog, bạn có thể chạy nó như cũ mà không có bất kỳ phụ thuộc bên ngoài nào.

Lưu ý: Khi viết bài này, MailHog 1.0.1 là phiên bản phát hành mới nhất. Bạn có thể tải xuống nó được biên dịch sẵn cho các nền tảng Windows, Linux và Darwin (macOS). Nếu bạn đang sử dụng một nền tảng thích hợp, bạn cũng có thể tải xuống mã nguồn của nó và biên dịch nó cho trường hợp sử dụng cụ thể của bạn.

Vì MailHog dành cho Windows là một chương trình tự thực thi đơn giản, bạn có thể chỉ cần chạy tệp .exe tải xuống. Nếu bạn nhận được bất kỳ cảnh báo bảo mật nào, hãy đảm bảo cho phép MailHog chạy trên môi trường localhost của bạn mà không có giới hạn tường lửa.

Đây là giao diện của MailHog trên Windows 10.

Bạn có thể thấy rằng máy chủ SMTP nằm trên cổng 1025 và máy chủ HTTP trên cổng 8025 .

Không có gì quá lạ mắt, nhưng đó là một xác nhận rằng MailHog đang chạy trên hệ thống của bạn.

Bây giờ, bạn có thể truy cập localhost:8025 hoặc 127.0.0.1:8025 trong trình duyệt web của mình để xem giao diện người dùng Web MailHog.

Bạn không thể tìm thấy bất kỳ email nào được liệt kê ở đây, vì chúng tôi chưa định cấu hình bất kỳ ứng dụng web nào của mình để sử dụng MailHog. Chúng tôi sẽ đề cập đến vấn đề đó ở phần sau của bài viết này.

MailHog trên Linux

Nếu bạn đang sử dụng Linux (Ubuntu / Debian), đây là cách bạn có thể triển khai MailHog:

sudo apt-get -y install golang-go sudo apt-get install git go get github.com/mailhog/MailHog

Lệnh Linux đầu tiên cài đặt ngôn ngữ lập trình Golang trên môi trường phát triển của bạn (nếu bạn chưa có). Bạn có thể bỏ qua dòng này nếu bạn đã cài đặt Go. Lệnh tiếp theo cài đặt git trên máy của bạn (bạn cũng có thể bỏ qua lệnh này nếu nó đã được cài đặt).

Lệnh thứ ba sử dụng chỉ thị của Go để tải bản phát hành ổn định mới nhất của MailHog từ kho lưu trữ GitHub của nó.

Tiếp theo, bạn có thể chạy /path/to/MailHog thông qua thiết bị đầu cuối của mình để khởi động MailHog. Đường dẫn chính xác có thể khác nhau tùy thuộc vào hương vị Linux của bạn. Vì các tệp bin của Go trên Ubuntu được lưu trữ trong thư mục ~/go/bin/ , bạn có thể chạy mã dưới đây để khởi động MailHog:

~/go/bin/MailHog

Nó khá là nhiều. MailHog hiện đang chạy trên máy Linux của bạn. Cái này nó thì trông như thế nào.

Nếu bạn muốn tự động khởi động MailHog mỗi lần đăng nhập, bạn có thể đặt nó bắt đầu như một lần phục vụ daemon bằng cách sử dụng giám sát viên, người mới bắt đầu, v.v. Bạn cũng có thể sử dụng init script hoặc Ansible role do geerlingguy cung cấp để làm điều tương tự.

Cũng giống như với Windows, bạn có thể thấy rằng máy chủ SMTP bắt đầu trên cổng 1025 và máy chủ HTTP bắt đầu trên cổng 8025 .

Truy cập localhost:8025 hoặc 127.0.0.1:8025 trong trình duyệt web của bạn để xem giao diện người dùng Web MailHog.

MailHog trên macOS

Người dùng Apple có thể cài đặt MailHog bằng Homebrew. Mở thiết bị đầu cuối của bạn và chạy lệnh sau:

brew install mailhog

Điều đó sẽ cài đặt MailHog trên macOS của bạn. Tiếp theo, bạn có thể bắt đầu MailHog bằng:

mailhog

Nếu bạn muốn MailHog tự động khởi chạy khi đăng nhập và chạy dưới dạng dịch vụ nền, bạn có thể chạy lệnh sau để thay thế:

brew services start mailhog

Nó khá là nhiều. MailHog hiện đã được cài đặt trên macOS của bạn. Bạn có thể xem giao diện người dùng Web của nó bằng cách truy cập 127.0.0.1:8025 hoặc localhost:8025 trong trình duyệt của mình.

MailHog trên Docker

Docker là một trong những cách dễ nhất để thiết lập MailHog trên bất kỳ nền tảng nào.

Trước tiên, hãy đảm bảo rằng bạn đã cài đặt Docker trên máy của mình. Tiếp theo, bạn có thể khởi động MailHog trực tiếp từ Docker Hub bằng cách chạy lệnh sau:

docker run -d -p 1025:1025 -p 8025:8025 mailhog/mailhog

Hãy chia nhỏ lệnh trên và các lệnh của nó:

• docker run bắt đầu một vùng chứa docker.

• -d chỉ thị chạy bộ chứa docker trong nền.

• -p 1025:1025 và -p 8025:8025 hiển thị các cổng SMTP mặc định của MailHog với các cổng cục bộ của bạn.

• mailhog/mailhog lấy bản dựng MailHog mới nhất từ Docker Hub.

Ngoài ra, nếu bạn muốn gắn kết Maildir của MailHog vào hệ thống tệp cục bộ của mình (thay vì bên trong vùng chứa Docker), bạn có thể chạy lệnh sau:

docker run -d -e "MH_STORAGE=maildir" -v $PWD/maildir:/maildir -p 1025:1025 -p 8025:8025 mailhog/mailhog

Giống như trước đây, bạn có thể truy cập localhost:8025 hoặc 127.0.0.1:8025 trong trình duyệt của mình để sử dụng giao diện người dùng Web MailHog.

MailHog trên Docker Compose

Docker Compose là một phần mở rộng của Docker giúp dễ dàng chạy nhiều vùng chứa Docker bằng một lệnh duy nhất. Bạn thực hiện việc này bằng cách xác định tất cả các vùng chứa bạn muốn chạy trong tệp YAML.

Theo mặc định, Docker Compose yêu cầu bạn đặt tên tệp này là docker-compose.yaml .

Để chạy MailHog với Docker Compose, đây là cách tệp docker-compose.yaml -compost.yaml của bạn sẽ trông như thế nào:

version: "3" services: mailhog: image: mailhog/mailhog:latest restart: always ports: - 1025:1025 - 8025:8025

Bên trong thư mục chứa tệp này, hãy chạy lệnh sau để khởi động MailHog ở chế độ nền:

docker-compose up -d mailhog

Nó hoạt động giống hệt như với Docker. Ngoại trừ ở đây, bạn không cần phải đề cập đến nhiều chỉ thị vì bạn đã xác định chúng rồi.

Bây giờ bạn có thể nhập localhost:8025 hoặc 127.0.0.1:8025 vào trình duyệt của mình để xem giao diện người dùng Web MailHog.

Ngoài các phương pháp trên, repo GitHub của MailHog cũng bao gồm hướng dẫn triển khai MailHog trên AWS Elastic Beanstalk.

Định cấu hình MailHog với mhsendmail

MailHog chuyển hướng email từ các ứng dụng web đến máy chủ SMTP của nó bằng cách sử dụng mhsendmail, một ứng dụng thay thế sendmail được tạo riêng cho MailHog. Nó đảm bảo rằng các email trong ứng dụng web của bạn được gửi và nhận bằng máy chủ SMTP localhost:1025 , máy chủ mà MailHog được định cấu hình để xử lý theo mặc định.

Để bắt đầu, bạn cần tải xuống và cài đặt mhsendmail . Tùy thuộc vào nền tảng của bạn, bạn có thể tiếp cận điều này theo nhiều cách khác nhau.

Ví dụ: nếu bạn đang sử dụng Ubuntu, bạn có thể tải xuống mhsendmail từ kho lưu trữ GitHub của nó bằng cách sử dụng lệnh sau:

wget https://github.com/mailhog/mhsendmail/releases/download/v0.2.0/mhsendmail_linux_amd64

Tiếp theo, làm cho tệp này có thể thực thi và di chuyển nó vào thư mục người dùng của bạn. Để thực hiện việc này, hãy sử dụng lệnh sau:

sudo chmod +x mhsendmail_linux_amd64 sudo mv mhsendmail_linux_amd64 /usr/local/bin/mhsendmail

Ngoài ra, bạn cũng có thể mhsendmail trên Golang hoặc Homebrew bằng cách chạy lệnh sau:

go get github.com/mailhog/mhsendmail

Đảm bảo rằng Go đã được cài đặt trước khi bạn chạy lệnh trên. Nếu bạn đang sử dụng Linux, hãy tham khảo phần MailHog trên Linux ở trên. Để cài đặt Go với Homebrew, hãy chạy lệnh sau:

brew install go

Với mhsendmail tải xuống, bây giờ bạn có thể tiến hành cài đặt nó:

go get github.com/mailhog/mhsendmail

Tiếp theo, bạn cần định cấu hình ứng dụng web của mình để sử dụng mhsendmail của mhsendmail làm dịch vụ định tuyến email. Hầu hết các hệ thống Linux đều đặt nó để sử dụng sendmail theo mặc định.

Bạn có thể thực hiện việc này bằng cách chỉnh sửa tệp php.ini của mình. Trên hầu hết các máy chủ, bạn có thể tìm thấy tệp php.ini trong thư mục gốc. Bạn cũng có thể thực hiện lệnh sau để tìm vị trí của nó:

php -i | grep 'php.ini'

Đối với máy Linux chạy Ubuntu, bạn cần đặt giá trị của sendmail_path thành:

sendmail_path = /usr/local/bin/mhsendmail

Thay vì giá trị trên, bạn cũng có thể sử dụng giá trị được hiển thị bên dưới để nhận được kết quả tương tự:

sendmail_path = /usr/sbin/sendmail -S mail:1025

Nếu bạn đã sử dụng Đi để cài đặt mhsendmail hoặc nếu bạn đang sử dụng bất kỳ biến thể nào khác của Linux, đường dẫn có thể khác một chút tùy thuộc vào nền tảng / cấu hình của bạn. Đảm bảo liên kết đến thư mhsendmail thích hợp.

Người dùng Mac cần chỉnh sửa tệp cấu hình Postfix của họ để thiết lập MailHog đúng cách. Bạn có thể sử dụng cấu hình Postfix sau:

myhostname = localhost relayhost = [127.0.0.1]:1025

Đối với các trang web WordPress, bạn có thể sử dụng plugin MailHog dành cho WordPress miễn phí để định tuyến các email trên trang web của bạn đến MailHog. Để sử dụng nó, hãy cài đặt và kích hoạt plugin trong bảng điều khiển quản trị WordPress của bạn. Một giải pháp thay thế tốt hơn là sử dụng DevKinsta. Chúng tôi sẽ đề cập sâu hơn về nó sau.

Đọc tài liệu MailHog để biết thông tin về cách thiết lập nó trên nhiều nền tảng / cấu hình khác.

Tùy chọn cấu hình MailHog bổ sung

Bạn có thể định cấu hình MailHog bằng cách sử dụng các biến môi trường khác nhau hoặc các tùy chọn dòng lệnh của nó.

Ví dụ: bạn có thể thay đổi tên máy chủ mặc định từ mailhog.example thành tên tùy chỉnh bằng cách sử dụng biến môi trường MH_HOSTNAME hoặc tùy chọn dòng lệnh -hostname .

Để biết thêm thông tin, bạn có thể xem tài liệu tùy chọn cấu hình MailHog.

Kiểm tra email cục bộ với MailHog

Cuối cùng, hãy kiểm tra thiết lập MailHog của chúng tôi để xem liệu nó có được định cấu hình đúng cách hay không.

Bạn có thể gửi email với CLI của Mailhog bằng cách sử dụng các mhsendmail sau:

mhsendmail [email protected] <<EOF From: Salman <[email protected]> To: Test <[email protected]> Subject: Hello, MailHog! Hey there, Missing you pig time. Hogs & Kisses, Salman EOF

Trong đoạn mã trên, lệnh <<EOF đặt dấu phân cách tùy chỉnh để bạn có thể nhập chi tiết email thử nghiệm một cách tương tác bên trong thiết bị đầu cuối. Nó thực thi tất cả đầu vào khi bạn nhập lại dấu phân cách. Tại đây, nó sẽ gửi một thư bằng lệnh mhsendmail .

Bạn có thể xác minh xem email đã được gửi thành công hay chưa bằng cách truy cập vào Giao diện người dùng Web MailHog.

Bạn cũng có thể nhấp vào email thử nghiệm để xác minh nội dung cơ thể của nó.

Đó là một bọc! Bây giờ chúng ta có thể kết luận rằng MailHog đã được cấu hình thành công.

Ngoài phương pháp trên, bạn có thể gửi email thử nghiệm theo các cách khác. Ví dụ: trên macOS, bạn có thể gửi email thử nghiệm bằng cách chạy lệnh sau trong thiết bị đầu cuối của mình:

date | mail -s "Hello, MailHog!" [email protected]

Trên Windows, bạn có thể gửi email bằng PowerShell bằng cách thực thi mã sau:

Send-MailMessage -To "[email protected]" -From "[email protected]" -Subject "Hello, MailHog!" -SmtpServer "localhost" -Port 1025

Bạn cũng có thể xác định một tập lệnh PHP với tất cả dữ liệu thư và sử dụng hàm mail() của PHP để gửi một email thử nghiệm. Để làm điều đó, hãy xác định tập lệnh PHP của bạn như bên dưới và thực thi nó từ terminal:

<?php $to = "[email protected]"; $subject = "Hey, I'm Pi Hog Pi!"; $body = "Hello, MailHog!"; $headers = "From: [email protected]" . "rn"; mail($to,$subject,$body,$headers); ?>

Cuối cùng, bạn có thể sử dụng API MailHog để kiểm tra xem email đã được gửi thành công hay chưa. Nếu bạn đang làm việc độc quyền trong môi trường không phải GUI (ví dụ: thiết bị đầu cuối Linux, Windows PowerShell), API MailHog siêu tiện dụng để liệt kê, truy xuất và xóa email.

DevKinsta và MailHog: Kiểm tra email cục bộ nhanh chóng

Công cụ phát triển WordPress cục bộ của chúng tôi, DevKinsta, sử dụng MailHog để tăng cường các tính năng kiểm tra email của nó. Vì nó cũng Docker để chứa các trang web riêng lẻ, bạn sẽ có một hộp thư đến MailHog riêng cho mọi trang web cục bộ mà bạn đang phát triển.

Giống như giao diện người dùng Web MailHog, bạn có thể sử dụng hộp thư đến email cục bộ của DevKinsta để xem và thao tác với email (xóa, đánh dấu là đã đọc, xem nguồn).

Bạn cũng có thể kiểm tra nhật ký MailHog của DevKinsta bằng cách chạy lệnh Docker sau:

docker logs -f devkinsta_mailhog

Đi đến phần cơ sở kiến thức của DevKinsta để biết thêm thông tin.

Bản tóm tắt

MailHog giúp việc kiểm tra email trở nên dễ dàng. Đó là một giải pháp thực tế, tuyệt vời để kiểm tra email của trang web hoặc ứng dụng web của bạn. Hơn nữa, MailHog rất đơn giản để thiết lập trên hầu hết các nền tảng phổ biến và có giao diện người dùng Web dễ sử dụng.

Giống như MailHog, DevKinsta là một cách tuyệt vời để bắt đầu phát triển WordPress cục bộ. Nó không chỉ bao gồm MailHog để kiểm tra email cục bộ mà còn được cài đặt sẵn Adminer để quản lý cơ sở dữ liệu dễ dàng.

Với MailHog (và DevKinsta) đứng về phía bạn, bạn sẽ thấy rằng việc kiểm tra email cục bộ chưa bao giờ dễ dàng hơn thế.

Nếu bạn muốn chia sẻ kinh nghiệm hoặc thách thức của mình với việc kiểm tra email cục bộ, vui lòng gửi cho chúng tôi một dòng trong phần bình luận bên dưới.